mirror of
https://gitlab.com/manzerbredes/ochess.git
synced 2025-07-01 09:47:39 +00:00
Improve documentation
This commit is contained in:
parent
cffa5f1186
commit
6c7f492e5a
7 changed files with 14 additions and 7 deletions
|
@ -15,7 +15,7 @@ wxDECLARE_EVENT(REFRESH_MANAGE_TAB, wxCommandEvent);
|
|||
|
||||
/**
|
||||
* @brief Class that represents an opened chess games database in the MainWindow
|
||||
*
|
||||
* @ingroup tabs
|
||||
*/
|
||||
class BaseTab : public TabBase, public TabInfos {
|
||||
/// @brief The opened database
|
||||
|
|
|
@ -8,7 +8,7 @@ wxDECLARE_EVENT(REFRESH_TAB_TITLE, wxCommandEvent);
|
|||
|
||||
/**
|
||||
* @brief Tab used to configure UCI chess engines
|
||||
*
|
||||
* @ingroup tabs
|
||||
*/
|
||||
class EngineTab : public TabEngine, public TabInfos {
|
||||
std::string confGroup, enginePath;
|
||||
|
|
|
@ -6,8 +6,8 @@
|
|||
#include <unordered_map>
|
||||
|
||||
/**
|
||||
* @brief Hold an entire chess game
|
||||
* Used in many places in the projects.
|
||||
* @brief Hold an entire chess game. Used in many places in the projects.
|
||||
* @ingroup game
|
||||
*/
|
||||
class Game {
|
||||
/// @brief 64 char string that contains all the pieces on the board (used in BoardCanvas)
|
||||
|
|
|
@ -17,7 +17,7 @@ wxDECLARE_EVENT(SHOW_ENGINE_EVALUATION, wxCommandEvent);
|
|||
|
||||
/**
|
||||
* @brief Main tab for opened games. Contains GameTabLeftPanel and GameTabRightPanel.
|
||||
*
|
||||
* @ingroup tabs
|
||||
*/
|
||||
class GameTab : public wxPanel, public TabInfos {
|
||||
GameTabRightPanel *editor_panel;
|
||||
|
|
|
@ -8,6 +8,7 @@
|
|||
|
||||
/**
|
||||
* @brief This class extends CGEHalfMove (to be displayed in the game editor)
|
||||
* @ingroup game
|
||||
*/
|
||||
class HalfMove : public CMI::HalfMove {
|
||||
std::string fen;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue