[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>
2026-06-21 22:33:54 -07:00 · 2025-09-30 12:13:32 +02:00 · 2025-09-30 12:13:32 +02:00 · f8c4f774cf
commit f8c4f774cf
parent 22c6756ce0
297 changed files with 2368 additions and 19 deletions
--- a/cockatrice/src/tabs/api/edhrec/api_response/archidekt_links/edhrec_api_response_archidekt_links.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/archidekt_links/edhrec_api_response_archidekt_links.h
@ -6,7 +6,11 @@
 #include <QString>
 #include <QVector>

-// Represents a single Archidekt entry
+/**
+ * @class EdhrecApiResponseArchidektLink
+ * @ingroup ApiResponses
+ * @brief Represents a single Archidekt entry
+ */
 class EdhrecApiResponseArchidektLink
 {
 public:
@ -19,7 +23,11 @@ public:
    void debugPrint() const;
 };

-// Represents the Archidekt section as a list of entries
+/**
+ * @class EdhrecCommanderApiResponseArchidektLinks
+ * @ingroup ApiResponses
+ * @brief Represents the Archidekt section as a list of entries
+ */
 class EdhrecCommanderApiResponseArchidektLinks
 {
 public:
--- a/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_average_deck_api_response.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_average_deck_api_response.h
@ -10,7 +10,11 @@
 #include <QJsonObject>
 #include <QString>

-// Represents the main structure of the JSON
+/**
+ * @class EdhrecAverageDeckApiResponse
+ * @ingroup ApiResponses
+ * @brief Represents the main structure of the JSON
+ */
 class EdhrecAverageDeckApiResponse
 {
 public:
--- a/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_deck_api_response.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_DECK_API_RESPONSE_H
 #define EDHREC_DECK_API_RESPONSE_H

--- a/cockatrice/src/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_prices.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_PRICES_H
 #define EDHREC_COMMANDER_API_RESPONSE_CARD_PRICES_H

--- a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_container.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef CONTAINER_ENTRY_H
 #define CONTAINER_ENTRY_H

--- a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_details.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef CARD_VIEW_H
 #define CARD_VIEW_H

--- a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_list.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef CARD_LIST_H
 #define CARD_LIST_H

--- a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_commander_api_response_commander_details.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_H
 #define EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_H

--- a/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response.h
@ -9,7 +9,11 @@
 #include <QJsonObject>
 #include <QString>

-// Represents the main structure of the JSON
+/**
+ * @class EdhrecCommanderApiResponse
+ * @ingroup ApiResponses
+ * @brief Represents the main structure of the JSON
+ */
 class EdhrecCommanderApiResponse
 {
 public:
--- a/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response_average_deck_statistics.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response_average_deck_statistics.h
@ -3,7 +3,11 @@

 #include <QJsonObject>

-// Represents the typical deck statistics (collapsed section)
+/**
+ * @struct EdhrecCommanderApiResponseAverageDeckStatistics
+ * @ingroup ApiResponses
+ * @brief Represents the typical deck statistics (collapsed section)
+ */
 struct EdhrecCommanderApiResponseAverageDeckStatistics
 {
    int creature = 0;
--- a/cockatrice/src/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_top_cards_api_response.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_TOP_CARDS_API_RESPONSE_H
 #define EDHREC_TOP_CARDS_API_RESPONSE_H

--- a/cockatrice/src/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_top_commanders_api_response.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_TOP_COMMANDERS_API_RESPONSE_H
 #define EDHREC_TOP_COMMANDERS_API_RESPONSE_H

--- a/cockatrice/src/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h
+++ b/cockatrice/src/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_top_tags_api_response.h
+ * @ingroup ApiResponses
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_TOP_TAGS_API_RESPONSE_H
 #define EDHREC_TOP_TAGS_API_RESPONSE_H

--- a/cockatrice/src/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_prices_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_API_RESPONSE_CARD_PRICES_DISPLAY_WIDGET_H
 #define EDHREC_API_RESPONSE_CARD_PRICES_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_details_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_DETAILS_DISPLAY_WIDGET_H
 #define EDHREC_COMMANDER_API_RESPONSE_CARD_DETAILS_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_inclusion_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_API_RESPONSE_CARD_INCLUSION_DISPLAY_WIDGET_H
 #define EDHREC_API_RESPONSE_CARD_INCLUSION_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_list_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_LIST_DISPLAY_WIDGET_H
 #define EDHREC_COMMANDER_API_RESPONSE_CARD_LIST_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_card_synergy_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_API_RESPONSE_CARD_SYNERGY_DISPLAY_WIDGET_H
 #define EDHREC_API_RESPONSE_CARD_SYNERGY_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_api_response_commander_details_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_DISPLAY_WIDGET_H
 #define EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_commander_api_response_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_COMMANDER_API_RESPONSE_DISPLAY_WIDGET_H
 #define EDHREC_COMMANDER_API_RESPONSE_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_commander_api_response_navigation_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_COMMANDER_API_RESPONSE_NAVIGATION_WIDGET_H
 #define EDHREC_COMMANDER_API_RESPONSE_NAVIGATION_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_top_cards_api_response_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_TOP_CARDS_API_RESPONSE_DISPLAY_WIDGET_H
 #define EDHREC_TOP_CARDS_API_RESPONSE_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_top_commanders_api_response_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_TOP_COMMANDERS_API_RESPONSE_DISPLAY_WIDGET_H
 #define EDHREC_TOP_COMMANDERS_API_RESPONSE_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h
+++ b/cockatrice/src/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h
@ -1,3 +1,9 @@
+/**
+ * @file edhrec_top_tags_api_response_display_widget.h
+ * @ingroup ApiResponseDisplayWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef EDHREC_TOP_TAGS_API_RESPONSE_DISPLAY_WIDGET_H
 #define EDHREC_TOP_TAGS_API_RESPONSE_DISPLAY_WIDGET_H

--- a/cockatrice/src/tabs/api/edhrec/tab_edhrec.h
+++ b/cockatrice/src/tabs/api/edhrec/tab_edhrec.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_edhrec.h
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_EDHREC_H
 #define TAB_EDHREC_H

--- a/cockatrice/src/tabs/api/edhrec/tab_edhrec_main.h
+++ b/cockatrice/src/tabs/api/edhrec/tab_edhrec_main.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_edhrec_main.h
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_EDHREC_MAIN_H
 #define TAB_EDHREC_MAIN_H

--- a/cockatrice/src/tabs/tab.h
+++ b/cockatrice/src/tabs/tab.h
@ -1,3 +1,9 @@
+/**
+ * @file tab.h
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_H
 #define TAB_H

--- a/cockatrice/src/tabs/tab_account.h
+++ b/cockatrice/src/tabs/tab_account.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_account.h
+ * @ingroup NetworkingTabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_ACCOUNT_H
 #define TAB_ACCOUNT_H

--- a/cockatrice/src/tabs/tab_admin.h
+++ b/cockatrice/src/tabs/tab_admin.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_admin.h
+ * @ingroup NetworkingTabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_ADMIN_H
 #define TAB_ADMIN_H

--- a/cockatrice/src/tabs/tab_deck_storage.h
+++ b/cockatrice/src/tabs/tab_deck_storage.h
@ -1,3 +1,10 @@
+/**
+ * @file tab_deck_storage.h
+ * @ingroup DeckStorageWidgets
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_DECK_STORAGE_H
 #define TAB_DECK_STORAGE_H

--- a/cockatrice/src/tabs/tab_game.h
+++ b/cockatrice/src/tabs/tab_game.h
@ -1,3 +1,11 @@
+/**
+ * @file tab_game.h
+ * @ingroup Tabs
+ * @ingroup GameWidgets
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_GAME_H
 #define TAB_GAME_H

--- a/cockatrice/src/tabs/tab_home.h
+++ b/cockatrice/src/tabs/tab_home.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_home.h
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_HOME_H
 #define TAB_HOME_H

--- a/cockatrice/src/tabs/tab_logs.h
+++ b/cockatrice/src/tabs/tab_logs.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_logs.h
+ * @ingroup NetworkingTabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_LOG_H
 #define TAB_LOG_H

--- a/cockatrice/src/tabs/tab_message.h
+++ b/cockatrice/src/tabs/tab_message.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_message.h
+ * @ingroup NetworkingTabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_MESSAGE_H
 #define TAB_MESSAGE_H

--- a/cockatrice/src/tabs/tab_replays.h
+++ b/cockatrice/src/tabs/tab_replays.h
@ -1,3 +1,10 @@
+/**
+ * @file tab_replays.h
+ * @ingroup Replays
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_REPLAYS_H
 #define TAB_REPLAYS_H

--- a/cockatrice/src/tabs/tab_room.h
+++ b/cockatrice/src/tabs/tab_room.h
@ -1,3 +1,10 @@
+/**
+ * @file tab_room.h
+ * @ingroup NetworkingTabs
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_ROOM_H
 #define TAB_ROOM_H

--- a/cockatrice/src/tabs/tab_server.h
+++ b/cockatrice/src/tabs/tab_server.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_server.h
+ * @ingroup NetworkingTabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_SERVER_H
 #define TAB_SERVER_H

--- a/cockatrice/src/tabs/tab_supervisor.h
+++ b/cockatrice/src/tabs/tab_supervisor.h
@ -1,3 +1,10 @@
+/**
+ * @file tab_supervisor.h
+ * @ingroup Core
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_SUPERVISOR_H
 #define TAB_SUPERVISOR_H

--- a/cockatrice/src/tabs/tab_visual_database_display.h
+++ b/cockatrice/src/tabs/tab_visual_database_display.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_visual_database_display.h
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_VISUAL_DATABASE_DISPLAY_H
 #define TAB_VISUAL_DATABASE_DISPLAY_H

--- a/cockatrice/src/tabs/visual_deck_storage/tab_deck_storage_visual.h
+++ b/cockatrice/src/tabs/visual_deck_storage/tab_deck_storage_visual.h
@ -1,3 +1,9 @@
+/**
+ * @file tab_deck_storage_visual.h
+ * @ingroup Tabs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TAB_DECK_STORAGE_VISUAL_H
 #define TAB_DECK_STORAGE_VISUAL_H