jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-09-23 01:55:10 -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

22
cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_display_options_widget.h
View file

@ -104,37 +104,37 @@ private slots:
void updateDisplayType();
private:
/// Layout for grouping and sorting UI elements.
/** @brief Layout for grouping and sorting UI elements. */
QHBoxLayout *groupAndSortLayout;
/// Current deck display type.
/** @brief Current deck display type. */
DisplayType currentDisplayType = DisplayType::Overlap;
/// Button used to toggle the display layout.
/** @brief Button used to toggle the display layout. */
CompactPushButton *displayTypeButton;
/// Label for the group-by selector.
/** @brief Label for the group-by selector. */
QLabel *groupByLabel;
/// Combo box listing group-by criteria.
/** @brief Combo box listing group-by criteria. */
QComboBox *groupByComboBox;
/// Currently active group-by criterion.
/** @brief Currently active group-by criterion. */
QString activeGroupCriteria = "maintype";
/// Encapsulates the sort settings widgets (label + list).
/** @brief Encapsulates the sort settings widgets (label + list). */
SettingsButtonWidget *sortCriteriaButton;
/// Label for “Sort by”.
/** @brief Label for "Sort by". */
QLabel *sortByLabel;
/// Descriptive label inside the sort criteria button.
/** @brief Descriptive label inside the sort criteria button. */
QLabel *sortLabel;
/// Draggable list of sort criteria.
/** @brief Draggable list of sort criteria. */
QListWidget *sortByListWidget;
/// Ordered list of current sort criteria.
/** @brief Ordered list of current sort criteria. */
QStringList activeSortCriteria = {"name", "cmc", "colors", "maintype"};
};

2
cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_sample_hand_widget.h
View file

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

4
cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.cpp
View file

@ -418,7 +418,7 @@ void VisualDeckEditorWidget::onHover(const ExactCard &hoveredCard)
// If nothing is selected -> this is our "active/preview" card
emit activeCardChanged(hoveredCard);
// TODO: highlight hovered card visually:
//! \todo Highlight hovered card visually.
// highlightHoveredCard(hoveredCard);
}
@ -429,7 +429,7 @@ void VisualDeckEditorWidget::setSelectionModel(QItemSelectionModel *model)
}
if (selectionModel) {
// TODO: Possibly disconnect old ones?
//! \todo Possibly disconnect old signal connections.
}
selectionModel = model;

2
cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.h
View file

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