jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-06-12 09:04:53 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

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

2
cockatrice/src/interface/card_picture_loader/card_picture_to_load.cpp
View file

@ -53,12 +53,12 @@ QList<CardSetPtr> CardPictureToLoad::extractSetsSorted(const ExactCard &card)
* PrintingInfo for the set is returned.
*
* This method only exists to maintain existing behavior.
* TODO: check if going through all sets is still necessary after the ExactCard refactor.
*
* @param card The card to look in
* @param setName The set's short name
* @return A PrintingInfo, or a default-constructed PrintingInfo if the set name is not in the CardInfo.
*/
//! \todo Check if going through all sets is still necessary after the ExactCard refactor.
static PrintingInfo findPrintingForSet(const ExactCard &card, const QString &setName)
{
SetToPrintingsMap setsToPrintings = card.getInfo().getSets();

2
cockatrice/src/interface/deck_loader/deck_loader.h
View file

@ -1,8 +1,8 @@
/**
* @file deck_loader.h
* @ingroup ImportExport
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_LOADER_H
#define DECK_LOADER_H

2
cockatrice/src/interface/key_signals.h
View file

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

1
cockatrice/src/interface/layouts/flow_layout.h
View file

@ -4,6 +4,7 @@
* @brief A QLayout subclass that arranges child widgets in wrapping rows (horizontal flow)
* or wrapping columns (vertical flow).
*/
//! \todo Document this file.
#ifndef FLOW_LAYOUT_H
#define FLOW_LAYOUT_H

2
cockatrice/src/interface/layouts/overlap_layout.cpp
View file

@ -223,7 +223,7 @@ void OverlapLayout::setGeometry(const QRect &rect)
const int yPos = rect.top() + currentRow * (maxItemHeight - overlapOffsetHeight);
item->setGeometry(QRect(xPos, yPos, maxItemWidth, maxItemHeight));
// TODO: Figure this out properly or maybe adjust size hint to account for this?
//! \todo Figure this out properly or maybe adjust size hint to account for this.
// Update row and column indices based on the layout direction.
if (overlapDirection == Qt::Horizontal) {
currentColumn++;

2
cockatrice/src/interface/layouts/overlap_layout.h
View file

@ -1,8 +1,8 @@
/**
* @file overlap_layout.h
* @ingroup UI
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef OVERLAP_LAYOUT_H
#define OVERLAP_LAYOUT_H

2
cockatrice/src/interface/logger.h
View file

@ -1,8 +1,8 @@
/**
* @file logger.h
* @ingroup Core
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef LOGGER_H
#define LOGGER_H

2
cockatrice/src/interface/pixel_map_generator.h
View file

@ -1,8 +1,8 @@
/**
* @file pixel_map_generator.h
* @ingroup UI
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PIXMAPGENERATOR_H
#define PIXMAPGENERATOR_H

2
cockatrice/src/interface/theme_manager.cpp
View file

@ -92,7 +92,7 @@ struct PaletteColorInfo
ThemeManager::ThemeManager(QObject *parent) : QObject(parent)
{
defaultStyleName = qApp->style()->objectName();
// FIXME workaround for windows11 style being broken
//! \todo Workaround for windows11 style being broken.
if (defaultStyleName == "windows11") {
defaultStyleName = "windowsvista";
}

2
cockatrice/src/interface/theme_manager.h
View file

@ -1,8 +1,8 @@
/**
* @file theme_manager.h
* @ingroup CoreSettings
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef THEMEMANAGER_H
#define THEMEMANAGER_H

2
cockatrice/src/interface/widgets/cards/additional_info/color_identity_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file color_identity_widget.h
* @ingroup CardExtraInfoWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COLOR_IDENTITY_WIDGET_H
#define COLOR_IDENTITY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/additional_info/mana_cost_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file mana_cost_widget.h
* @ingroup CardExtraInfoWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef MANA_COST_WIDGET_H
#define MANA_COST_WIDGET_H

2
cockatrice/src/interface/widgets/cards/additional_info/mana_symbol_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file mana_symbol_widget.h
* @ingroup CardExtraInfoWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef MANA_SYMBOL_WIDGET_H
#define MANA_SYMBOL_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_group_display_widgets/card_group_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_group_display_widget.h
* @ingroup DeckEditorCardGroupWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_GROUP_DISPLAY_WIDGET_H
#define CARD_GROUP_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_group_display_widgets/flat_card_group_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file flat_card_group_display_widget.h
* @ingroup DeckEditorCardGroupWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef FLAT_CARD_GROUP_DISPLAY_WIDGET_H
#define FLAT_CARD_GROUP_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_group_display_widgets/overlapped_card_group_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file overlapped_card_group_display_widget.h
* @ingroup DeckEditorCardGroupWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef OVERLAPPED_CARD_GROUP_DISPLAY_WIDGET_H
#define OVERLAPPED_CARD_GROUP_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_info_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_display_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDINFOWIDGET_H
#define CARDINFOWIDGET_H

2
cockatrice/src/interface/widgets/cards/card_info_frame_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_frame_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDFRAME_H
#define CARDFRAME_H

2
cockatrice/src/interface/widgets/cards/card_info_picture_art_crop_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_picture_art_crop_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_INFO_PICTURE_ART_CROP_WIDGET_H
#define CARD_INFO_PICTURE_ART_CROP_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_info_picture_enlarged_widget.h
View file

@ -2,8 +2,8 @@
* @file card_info_picture_enlarged_widget.h
* @ingroup CardWigets
* @ingroup DeckEditorWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_PICTURE_ENLARGED_WIDGET_H
#define CARD_PICTURE_ENLARGED_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_info_picture_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_picture_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_INFO_PICTURE_H
#define CARD_INFO_PICTURE_H

2
cockatrice/src/interface/widgets/cards/card_info_picture_with_text_overlay_widget.h
View file

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

2
cockatrice/src/interface/widgets/cards/card_info_text_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_text_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDINFOTEXT_H
#define CARDINFOTEXT_H

2
cockatrice/src/interface/widgets/cards/card_size_widget.h
View file

@ -3,8 +3,8 @@
* @ingroup CardWidgets
* @ingroup DeckEditorWidgets
* @ingroup DeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_SIZE_WIDGET_H
#define CARD_SIZE_WIDGET_H

2
cockatrice/src/interface/widgets/cards/deck_card_zone_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file deck_card_zone_display_widget.h
* @ingroup DeckEditorWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_CARD_ZONE_DISPLAY_WIDGET_H
#define DECK_CARD_ZONE_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/deck_preview_card_picture_widget.h
View file

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

2
cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_base/mana_base_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file mana_base_widget.h
* @ingroup DeckEditorAnalyticsWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef MANA_BASE_WIDGET_H
#define MANA_BASE_WIDGET_H

4
cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_curve/mana_curve_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file mana_curve_widget.h
* @ingroup DeckEditorAnalyticsWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef MANA_CURVE_WIDGET_H
#define MANA_CURVE_WIDGET_H
@ -37,7 +37,7 @@ public:
{
config = ManaCurveConfig::fromJson(o);
updateDisplay();
};
}
QJsonObject extractConfigFromDialog(QDialog *dlg) const override;

2
cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_devotion/mana_devotion_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file mana_devotion_widget.h
* @ingroup DeckEditorAnalyticsWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef MANA_DEVOTION_WIDGET_H
#define MANA_DEVOTION_WIDGET_H

14
cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.cpp
View file

@ -531,7 +531,7 @@ void DeckEditorDeckDockWidget::changeSelectedCard(int changeBy)
// currentIndex will return an index for the underlying deckModel instead of the proxy.
// That index will return an invalid index when indexBelow/indexAbove crosses a header node,
// causing the selection to fail to move down.
/// \todo Figure out why it's happening so we can do a proper fix instead of a hacky workaround
//! \todo Figure out why it's happening so we can do a proper fix instead of a hacky workaround.
if (deckViewCurrentIndex.model() == proxy->sourceModel()) {
deckViewCurrentIndex = proxy->mapFromSource(deckViewCurrentIndex);
}
@ -635,8 +635,8 @@ void DeckEditorDeckDockWidget::actSwapSelection()
{
auto selectedRows = getSelectedCardNodeSourceIndices();
// hack to maintain the old reselection behavior when currently selected row of a single-selection gets deleted
// TODO: remove the hack and also handle reselection when all rows of a multi-selection gets deleted
//! \todo Remove the hack and also handle reselection when all rows of a multi-selection gets deleted.
// Hack: maintains old reselection behavior when single-selection row is deleted.
if (selectedRows.length() == 1) {
deckView->setSelectionMode(QAbstractItemView::SingleSelection);
}
@ -666,8 +666,8 @@ void DeckEditorDeckDockWidget::actDecrementSelection()
{
auto selectedRows = getSelectedCardNodeSourceIndices();
// hack to maintain the old reselection behavior when currently selected row of a single-selection gets deleted
// TODO: remove the hack and also handle reselection when all rows of a multi-selection gets deleted
//! \todo Remove the hack and also handle reselection when all rows of a multi-selection gets deleted.
// Hack: maintains old reselection behavior when single-selection row is deleted.
if (selectedRows.length() == 1) {
deckView->setSelectionMode(QAbstractItemView::SingleSelection);
}
@ -683,8 +683,8 @@ void DeckEditorDeckDockWidget::actRemoveCard()
{
auto selectedRows = getSelectedCardNodeSourceIndices();
// hack to maintain the old reselection behavior when currently selected row of a single-selection gets deleted
// TODO: remove the hack and also handle reselection when all rows of a multi-selection gets deleted
//! \todo Remove the hack and also handle reselection when all rows of a multi-selection gets deleted.
// Hack: maintains old reselection behavior when single-selection row is deleted.
if (selectedRows.length() == 1) {
deckView->setSelectionMode(QAbstractItemView::SingleSelection);
}

8
cockatrice/src/interface/widgets/deck_editor/deck_state_manager.h
View file

@ -154,9 +154,11 @@ public:
*/
QModelIndex modifyDeck(const QString &reason, const std::function<QModelIndex(DeckListModel *)> &operation);
/// @name Metadata setters
/// @brief These methods set the metadata. Will no-op if the new value is the same as the current value.
/// Saves the operation to history if successful.
/**
* @name Metadata setters
* @brief These methods set the metadata. Will no-op if the new value is the same as the current value.
* Saves the operation to history if successful.
*/
///@{
void setName(const QString &name);
void setComments(const QString &comments);

2
cockatrice/src/interface/widgets/dialogs/dlg_connect.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_convert_deck_to_cod_format.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_create_game.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_default_tags_editor.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_edit_avatar.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_edit_password.cpp
View file

@ -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;

2
cockatrice/src/interface/widgets/dialogs/dlg_edit_password.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_edit_tokens.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_edit_user.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_filter_games.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_challenge.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_request.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.cpp
View file

@ -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;

2
cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_load_deck.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_clipboard.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_website.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_load_remote_deck.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_manage_sets.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_register.cpp
View file

@ -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;

2
cockatrice/src/interface/widgets/dialogs/dlg_register.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_select_set_for_cards.h
View file

@ -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

4
cockatrice/src/interface/widgets/dialogs/dlg_settings.cpp
View file

@ -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?"),

2
cockatrice/src/interface/widgets/dialogs/dlg_settings.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_startup_card_check.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_tip_of_the_day.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_update.cpp
View file

@ -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);

2
cockatrice/src/interface/widgets/dialogs/dlg_update.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/dlg_view_log.h
View file

@ -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

2
cockatrice/src/interface/widgets/dialogs/tip_of_the_day.h
View file

@ -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

2
cockatrice/src/interface/widgets/general/background_sources.h
View file

@ -1,8 +1,8 @@
/**
* @file background_sources.h
* @ingroup UI
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_BACKGROUND_SOURCES_H
#define COCKATRICE_BACKGROUND_SOURCES_H

2
cockatrice/src/interface/widgets/general/display/banner_widget.h
View file

@ -3,8 +3,8 @@
* @ingroup Widgets
* @ingroup DeckEditorCardGroupWidgets
* @ingroup DeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef BANNER_WIDGET_H
#define BANNER_WIDGET_H

2
cockatrice/src/interface/widgets/general/display/charts/bars/bar_widget.h
View file

@ -2,8 +2,8 @@
* @file bar_widget.h
* @ingroup Widgets
* @ingroup DeckEditorAnalyticsWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef BAR_WIDGET_H
#define BAR_WIDGET_H

6
cockatrice/src/interface/widgets/general/display/charts/bars/color_bar.h
View file

@ -99,13 +99,13 @@ protected:
void mouseMoveEvent(QMouseEvent *event) override;
private:
/// Map of color keys to counts used for rendering.
/** @brief Map of color keys to counts used for rendering. */
QList<QPair<QString, int>> colors;
/// True if the mouse is currently inside the widget.
/** @brief True if the mouse is currently inside the widget. */
bool isHovered = false;
/// Minimum ratio a segment must exceed to be drawn.
/** @brief Minimum ratio a segment must exceed to be drawn. */
double minRatioThreshold = 0.0;
/**

2
cockatrice/src/interface/widgets/general/display/charts/bars/percent_bar_widget.h
View file

@ -2,8 +2,8 @@
* @file percent_bar_widget.h
* @ingroup Widgets
* @ingroup DeckEditorAnalyticsWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PERCENT_BAR_WIDGET_H
#define PERCENT_BAR_WIDGET_H

2
cockatrice/src/interface/widgets/general/display/dynamic_font_size_label.h
View file

@ -1,8 +1,8 @@
/**
* @file dynamic_font_size_label.h
* @ingroup Widgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DYNAMICFONTSIZELABEL_H
#define DYNAMICFONTSIZELABEL_H

2
cockatrice/src/interface/widgets/general/display/dynamic_font_size_push_button.h
View file

@ -1,8 +1,8 @@
/**
* @file dynamic_font_size_push_button.h
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DYNAMICFONTSIZEPUSHBUTTON_H
#define DYNAMICFONTSIZEPUSHBUTTON_H

2
cockatrice/src/interface/widgets/general/display/labeled_input.h
View file

@ -1,8 +1,8 @@
/**
* @file labeled_input.h
* @ingroup DeckEditorCardGroupWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef LABELED_INPUT_H
#define LABELED_INPUT_H

2
cockatrice/src/interface/widgets/general/display/shadow_background_label.h
View file

@ -1,8 +1,8 @@
/**
* @file shadow_background_label.h
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef STYLEDLABEL_H
#define STYLEDLABEL_H

2
cockatrice/src/interface/widgets/general/home_styled_button.h
View file

@ -1,8 +1,8 @@
/**
* @file home_styled_button.h
* @ingroup Widgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef HOME_STYLED_BUTTON_H
#define HOME_STYLED_BUTTON_H

2
cockatrice/src/interface/widgets/general/home_widget.h
View file

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

1
cockatrice/src/interface/widgets/general/layout_containers/flow_widget.h
View file

@ -3,6 +3,7 @@
* @ingroup UI
* @brief A QWidget that wraps a FlowLayout inside an optional QScrollArea.
*/
//! \todo Document this file.
#ifndef FLOW_WIDGET_H
#define FLOW_WIDGET_H

2
cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.cpp
View file

@ -33,7 +33,7 @@ OverlapControlWidget::OverlapControlWidget(int overlapPercentage,
layout->addWidget(overlap_percentage_input);
layout->addWidget(overlap_direction);
// TODO probably connect this to the parent
//! \todo Probably connect this to the parent.
// connect(card_size_slider, &QSlider::valueChanged, display, &CardPicture::setScaleFactor);
}

2
cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file overlap_control_widget.h
* @ingroup UI
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef OVERLAP_CONTROL_WIDGET_H
#define OVERLAP_CONTROL_WIDGET_H

2
cockatrice/src/interface/widgets/general/layout_containers/overlap_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file overlap_widget.h
* @ingroup UI
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef OVERLAP_WIDGET_H
#define OVERLAP_WIDGET_H

2
cockatrice/src/interface/widgets/menus/deck_editor_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file deck_editor_menu.h
* @ingroup DeckEditors
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_EDITOR_MENU_H
#define DECK_EDITOR_MENU_H

2
cockatrice/src/interface/widgets/menus/tearoff_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file tearoff_menu.h
* @ingroup GameMenus
* @brief TODO: Document this.
*/
//! \todo Document this file.
#pragma once

2
cockatrice/src/interface/widgets/printing_selector/all_zones_card_amount_widget.h
View file

@ -2,8 +2,8 @@
* @file all_zones_card_amount_widget.h
* @ingroup CardExtraInfoWidgets
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef ALL_ZONES_CARD_AMOUNT_WIDGET_H
#define ALL_ZONES_CARD_AMOUNT_WIDGET_H

2
cockatrice/src/interface/widgets/printing_selector/card_amount_widget.h
View file

@ -2,8 +2,8 @@
* @file card_amount_widget.h
* @ingroup CardExtraInfoWidgets
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_AMOUNT_WIDGET_H
#define CARD_AMOUNT_WIDGET_H

2
cockatrice/src/interface/widgets/printing_selector/printing_selector.h
View file

@ -1,8 +1,8 @@
/**
* @file printing_selector.h
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PRINTING_SELECTOR_H
#define PRINTING_SELECTOR_H

2
cockatrice/src/interface/widgets/printing_selector/printing_selector_card_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file printing_selector_card_display_widget.h
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PRINTING_SELECTOR_CARD_DISPLAY_WIDGET_H
#define PRINTING_SELECTOR_CARD_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/printing_selector/printing_selector_card_overlay_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file printing_selector_card_overlay_widget.h
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PRINTING_SELECTOR_CARD_OVERLAY_WIDGET_H
#define PRINTING_SELECTOR_CARD_OVERLAY_WIDGET_H

2
cockatrice/src/interface/widgets/printing_selector/printing_selector_card_search_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file printing_selector_card_search_widget.h
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PRINTING_SELECTOR_CARD_SEARCH_WIDGET_H
#define PRINTING_SELECTOR_CARD_SEARCH_WIDGET_H

2
cockatrice/src/interface/widgets/printing_selector/printing_selector_card_selection_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file printing_selector_card_selection_widget.h
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PRINTING_SELECTOR_CARD_SELECTION_WIDGET_H
#define PRINTING_SELECTOR_CARD_SELECTION_WIDGET_H

2
cockatrice/src/interface/widgets/printing_selector/printing_selector_card_sorting_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file printing_selector_card_sorting_widget.h
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PRINTING_SELECTOR_CARD_SORTING_WIDGET_H
#define PRINTING_SELECTOR_CARD_SORTING_WIDGET_H

2
cockatrice/src/interface/widgets/printing_selector/set_name_and_collectors_number_display_widget.h
View file

@ -2,8 +2,8 @@
* @file set_name_and_collectors_number_display_widget.h
* @ingroup CardExtraInfoWidgets
* @ingroup PrintingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef SET_NAME_AND_COLLECTORS_NUMBER_DISPLAY_WIDGET_H
#define SET_NAME_AND_COLLECTORS_NUMBER_DISPLAY_WIDGET_H

4
cockatrice/src/interface/widgets/quick_settings/settings_button_widget.h
View file

@ -2,8 +2,8 @@
* @file settings_button_widget.h
* @ingroup Widgets
* @ingroup Settings
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef SETTINGS_BUTTON_WIDGET_H
#define SETTINGS_BUTTON_WIDGET_H
@ -27,7 +27,7 @@ public:
bool isCompact() const
{
return compact;
};
}
protected:
void mousePressEvent(QMouseEvent *event) override;

2
cockatrice/src/interface/widgets/quick_settings/settings_popup_widget.h
View file

@ -2,8 +2,8 @@
* @file settings_popup_widget.h
* @ingroup Widgets
* @ingroup Settings
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef SETTINGS_POPUP_WIDGET_H
#define SETTINGS_POPUP_WIDGET_H

2
cockatrice/src/interface/widgets/replay/replay_manager.h
View file

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

10
cockatrice/src/interface/widgets/replay/replay_timeline_widget.cpp
View file

@ -103,8 +103,12 @@ void ReplayTimelineWidget::skipToTime(int newTime, bool doRewindBuffering)
update();
}
/// @param doRewindBuffering When true, if multiple backward skips are made in quick succession, only a single rewind
/// is processed at the end. When false, the backwards skip will always cause an immediate rewind
/**
* @brief Handles a backwards skip in the replay timeline.
*
* @param doRewindBuffering When true, if multiple backward skips are made in quick succession, only a single rewind
* is processed at the end. When false, the backwards skip will always cause an immediate rewind.
*/
void ReplayTimelineWidget::handleBackwardsSkip(bool doRewindBuffering)
{
if (doRewindBuffering) {
@ -151,7 +155,7 @@ void ReplayTimelineWidget::replayTimerTimeout()
}
}
/// Processes all unprocessed events up to the current time.
/** @brief Processes all unprocessed events up to the current time. */
void ReplayTimelineWidget::processNewEvents(PlaybackMode playbackMode)
{
currentProcessedTime = currentVisualTime;

2
cockatrice/src/interface/widgets/replay/replay_timeline_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file replay_timeline_widget.h
* @ingroup Replay
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef REPLAY_TIMELINE_WIDGET
#define REPLAY_TIMELINE_WIDGET

6
cockatrice/src/interface/widgets/server/chat_view/chat_view.cpp
View file

@ -261,7 +261,8 @@ void ChatView::appendMessage(QString message,
defaultFormat = QTextCharFormat();
if (!isUserMessage) {
if (messageType == Event_RoomSay::ChatHistory) {
defaultFormat.setForeground(Qt::gray); //! \todo hardcoded color
//! \todo Remove hardcoded color.
defaultFormat.setForeground(Qt::gray);
defaultFormat.setFontWeight(QFont::Light);
defaultFormat.setFontItalic(true);
static const QRegularExpression userNameRegex("^(\\[[^\\]]*\\]\\s)(\\S+):\\s");
@ -284,7 +285,8 @@ void ChatView::appendMessage(QString message,
message.remove(0, pos.relativePosition - 2); // do not remove semicolon
}
} else {
defaultFormat.setForeground(Qt::darkGreen); //! \todo hardcoded color
//! \todo Remove hardcoded color.
defaultFormat.setForeground(Qt::darkGreen);
defaultFormat.setFontWeight(QFont::Bold);
}
}

2
cockatrice/src/interface/widgets/server/chat_view/chat_view.h
View file

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

2
cockatrice/src/interface/widgets/server/handle_public_servers.h
View file

@ -1,8 +1,8 @@
/**
* @file handle_public_servers.h
* @ingroup Server
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_HANDLE_PUBLIC_SERVERS_H
#define COCKATRICE_HANDLE_PUBLIC_SERVERS_H

2
cockatrice/src/interface/widgets/server/remote/remote_decklist_tree_widget.h
View file

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

2
cockatrice/src/interface/widgets/server/remote/remote_replay_list_tree_widget.h
View file

@ -3,8 +3,8 @@
* @ingroup DeckStorageWidgets
* @ingroup Replays
* @ingroup NetworkingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef REMOTEREPLAYLIST_TREEWIDGET_H
#define REMOTEREPLAYLIST_TREEWIDGET_H

2
cockatrice/src/interface/widgets/server/user/user_context_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file user_context_menu.h
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef USER_CONTEXT_MENU_H
#define USER_CONTEXT_MENU_H

2
cockatrice/src/interface/widgets/server/user/user_info_box.h
View file

@ -1,8 +1,8 @@
/**
* @file user_info_box.h
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef USERINFOBOX_H
#define USERINFOBOX_H

2
cockatrice/src/interface/widgets/server/user/user_info_connection.h
View file

@ -1,8 +1,8 @@
/**
* @file user_info_connection.h
* @ingroup Client
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef USERCONNECTION_INFORMATION_H
#define USERCONNECTION_INFORMATION_H

Some files were not shown because too many files have changed in this diff Show more