[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-11 08:34:52 -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/dialogs/dlg_connect.h
+++ b/cockatrice/src/dialogs/dlg_connect.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_connect.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_CONNECT_H
 #define DLG_CONNECT_H

--- a/cockatrice/src/dialogs/dlg_convert_deck_to_cod_format.h
+++ b/cockatrice/src/dialogs/dlg_convert_deck_to_cod_format.h
@ -1,3 +1,11 @@
+/**
+ * @file dlg_convert_deck_to_cod_format.h
+ * @ingroup Dialogs
+ * @ingroup DeckStorageWidgets
+ * @ingroup ImportExport
+ * @brief TODO: Document this.
+ */
+
 #ifndef DIALOG_CONVERT_DECK_TO_COD_FORMAT_H
 #define DIALOG_CONVERT_DECK_TO_COD_FORMAT_H

--- a/cockatrice/src/dialogs/dlg_create_game.h
+++ b/cockatrice/src/dialogs/dlg_create_game.h
@ -1,3 +1,10 @@
+/**
+ * @file dlg_create_game.h
+ * @ingroup NetworkDialogs
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_CREATEGAME_H
 #define DLG_CREATEGAME_H

--- a/cockatrice/src/dialogs/dlg_default_tags_editor.h
+++ b/cockatrice/src/dialogs/dlg_default_tags_editor.h
@ -1,3 +1,10 @@
+/**
+ * @file dlg_default_tags_editor.h
+ * @ingroup Dialogs
+ * @ingroup DeckStorageWidgets
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_DEFAULT_TAGS_EDITOR_H
 #define DLG_DEFAULT_TAGS_EDITOR_H

--- a/cockatrice/src/dialogs/dlg_edit_avatar.h
+++ b/cockatrice/src/dialogs/dlg_edit_avatar.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_edit_avatar.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_EDITAVATAR_H
 #define DLG_EDITAVATAR_H

--- a/cockatrice/src/dialogs/dlg_edit_password.h
+++ b/cockatrice/src/dialogs/dlg_edit_password.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_edit_password.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_EDITPASSWORD_H
 #define DLG_EDITPASSWORD_H

--- a/cockatrice/src/dialogs/dlg_edit_tokens.h
+++ b/cockatrice/src/dialogs/dlg_edit_tokens.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_edit_tokens.h
+ * @ingroup GameDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_EDIT_TOKENS_H
 #define DLG_EDIT_TOKENS_H

--- a/cockatrice/src/dialogs/dlg_edit_user.h
+++ b/cockatrice/src/dialogs/dlg_edit_user.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_edit user.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_EDITUSER_H
 #define DLG_EDITUSER_H

--- a/cockatrice/src/dialogs/dlg_filter_games.h
+++ b/cockatrice/src/dialogs/dlg_filter_games.h
@ -1,3 +1,10 @@
+/**
+ * @file dlg_filter_games.h
+ * @ingroup Lobby
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_FILTER_GAMES_H
 #define DLG_FILTER_GAMES_H

--- a/cockatrice/src/dialogs/dlg_forgot_password_challenge.h
+++ b/cockatrice/src/dialogs/dlg_forgot_password_challenge.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_forgot_password_challenge.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_FORGOTPASSWORDCHALLENGE_H
 #define DLG_FORGOTPASSWORDCHALLENGE_H

--- a/cockatrice/src/dialogs/dlg_forgot_password_request.h
+++ b/cockatrice/src/dialogs/dlg_forgot_password_request.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_forgot_password_request.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_FORGOTPASSWORDREQUEST_H
 #define DLG_FORGOTPASSWORDREQUEST_H

--- a/cockatrice/src/dialogs/dlg_forgot_password_reset.h
+++ b/cockatrice/src/dialogs/dlg_forgot_password_reset.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_forgot_password_reset.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_FORGOTPASSWORDRESET_H
 #define DLG_FORGOTPASSWORDRESET_H

--- a/cockatrice/src/dialogs/dlg_load_deck.h
+++ b/cockatrice/src/dialogs/dlg_load_deck.h
@ -1,3 +1,10 @@
+/**
+ * @file dlg_load_deck.h
+ * @ingroup Dialogs
+ * @ingroup ImportExport
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */

 #ifndef DLG_LOAD_DECK_H
 #define DLG_LOAD_DECK_H
--- a/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h
+++ b/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h
@ -1,3 +1,11 @@
+/**
+ * @file dlg_load_deck_from_clipboard.h
+ * @ingroup Dialogs
+ * @ingroup ImportExport
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_LOAD_DECK_FROM_CLIPBOARD_H
 #define DLG_LOAD_DECK_FROM_CLIPBOARD_H

--- a/cockatrice/src/dialogs/dlg_load_deck_from_website.h
+++ b/cockatrice/src/dialogs/dlg_load_deck_from_website.h
@ -1,3 +1,11 @@
+/**
+ * @file dlg_load_deck_from_website.h
+ * @ingroup Dialogs
+ * @ingroup ImportExport
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_LOAD_DECK_FROM_WEBSITE_H
 #define DLG_LOAD_DECK_FROM_WEBSITE_H

--- a/cockatrice/src/dialogs/dlg_load_remote_deck.h
+++ b/cockatrice/src/dialogs/dlg_load_remote_deck.h
@ -1,3 +1,11 @@
+/**
+ * @file dlg_load_remote_deck.h
+ * @ingroup Dialogs
+ * @ingroup ImportExport
+ * @ingroup Lobby
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_STARTGAME_H
 #define DLG_STARTGAME_H

--- a/cockatrice/src/dialogs/dlg_manage_sets.h
+++ b/cockatrice/src/dialogs/dlg_manage_sets.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_manage_sets.h
+ * @ingroup Dialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_MANAGE_SETS_H
 #define DLG_MANAGE_SETS_H

--- a/cockatrice/src/dialogs/dlg_register.h
+++ b/cockatrice/src/dialogs/dlg_register.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_register.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_REGISTER_H
 #define DLG_REGISTER_H

--- a/cockatrice/src/dialogs/dlg_select_set_for_cards.h
+++ b/cockatrice/src/dialogs/dlg_select_set_for_cards.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_select_set_for_cards.h
+ * @ingroup Dialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_SELECT_SET_FOR_CARDS_H
 #define DLG_SELECT_SET_FOR_CARDS_H

--- a/cockatrice/src/dialogs/dlg_settings.h
+++ b/cockatrice/src/dialogs/dlg_settings.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_settings.h
+ * @ingroup Dialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_SETTINGS_H
 #define DLG_SETTINGS_H

--- a/cockatrice/src/dialogs/dlg_startup_card_check.h
+++ b/cockatrice/src/dialogs/dlg_startup_card_check.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_startup_card_check.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_STARTUP_CARD_CHECK_H
 #define DLG_STARTUP_CARD_CHECK_H

--- a/cockatrice/src/dialogs/dlg_tip_of_the_day.h
+++ b/cockatrice/src/dialogs/dlg_tip_of_the_day.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_tip_of_the_day.h
+ * @ingroup Dialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_TIPOFDAY_H
 #define DLG_TIPOFDAY_H

--- a/cockatrice/src/dialogs/dlg_update.h
+++ b/cockatrice/src/dialogs/dlg_update.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_update.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_UPDATE_H
 #define DLG_UPDATE_H

--- a/cockatrice/src/dialogs/dlg_view_log.h
+++ b/cockatrice/src/dialogs/dlg_view_log.h
@ -1,3 +1,9 @@
+/**
+ * @file dlg_view_log.h
+ * @ingroup NetworkDialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef DLG_VIEWLOG_H
 #define DLG_VIEWLOG_H

--- a/cockatrice/src/dialogs/tip_of_the_day.h
+++ b/cockatrice/src/dialogs/tip_of_the_day.h
@ -1,3 +1,9 @@
+/**
+ * @file tip_of_the_day.h
+ * @ingroup Dialogs
+ * @brief TODO: Document this.
+ */
+
 #ifndef TIP_OF_DAY_H
 #define TIP_OF_DAY_H