loic/ochess
1
0
Fork 0
mirror of https://gitlab.com/manzerbredes/ochess.git synced 2025-04-05 17:46:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation

Browse source
This commit is contained in:
Loic Guegan 2023-06-04 13:51:23 +02:00
parent cffa5f1186
commit 6c7f492e5a
7 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/base_tab/BaseTab.hpp
View file

@ -15,7 +15,7 @@ wxDECLARE_EVENT(REFRESH_MANAGE_TAB, wxCommandEvent);
/** /**
* @brief Class that represents an opened chess games database in the MainWindow * @brief Class that represents an opened chess games database in the MainWindow
* * @ingroup tabs
*/ */
class BaseTab : public TabBase, public TabInfos { class BaseTab : public TabBase, public TabInfos {
/// @brief The opened database /// @brief The opened database

2
src/engine_tab/EngineTab.hpp
View file

@ -8,7 +8,7 @@ wxDECLARE_EVENT(REFRESH_TAB_TITLE, wxCommandEvent);
/** /**
* @brief Tab used to configure UCI chess engines * @brief Tab used to configure UCI chess engines
* * @ingroup tabs
*/ */
class EngineTab : public TabEngine, public TabInfos { class EngineTab : public TabEngine, public TabInfos {
std::string confGroup, enginePath; std::string confGroup, enginePath;

4
src/game_tab/Game.hpp
View file

@ -6,8 +6,8 @@
#include <unordered_map> #include <unordered_map>
/** /**
* @brief Hold an entire chess game * @brief Hold an entire chess game. Used in many places in the projects.
* Used in many places in the projects. * @ingroup game
*/ */
class Game { class Game {
/// @brief 64 char string that contains all the pieces on the board (used in BoardCanvas) /// @brief 64 char string that contains all the pieces on the board (used in BoardCanvas)

2
src/game_tab/GameTab.hpp
View file

@ -17,7 +17,7 @@ wxDECLARE_EVENT(SHOW_ENGINE_EVALUATION, wxCommandEvent);
/** /**
* @brief Main tab for opened games. Contains GameTabLeftPanel and GameTabRightPanel. * @brief Main tab for opened games. Contains GameTabLeftPanel and GameTabRightPanel.
* * @ingroup tabs
*/ */
class GameTab : public wxPanel, public TabInfos { class GameTab : public wxPanel, public TabInfos {
GameTabRightPanel *editor_panel; GameTabRightPanel *editor_panel;

1
src/game_tab/HalfMove.hpp
View file

@ -8,6 +8,7 @@
/** /**
* @brief This class extends CGEHalfMove (to be displayed in the game editor) * @brief This class extends CGEHalfMove (to be displayed in the game editor)
* @ingroup game
*/ */
class HalfMove : public CMI::HalfMove { class HalfMove : public CMI::HalfMove {
std::string fen; std::string fen;

8
tools/doxygen/Groups.md
View file

@ -2,4 +2,10 @@
@brief How to access to the embbeded binary data @brief How to access to the embbeded binary data
@details Binary resources are generated into the binary_data.hpp file using @details Binary resources are generated into the binary_data.hpp file using
the `tools/embbeded.sh` script. Here are the various functions used the `tools/embbeded.sh` script. Here are the various functions used
to access to them. to access to them.
@defgroup game Chess game model
@brief Classes used to model a chess game
@defgroup tabs UI tabs
@brief All classes that implement a tab visible in the main window

2
tools/doxygen/layout.xml
View file

@ -4,7 +4,7 @@
<navindex> <navindex>
<tab type="mainpage" visible="yes" title=""/> <tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="yes" title="" intro=""/> <tab type="pages" visible="yes" title="" intro=""/>
<tab type="modules" visible="yes" title="Categories" intro=""/> <tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title=""> <tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/> <tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/> <tab type="namespacemembers" visible="yes" title="" intro=""/>