From 6c7f492e5a2adb45b4757a8062a4f4242b1c3e14 Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Sun, 4 Jun 2023 13:51:23 +0200 Subject: Improve documentation --- src/game_tab/Game.hpp | 4 ++-- src/game_tab/GameTab.hpp | 2 +- src/game_tab/HalfMove.hpp | 1 + 3 files changed, 4 insertions(+), 3 deletions(-) (limited to 'src/game_tab') diff --git a/src/game_tab/Game.hpp b/src/game_tab/Game.hpp index 94f49fc..e5742bc 100644 --- a/src/game_tab/Game.hpp +++ b/src/game_tab/Game.hpp @@ -6,8 +6,8 @@ #include /** - * @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) diff --git a/src/game_tab/GameTab.hpp b/src/game_tab/GameTab.hpp index 9986905..28e9d27 100644 --- a/src/game_tab/GameTab.hpp +++ b/src/game_tab/GameTab.hpp @@ -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; diff --git a/src/game_tab/HalfMove.hpp b/src/game_tab/HalfMove.hpp index 36b9888..fa9b5a5 100644 --- a/src/game_tab/HalfMove.hpp +++ b/src/game_tab/HalfMove.hpp @@ -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; -- cgit v1.2.3