[Documentation] Sort *every* file into a doxygen group. (#6198)

* Sort *every* file into a doxygen group.

Took 7 hours 9 minutes

Took 18 seconds

Took 2 minutes

* Lint some ingroup definitions.

Took 10 minutes


Took 2 seconds

* Just include the groups in the Doxyfile in this commit.

Took 3 minutes

* Update some group comments so they link!

Took 14 minutes

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>

cockatrice/src/game/abstract_game.h

@@ -1,3 +1,9 @@
+/**
+ * @file abstract_game.h
+ * @ingroup GameLogic
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_ABSTRACT_GAME_H
 #define COCKATRICE_ABSTRACT_GAME_H
 

cockatrice/src/game/board/abstract_card_drag_item.h

@@ -1,3 +1,9 @@
+/**
+ * @file abstract_card_drag_item.h
+ * @ingroup GameGraphicsCards
+ * @brief TODO: Document this.
+ */
+
 #ifndef ABSTRACTCARDDRAGITEM_H
 #define ABSTRACTCARDDRAGITEM_H
 

cockatrice/src/game/board/abstract_card_item.h

@@ -1,3 +1,9 @@
+/**
+ * @file abstract_card_item.h
+ * @ingroup GameGraphicsCards
+ * @brief TODO: Document this.
+ */
+
 #ifndef ABSTRACTCARDITEM_H
 #define ABSTRACTCARDITEM_H
 

cockatrice/src/game/board/abstract_counter.h

@@ -1,3 +1,9 @@
+/**
+ * @file abstract_counter.h
+ * @ingroup GameGraphicsPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COUNTER_H
 #define COUNTER_H
 

cockatrice/src/game/board/abstract_graphics_item.h

@@ -1,3 +1,9 @@
+/**
+ * @file abstract_graphics_item.h
+ * @ingroup GameGraphics
+ * @brief TODO: Document this.
+ */
+
 #ifndef ABSTRACTGRAPHICSITEM_H
 #define ABSTRACTGRAPHICSITEM_H
 

cockatrice/src/game/board/arrow_item.h

@@ -1,3 +1,9 @@
+/**
+ * @file arrow_item.h
+ * @ingroup GameGraphics
+ * @brief TODO: Document this.
+ */
+
 #ifndef ARROWITEM_H
 #define ARROWITEM_H
 

cockatrice/src/game/board/arrow_target.h

@@ -1,3 +1,9 @@
+/**
+ * @file arrow_target.h
+ * @ingroup GameGraphics
+ * @brief TODO: Document this.
+ */
+
 #ifndef ARROWTARGET_H
 #define ARROWTARGET_H
 

cockatrice/src/game/board/card_drag_item.h

@@ -1,3 +1,9 @@
+/**
+ * @file card_drag_item.h
+ * @ingroup GameGraphicsCards
+ * @brief TODO: Document this.
+ */
+
 #ifndef CARDDRAGITEM_H
 #define CARDDRAGITEM_H
 

cockatrice/src/game/board/card_item.h

@@ -1,3 +1,9 @@
+/**
+ * @file card_item.h
+ * @ingroup GameGraphicsCards
+ * @brief TODO: Document this.
+ */
+
 #ifndef CARDITEM_H
 #define CARDITEM_H
 

cockatrice/src/game/board/card_list.h

@@ -1,3 +1,9 @@
+/**
+ * @file card_list.h
+ * @ingroup GameLogicCards
+ * @brief TODO: Document this.
+ */
+
 #ifndef CARDLIST_H
 #define CARDLIST_H
 

cockatrice/src/game/board/counter_general.h

@@ -1,3 +1,9 @@
+/**
+ * @file counter_general.h
+ * @ingroup GameGraphicsPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COUNTER_GENERAL_H
 #define COUNTER_GENERAL_H
 

cockatrice/src/game/board/graphics_item_type.h

@@ -1,3 +1,9 @@
+/**
+ * @file graphics_item_type.h
+ * @ingroup GameGraphics
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_GRAPHICS_ITEM_TYPE_H
 #define COCKATRICE_GRAPHICS_ITEM_TYPE_H
 

cockatrice/src/game/board/translate_counter_name.h

@@ -1,3 +1,9 @@
+/**
+ * @file translate_counter_name.h
+ * @ingroup GameGraphicsPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef TRANSLATECOUNTERNAME_H
 #define TRANSLATECOUNTERNAME_H
 

cockatrice/src/game/deckview/deck_view.h

@@ -1,3 +1,9 @@
+/**
+ * @file deck_view.h
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef DECKVIEW_H
 #define DECKVIEW_H
 

cockatrice/src/game/deckview/deck_view_container.h

@@ -1,3 +1,9 @@
+/**
+ * @file deck_view_container.h
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef DECK_VIEW_CONTAINER_H
 #define DECK_VIEW_CONTAINER_H
 

cockatrice/src/game/deckview/tabbed_deck_view_container.h

@@ -1,3 +1,9 @@
+/**
+ * @file tabbed_deck_view_container.h
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef TABBED_DECK_VIEW_CONTAINER_H
 #define TABBED_DECK_VIEW_CONTAINER_H
 #include "deck_view_container.h"

cockatrice/src/game/dialogs/dlg_create_token.h

@@ -1,3 +1,9 @@
+/**
+ * @file dlg_create_token.h
+ * @ingroup GameDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_CREATETOKEN_H
 #define DLG_CREATETOKEN_H
 

cockatrice/src/game/dialogs/dlg_move_top_cards_until.h

@@ -1,3 +1,9 @@
+/**
+ * @file dlg_move_top_cards_until.h
+ * @ingroup GameDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_MOVE_TOP_CARDS_UNTIL_H
 #define DLG_MOVE_TOP_CARDS_UNTIL_H
 

cockatrice/src/game/dialogs/dlg_roll_dice.h

@@ -1,3 +1,9 @@
+/**
+ * @file dlg_roll_dice.h
+ * @ingroup GameDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_ROLL_DICE_H
 #define DLG_ROLL_DICE_H
 

cockatrice/src/game/game.h

@@ -1,3 +1,9 @@
+/**
+ * @file game.h
+ * @ingroup GameLogic
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_GAME_H
 #define COCKATRICE_GAME_H
 

cockatrice/src/game/game_event_handler.h

@@ -1,3 +1,9 @@
+/**
+ * @file game_event_handler.h
+ * @ingroup GameLogic
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_GAME_EVENT_HANDLER_H
 #define COCKATRICE_GAME_EVENT_HANDLER_H
 

cockatrice/src/game/game_meta_info.h

@@ -1,3 +1,9 @@
+/**
+ * @file game_meta_info.h
+ * @ingroup GameLogic
+ * @brief TODO: Document this.
+ */
+
 #ifndef GAME_META_INFO_H
 #define GAME_META_INFO_H
 

cockatrice/src/game/game_scene.h

@@ -1,3 +1,9 @@
+/**
+ * @file game_scene.h
+ * @ingroup GameGraphics
+ * @brief TODO: Document this.
+ */
+
 #ifndef GAMESCENE_H
 #define GAMESCENE_H
 

cockatrice/src/game/game_state.h

@@ -1,3 +1,9 @@
+/**
+ * @file game_state.h
+ * @ingroup GameLogic
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_GAME_STATE_H
 #define COCKATRICE_GAME_STATE_H
 

cockatrice/src/game/game_view.h

@@ -1,3 +1,9 @@
+/**
+ * @file game_view.h
+ * @ingroup GameGraphics
+ * @brief TODO: Document this.
+ */
+
 #ifndef GAMEVIEW_H
 #define GAMEVIEW_H
 

cockatrice/src/game/hand_counter.h

@@ -1,3 +1,9 @@
+/**
+ * @file hand_counter.h
+ * @ingroup GameGraphicsPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef HANDCOUNTER_H
 #define HANDCOUNTER_H
 

cockatrice/src/game/log/message_log_widget.h

@@ -1,3 +1,9 @@
+/**
+ * @file message_log_widget.h
+ * @ingroup GameWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef MESSAGELOGWIDGET_H
 #define MESSAGELOGWIDGET_H
 

cockatrice/src/game/phase.h

@@ -1,3 +1,9 @@
+/**
+ * @file phase.h
+ * @ingroup GameLogic
+ * @brief TODO: Document this.
+ */
+
 #ifndef PHASE_H
 #define PHASE_H
 

cockatrice/src/game/phases_toolbar.h

@@ -1,3 +1,10 @@
+/**
+ * @file phases_toolbar.h
+ * @ingroup GameGraphics
+ * @ingroup GameWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef PHASESTOOLBAR_H
 #define PHASESTOOLBAR_H
 

cockatrice/src/game/player/card_menu_action_type.h

@@ -1,3 +1,9 @@
+/**
+ * @file card_menu_action_type.h
+ * @ingroup GameMenusPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_CARD_MENU_ACTION_TYPE_H
 #define COCKATRICE_CARD_MENU_ACTION_TYPE_H
 

cockatrice/src/game/player/event_processing_options.h

@@ -1,3 +1,9 @@
+/**
+ * @file event_processing_options.h
+ * @ingroup GameLogicPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_EVENT_PROCESSING_OPTIONS_H
 #define COCKATRICE_EVENT_PROCESSING_OPTIONS_H
 

cockatrice/src/game/player/menu/card_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file card_menu.h
+ * @ingroup GameMenusCards
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_CARD_MENU_H
 #define COCKATRICE_CARD_MENU_H
 

cockatrice/src/game/player/menu/custom_zone_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file custom_zone_menu.h
+ * @ingroup GameMenusZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_CUSTOM_ZONE_MENU_H
 #define COCKATRICE_CUSTOM_ZONE_MENU_H
 

cockatrice/src/game/player/menu/grave_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file grave_menu.h
+ * @ingroup GameMenusZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_GRAVE_MENU_H
 #define COCKATRICE_GRAVE_MENU_H
 

cockatrice/src/game/player/menu/hand_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file hand_menu.h
+ * @ingroup GameMenusZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_HAND_MENU_H
 #define COCKATRICE_HAND_MENU_H
 

cockatrice/src/game/player/menu/library_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file library_menu.h
+ * @ingroup GameMenusZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_LIBRARY_MENU_H
 #define COCKATRICE_LIBRARY_MENU_H
 

cockatrice/src/game/player/menu/move_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file move_menu.h
+ * @ingroup GameMenusZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_MOVE_MENU_H
 #define COCKATRICE_MOVE_MENU_H
 #include <QMenu>

cockatrice/src/game/player/menu/player_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file player_menu.h
+ * @ingroup GameMenusPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PLAYER_MENU_H
 #define COCKATRICE_PLAYER_MENU_H
 

cockatrice/src/game/player/menu/pt_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file pt_menu.h
+ * @ingroup GameMenusCards
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PT_MENU_H
 #define COCKATRICE_PT_MENU_H
 #include <QMenu>

cockatrice/src/game/player/menu/rfg_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file rfg_menu.h
+ * @ingroup GameMenusZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_RFG_MENU_H
 #define COCKATRICE_RFG_MENU_H
 

cockatrice/src/game/player/menu/say_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file say_menu.h
+ * @ingroup GameMenusPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_SAY_MENU_H
 #define COCKATRICE_SAY_MENU_H
 

cockatrice/src/game/player/menu/sideboard_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file sideboard_menu.h
+ * @ingroup GameMenusZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_SIDEBOARD_MENU_H
 #define COCKATRICE_SIDEBOARD_MENU_H
 

cockatrice/src/game/player/menu/utility_menu.h

@@ -1,3 +1,9 @@
+/**
+ * @file utility_menu.h
+ * @ingroup GameMenusPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_UTILITY_MENU_H
 #define COCKATRICE_UTILITY_MENU_H
 

cockatrice/src/game/player/player.h

@@ -1,3 +1,9 @@
+/**
+ * @file player.h
+ * @ingroup GameLogicPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef PLAYER_H
 #define PLAYER_H
 

cockatrice/src/game/player/player_actions.h

@@ -1,3 +1,10 @@
+/**
+ * @file player_actions.h
+ *  @ingroup GameLogicActions
+ * @ingroup GameLogicPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PLAYER_ACTIONS_H
 #define COCKATRICE_PLAYER_ACTIONS_H
 #include "event_processing_options.h"

cockatrice/src/game/player/player_area.h

@@ -1,3 +1,9 @@
+/**
+ * @file player_area.h
+ * @ingroup GameGraphicsPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PLAYER_AREA_H
 #define COCKATRICE_PLAYER_AREA_H
 

cockatrice/src/game/player/player_event_handler.h

@@ -1,3 +1,9 @@
+/**
+ * @file player_event_handler.h
+ * @ingroup GameLogicPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PLAYER_EVENT_HANDLER_H
 #define COCKATRICE_PLAYER_EVENT_HANDLER_H
 #include "event_processing_options.h"

cockatrice/src/game/player/player_graphics_item.h

@@ -1,3 +1,9 @@
+/**
+ * @file player_graphics_item.h
+ * @ingroup GameGraphicsPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PLAYER_GRAPHICS_ITEM_H
 #define COCKATRICE_PLAYER_GRAPHICS_ITEM_H
 #include "../game_scene.h"

cockatrice/src/game/player/player_info.h

@@ -1,3 +1,9 @@
+/**
+ * @file player_info.h
+ * @ingroup GameLogicPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PLAYER_INFO_H
 #define COCKATRICE_PLAYER_INFO_H
 

cockatrice/src/game/player/player_list_widget.h

@@ -1,3 +1,9 @@
+/**
+ * @file player_list_widget.h
+ * @ingroup GameWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef PLAYERLISTWIDGET_H
 #define PLAYERLISTWIDGET_H
 

cockatrice/src/game/player/player_manager.h

@@ -1,3 +1,9 @@
+/**
+ * @file player_manager.h
+ * @ingroup GameLogicPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PLAYER_MANAGER_H
 #define COCKATRICE_PLAYER_MANAGER_H
 

cockatrice/src/game/player/player_target.h

@@ -1,3 +1,9 @@
+/**
+ * @file player_target.h
+ * @ingroup GameGraphicsPlayers
+ * @brief TODO: Document this.
+ */
+
 #ifndef PLAYERTARGET_H
 #define PLAYERTARGET_H
 

cockatrice/src/game/replay.h

@@ -1,3 +1,10 @@
+/**
+ * @file replay.h
+ * @ingroup GameLogic
+ * @ingroup Replay
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_REPLAY_H
 #define COCKATRICE_REPLAY_H
 

cockatrice/src/game/zones/card_zone.h

@@ -1,3 +1,9 @@
+/**
+ * @file card_zone.h
+ * @ingroup GameGraphicsZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef CARDZONE_H
 #define CARDZONE_H
 

cockatrice/src/game/zones/hand_zone.h

@@ -1,3 +1,9 @@
+/**
+ * @file hand_zone.h
+ * @ingroup GameGraphicsZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef HANDZONE_H
 #define HANDZONE_H
 

cockatrice/src/game/zones/logic/card_zone_logic.h

@@ -1,3 +1,9 @@
+/**
+ * @file card_zone_logic.h
+ * @ingroup GameLogicZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_CARD_ZONE_LOGIC_H
 #define COCKATRICE_CARD_ZONE_LOGIC_H
 

cockatrice/src/game/zones/logic/hand_zone_logic.h

@@ -1,3 +1,9 @@
+/**
+ * @file hand_zone_logic.h
+ * @ingroup GameLogicZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_HAND_ZONE_LOGIC_H
 #define COCKATRICE_HAND_ZONE_LOGIC_H
 #include "card_zone_logic.h"

cockatrice/src/game/zones/logic/pile_zone_logic.h

@@ -1,3 +1,9 @@
+/**
+ * @file pile_zone_logic.h
+ * @ingroup GameLogicZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_PILE_ZONE_LOGIC_H
 #define COCKATRICE_PILE_ZONE_LOGIC_H
 #include "card_zone_logic.h"

cockatrice/src/game/zones/logic/stack_zone_logic.h

@@ -1,3 +1,9 @@
+/**
+ * @file stack_zone_logic.h
+ * @ingroup GameLogicZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_STACK_ZONE_LOGIC_H
 #define COCKATRICE_STACK_ZONE_LOGIC_H
 #include "card_zone_logic.h"

cockatrice/src/game/zones/logic/table_zone_logic.h

@@ -1,3 +1,9 @@
+/**
+ * @file table_zone_logic.h
+ * @ingroup GameLogicZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_TABLE_ZONE_LOGIC_H
 #define COCKATRICE_TABLE_ZONE_LOGIC_H
 #include "card_zone_logic.h"

cockatrice/src/game/zones/logic/view_zone_logic.h

@@ -1,3 +1,9 @@
+/**
+ * @file view_zone_logic.h
+ * @ingroup GameLogicZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef COCKATRICE_VIEW_ZONE_LOGIC_H
 #define COCKATRICE_VIEW_ZONE_LOGIC_H
 #include "card_zone_logic.h"

cockatrice/src/game/zones/pile_zone.h

@@ -1,3 +1,9 @@
+/**
+ * @file pile_zone.h
+ * @ingroup GameGraphicsZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef PILEZONE_H
 #define PILEZONE_H
 

cockatrice/src/game/zones/select_zone.h

@@ -1,3 +1,9 @@
+/**
+ * @file select_zone.h
+ * @ingroup GameGraphicsZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef SELECTZONE_H
 #define SELECTZONE_H
 

cockatrice/src/game/zones/stack_zone.h

@@ -1,3 +1,9 @@
+/**
+ * @file stack_zone.h
+ * @ingroup GameGraphicsZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef STACKZONE_H
 #define STACKZONE_H
 

cockatrice/src/game/zones/table_zone.h

@@ -1,3 +1,9 @@
+/**
+ * @file table_zone.h
+ * @ingroup GameGraphicsZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef TABLEZONE_H
 #define TABLEZONE_H
 

cockatrice/src/game/zones/view_zone.h

@@ -1,3 +1,9 @@
+/**
+ * @file view_zone.h
+ * @ingroup GameGraphicsZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef ZONEVIEWERZONE_H
 #define ZONEVIEWERZONE_H
 

cockatrice/src/game/zones/view_zone_widget.h

@@ -1,3 +1,9 @@
+/**
+ * @file view_zone_widget.h
+ * @ingroup GameGraphicsZones
+ * @brief TODO: Document this.
+ */
+
 #ifndef ZONEVIEWWIDGET_H
 #define ZONEVIEWWIDGET_H