jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-07-10 12:23:58 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Standardize Doxygen documentation (#6885)

Browse source
This commit is contained in:
DawnFire42 2026-05-21 16:58:07 -04:00 • committed by GitHub
parent 03d54265fe
commit 33e0f8699b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
306 changed files with 539 additions and 487 deletions
Download patch file Download diff file Expand all files Collapse all files

10
cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/card/archidekt_api_response_card.cpp
View file

@ -21,16 +21,16 @@ void ArchidektApiResponseCard::fromJson(const QJsonObject &json)
edition.fromJson(json.value("edition").toObject());
flavor = json.value("flavor").toString();
//! \todo but not really important
//! \todo games = {""};
//! \todo options = {""};
//! \todo Parse games and options fields (not really important).
// games = {""};
// options = {""};
scryfallImageHash = json.value("scryfallImageHash").toString();
oracleCard = json.value("oracleCard").toObject();
owned = json.value("owned").toInt();
pinnedStatus = json.value("pinnedStatus").toInt();
rarity = json.value("rarity").toString();
//! \todo but not really important
//! \todo globalCategories = {""};
//! \todo Parse globalCategories field (not really important).
// globalCategories = {""};
}
void ArchidektApiResponseCard::debugPrint() const

2
cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck/archidekt_api_response_deck.cpp
View file

@ -44,7 +44,7 @@ void ArchidektApiResponseDeck::fromJson(const QJsonObject &json)
cards.append(entry);
}
// TODO but not really important
//! \todo Parse customCards field (not really important).
// customCards = {""};
}

2
cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_listing_container.cpp
View file

@ -23,7 +23,7 @@ void ArchidektApiResponseDeckListingContainer::fromJson(const QJsonObject &json)
theoryCrafted = json.value("theoryCrafted").toBool();
game = json.value("game").toString();
hasDescription = json.value("hasDescription").toBool();
// TODO
//! \todo Parse tags field.
// tags = {""};
parentFolderId = json.value("parentFolderId").toInt();
owner.fromJson(json.value("owner").toObject());

2
cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_owner.cpp
View file

@ -7,7 +7,7 @@ void ArchidektApiResponseDeckOwner::fromJson(const QJsonObject &json)
avatar = QUrl(json.value("avatar").toString());
moderator = json.value("moderator").toBool();
pledgeLevel = json.value("pledgeLevel").toInt();
// TODO but not really important
//! \todo Parse roles field (not really important).
// roles = {""};
}

8
cockatrice/src/interface/widgets/tabs/api/archidekt/display/archidekt_api_response_deck_listings_display_widget.h
View file

@ -82,16 +82,16 @@ public:
void resizeEvent(QResizeEvent *event) override;
private:
/// Slider controlling the scale of card thumbnails in all deck entry widgets.
/** @brief Slider controlling the scale of card thumbnails in all deck entry widgets. */
CardSizeWidget *cardSizeSlider;
/// Main horizontal layout containing the FlowWidget.
/** @brief Main horizontal layout containing the FlowWidget. */
QHBoxLayout *layout;
/// Container providing scrollable multi-row flow layout of deck entries.
/** @brief Container providing scrollable multi-row flow layout of deck entries. */
FlowWidget *flowWidget;
/// Shared network manager used to download card images for all child entry widgets.
/** @brief Shared network manager used to download card images for all child entry widgets. */
QNetworkAccessManager *imageNetworkManager;
};

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_deck_api_response.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_DECK_API_RESPONSE_H
#define EDHREC_DECK_API_RESPONSE_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_prices.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_PRICES_H
#define EDHREC_COMMANDER_API_RESPONSE_CARD_PRICES_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_container.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CONTAINER_ENTRY_H
#define CONTAINER_ENTRY_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_details.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_VIEW_H
#define CARD_VIEW_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_list.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_LIST_H
#define CARD_LIST_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_commander_api_response_commander_details.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_H
#define EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_top_cards_api_response.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_TOP_CARDS_API_RESPONSE_H
#define EDHREC_TOP_CARDS_API_RESPONSE_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_top_commanders_api_response.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_TOP_COMMANDERS_API_RESPONSE_H
#define EDHREC_TOP_COMMANDERS_API_RESPONSE_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_top_tags_api_response.h
* @ingroup ApiResponses
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_TOP_TAGS_API_RESPONSE_H
#define EDHREC_TOP_TAGS_API_RESPONSE_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_prices_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_API_RESPONSE_CARD_PRICES_DISPLAY_WIDGET_H
#define EDHREC_API_RESPONSE_CARD_PRICES_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_details_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_DETAILS_DISPLAY_WIDGET_H
#define EDHREC_COMMANDER_API_RESPONSE_CARD_DETAILS_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_inclusion_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_API_RESPONSE_CARD_INCLUSION_DISPLAY_WIDGET_H
#define EDHREC_API_RESPONSE_CARD_INCLUSION_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_list_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_LIST_DISPLAY_WIDGET_H
#define EDHREC_COMMANDER_API_RESPONSE_CARD_LIST_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_card_synergy_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_API_RESPONSE_CARD_SYNERGY_DISPLAY_WIDGET_H
#define EDHREC_API_RESPONSE_CARD_SYNERGY_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_api_response_commander_details_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_DISPLAY_WIDGET_H
#define EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_commander_api_response_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_COMMANDER_API_RESPONSE_DISPLAY_WIDGET_H
#define EDHREC_COMMANDER_API_RESPONSE_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_commander_api_response_navigation_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_COMMANDER_API_RESPONSE_NAVIGATION_WIDGET_H
#define EDHREC_COMMANDER_API_RESPONSE_NAVIGATION_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_top_cards_api_response_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_TOP_CARDS_API_RESPONSE_DISPLAY_WIDGET_H
#define EDHREC_TOP_CARDS_API_RESPONSE_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_top_commanders_api_response_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_TOP_COMMANDERS_API_RESPONSE_DISPLAY_WIDGET_H
#define EDHREC_TOP_COMMANDERS_API_RESPONSE_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file edhrec_top_tags_api_response_display_widget.h
* @ingroup ApiResponseDisplayWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef EDHREC_TOP_TAGS_API_RESPONSE_DISPLAY_WIDGET_H
#define EDHREC_TOP_TAGS_API_RESPONSE_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_edhrec.h
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_EDHREC_H
#define TAB_EDHREC_H

2
cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec_main.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_edhrec_main.h
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_EDHREC_MAIN_H
#define TAB_EDHREC_MAIN_H

2
cockatrice/src/interface/widgets/tabs/tab.h
View file

@ -1,8 +1,8 @@
/**
* @file tab.h
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_H
#define TAB_H

2
cockatrice/src/interface/widgets/tabs/tab_account.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_account.h
* @ingroup AccountTabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_ACCOUNT_H
#define TAB_ACCOUNT_H

2
cockatrice/src/interface/widgets/tabs/tab_admin.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_admin.h
* @ingroup ServerTabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_ADMIN_H
#define TAB_ADMIN_H

2
cockatrice/src/interface/widgets/tabs/tab_deck_storage.h
View file

@ -2,8 +2,8 @@
* @file tab_deck_storage.h
* @ingroup DeckStorageWidgets
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_DECK_STORAGE_H
#define TAB_DECK_STORAGE_H

2
cockatrice/src/interface/widgets/tabs/tab_game.h
View file

@ -3,8 +3,8 @@
* @ingroup Tabs
* @ingroup GameWidgets
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_GAME_H
#define TAB_GAME_H

2
cockatrice/src/interface/widgets/tabs/tab_home.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_home.h
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_HOME_H
#define TAB_HOME_H

2
cockatrice/src/interface/widgets/tabs/tab_logs.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_logs.h
* @ingroup ServerTabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_LOG_H
#define TAB_LOG_H

2
cockatrice/src/interface/widgets/tabs/tab_message.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_message.h
* @ingroup MessagingTabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_MESSAGE_H
#define TAB_MESSAGE_H

2
cockatrice/src/interface/widgets/tabs/tab_replays.h
View file

@ -2,8 +2,8 @@
* @file tab_replays.h
* @ingroup Replays
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_REPLAYS_H
#define TAB_REPLAYS_H

2
cockatrice/src/interface/widgets/tabs/tab_room.h
View file

@ -2,8 +2,8 @@
* @file tab_room.h
* @ingroup RoomTabs
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_ROOM_H
#define TAB_ROOM_H

2
cockatrice/src/interface/widgets/tabs/tab_server.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_server.h
* @ingroup ServerTabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_SERVER_H
#define TAB_SERVER_H

2
cockatrice/src/interface/widgets/tabs/tab_supervisor.h
View file

@ -2,8 +2,8 @@
* @file tab_supervisor.h
* @ingroup Core
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_SUPERVISOR_H
#define TAB_SUPERVISOR_H

2
cockatrice/src/interface/widgets/tabs/tab_visual_database_display.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_visual_database_display.h
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_VISUAL_DATABASE_DISPLAY_H
#define TAB_VISUAL_DATABASE_DISPLAY_H

10
cockatrice/src/interface/widgets/tabs/visual_deck_editor/tab_deck_editor_visual_tab_widget.h
View file

@ -63,19 +63,19 @@ public:
CardDatabaseModel *_cardDatabaseModel,
CardDatabaseDisplayModel *_cardDatabaseDisplayModel);
/// Add a new tab with a widget and title.
/** @brief Add a new tab with a widget and title. */
void addNewTab(QWidget *widget, const QString &title);
/// Remove the currently active tab.
/** @brief Remove the currently active tab. */
void removeCurrentTab();
/// Set the title of a specific tab.
/** @brief Set the title of a specific tab. */
void setTabTitle(int index, const QString &title);
/// Get the currently active tab widget.
/** @brief Get the currently active tab widget. */
[[nodiscard]] QWidget *getCurrentTab() const;
/// Get the total number of tabs.
/** @brief Get the total number of tabs. */
[[nodiscard]] int getTabCount() const;
VisualDeckEditorWidget *visualDeckView; ///< Visual deck editor widget.

2
cockatrice/src/interface/widgets/tabs/visual_deck_storage/tab_deck_storage_visual.h
View file

@ -1,8 +1,8 @@
/**
* @file tab_deck_storage_visual.h
* @ingroup Tabs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAB_DECK_STORAGE_VISUAL_H
#define TAB_DECK_STORAGE_VISUAL_H