Standardize Doxygen documentation (#6885)

2026-06-17 20:41:33 -07:00 · 2026-05-21 16:58:07 -04:00 · 2026-05-21 16:58:07 -04:00 · 33e0f8699b
commit 33e0f8699b
parent 03d54265fe
306 changed files with 539 additions and 487 deletions
--- a/cockatrice/src/interface/widgets/dialogs/dlg_connect.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_connect.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_connect.h
 * @ingroup ConnectionDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_CONNECT_H
 #define DLG_CONNECT_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_convert_deck_to_cod_format.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_convert_deck_to_cod_format.h
@ -2,8 +2,8 @@
 * @file dlg_convert_deck_to_cod_format.h
 * @ingroup LocalDeckStorageDialogs
 * @ingroup Lobby
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DIALOG_CONVERT_DECK_TO_COD_FORMAT_H
 #define DIALOG_CONVERT_DECK_TO_COD_FORMAT_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_create_game.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_create_game.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_create_game.h
 * @ingroup RoomDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_CREATEGAME_H
 #define DLG_CREATEGAME_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_default_tags_editor.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_default_tags_editor.h
@ -2,8 +2,8 @@
 * @file dlg_default_tags_editor.h
 * @ingroup Dialogs
 * @ingroup DeckStorageWidgets
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_DEFAULT_TAGS_EDITOR_H
 #define DLG_DEFAULT_TAGS_EDITOR_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_avatar.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_avatar.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_edit_avatar.h
 * @ingroup AccountDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_EDITAVATAR_H
 #define DLG_EDITAVATAR_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.cpp
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.cpp
@ -59,7 +59,7 @@ DlgEditPassword::DlgEditPassword(QWidget *parent) : QDialog(parent)

 void DlgEditPassword::actOk()
 {
-    //! \todo this stuff should be using qvalidators
+    //! \todo This stuff should be using QValidators.
    if (newPasswordEdit->text().length() < 8) {
        QMessageBox::critical(this, tr("Error"), tr("Your password is too short."));
        return;
--- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_edit_password.h
 * @ingroup AccountDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_EDITPASSWORD_H
 #define DLG_EDITPASSWORD_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_tokens.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_tokens.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_edit_tokens.h
 * @ingroup GameDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_EDIT_TOKENS_H
 #define DLG_EDIT_TOKENS_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_user.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_user.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_edit user.h
 * @ingroup NetworkDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_EDITUSER_H
 #define DLG_EDITUSER_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_filter_games.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_filter_games.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_filter_games.h
 * @ingroup RoomDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_FILTER_GAMES_H
 #define DLG_FILTER_GAMES_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_challenge.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_challenge.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_forgot_password_challenge.h
 * @ingroup AccountDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_FORGOTPASSWORDCHALLENGE_H
 #define DLG_FORGOTPASSWORDCHALLENGE_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_request.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_request.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_forgot_password_request.h
 * @ingroup AccountDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_FORGOTPASSWORDREQUEST_H
 #define DLG_FORGOTPASSWORDREQUEST_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.cpp
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.cpp
@ -121,7 +121,7 @@ void DlgForgotPasswordReset::actOk()
        return;
    }

-    //! \todo this stuff should be using qvalidators
+    //! \todo This stuff should be using QValidators.
    if (newpasswordEdit->text().length() < 8) {
        QMessageBox::critical(this, tr("Error"), tr("Your password is too short."));
        return;
--- a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_forgot_password_reset.h
 * @ingroup AccountDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_FORGOTPASSWORDRESET_H
 #define DLG_FORGOTPASSWORDRESET_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck.h
@ -2,8 +2,8 @@
 * @file dlg_load_deck.h
 * @ingroup LocalDeckStorageDialogs
 * @ingroup Lobby
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_LOAD_DECK_H
 #define DLG_LOAD_DECK_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_clipboard.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_clipboard.h
@ -2,8 +2,8 @@
 * @file dlg_load_deck_from_clipboard.h
 * @ingroup LocalDeckStorageDialogs
 * @ingroup Lobby
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_LOAD_DECK_FROM_CLIPBOARD_H
 #define DLG_LOAD_DECK_FROM_CLIPBOARD_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_website.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_website.h
@ -2,8 +2,8 @@
 * @file dlg_load_deck_from_website.h
 * @ingroup RemoteDeckStorageDialogs
 * @ingroup Lobby
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_LOAD_DECK_FROM_WEBSITE_H
 #define DLG_LOAD_DECK_FROM_WEBSITE_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_load_remote_deck.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_load_remote_deck.h
@ -2,8 +2,8 @@
 * @file dlg_load_remote_deck.h
 * @ingroup RemoteDeckStorageDialogs
 * @ingroup Lobby
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_STARTGAME_H
 #define DLG_STARTGAME_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_manage_sets.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_manage_sets.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_manage_sets.h
 * @ingroup Dialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_MANAGE_SETS_H
 #define DLG_MANAGE_SETS_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_register.cpp
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_register.cpp
@ -357,7 +357,7 @@ DlgRegister::DlgRegister(QWidget *parent) : QDialog(parent)

 void DlgRegister::actOk()
 {
-    //! \todo this stuff should be using qvalidators
+    //! \todo This stuff should be using QValidators.
    if (passwordEdit->text().length() < 8) {
        QMessageBox::critical(this, tr("Registration Warning"), tr("Your password is too short."));
        return;
--- a/cockatrice/src/interface/widgets/dialogs/dlg_register.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_register.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_register.h
 * @ingroup AccountDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_REGISTER_H
 #define DLG_REGISTER_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_select_set_for_cards.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_select_set_for_cards.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_select_set_for_cards.h
 * @ingroup Dialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_SELECT_SET_FOR_CARDS_H
 #define DLG_SELECT_SET_FOR_CARDS_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_settings.cpp
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_settings.cpp
@ -206,7 +206,7 @@ void DlgSettings::closeEvent(QCloseEvent *event)
    }

    if (!QDir(SettingsCache::instance().getDeckPath()).exists() || SettingsCache::instance().getDeckPath().isEmpty()) {
-        //! \todo Prompt to create it
+        //! \todo Prompt to create the deck directory.
        if (QMessageBox::critical(
                this, tr("Error"),
                tr("The path to your deck directory is invalid. Would you like to go back and set the correct path?"),
@ -217,7 +217,7 @@ void DlgSettings::closeEvent(QCloseEvent *event)
    }

    if (!QDir(SettingsCache::instance().getPicsPath()).exists() || SettingsCache::instance().getPicsPath().isEmpty()) {
-        //! \todo Prompt to create it
+        //! \todo Prompt to create the pictures directory.
        if (QMessageBox::critical(this, tr("Error"),
                                  tr("The path to your card pictures directory is invalid. Would you like to go back "
                                     "and set the correct path?"),
--- a/cockatrice/src/interface/widgets/dialogs/dlg_settings.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_settings.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_settings.h
 * @ingroup Dialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_SETTINGS_H
 #define DLG_SETTINGS_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_startup_card_check.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_startup_card_check.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_startup_card_check.h
 * @ingroup CardDatabaseUpdateDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_STARTUP_CARD_CHECK_H
 #define DLG_STARTUP_CARD_CHECK_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_tip_of_the_day.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_tip_of_the_day.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_tip_of_the_day.h
 * @ingroup Dialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_TIPOFDAY_H
 #define DLG_TIPOFDAY_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_update.cpp
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_update.cpp
@ -40,7 +40,7 @@ DlgUpdate::DlgUpdate(QWidget *parent) : QDialog(parent)
    buttonBox->addButton(ok, QDialogButtonBox::AcceptRole);

    connect(gotoDownload, &QPushButton::clicked, this, &DlgUpdate::gotoDownloadPage);
-    // TODO: make reinstall button actually do something when clicked
+    //! \todo Make reinstall button actually do something when clicked.
    // connect(manualDownload, &QPushButton::clicked, this, &DlgUpdate::downloadUpdate);
    connect(stopDownload, &QPushButton::clicked, this, &DlgUpdate::cancelDownload);
    connect(ok, &QPushButton::clicked, this, &DlgUpdate::closeDialog);
--- a/cockatrice/src/interface/widgets/dialogs/dlg_update.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_update.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_update.h
 * @ingroup ClientUpdateDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_UPDATE_H
 #define DLG_UPDATE_H
--- a/cockatrice/src/interface/widgets/dialogs/dlg_view_log.h
+++ b/cockatrice/src/interface/widgets/dialogs/dlg_view_log.h
@ -1,8 +1,8 @@
 /**
 * @file dlg_view_log.h
 * @ingroup ServerLogDialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef DLG_VIEWLOG_H
 #define DLG_VIEWLOG_H
--- a/cockatrice/src/interface/widgets/dialogs/tip_of_the_day.h
+++ b/cockatrice/src/interface/widgets/dialogs/tip_of_the_day.h
@ -1,8 +1,8 @@
 /**
 * @file tip_of_the_day.h
 * @ingroup Dialogs
- * @brief TODO: Document this.
 */
+//! \todo Document this file.

 #ifndef TIP_OF_DAY_H
 #define TIP_OF_DAY_H