Standardize Doxygen documentation (#6885)

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

View file

@ -1,8 +1,8 @@
/**
* @file deck_preview_color_identity_filter_widget.h
* @ingroup VisualDeckPreviewWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_PREVIEW_COLOR_IDENTITY_FILTER_WIDGET_H
#define DECK_PREVIEW_COLOR_IDENTITY_FILTER_WIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file deck_preview_deck_tags_display_widget.h
* @ingroup VisualDeckPreviewWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_PREVIEW_DECK_TAGS_DISPLAY_WIDGET_H
#define DECK_PREVIEW_DECK_TAGS_DISPLAY_WIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file deck_preview_tag_addition_widget.h
* @ingroup VisualDeckPreviewWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_PREVIEW_TAG_ADDITION_WIDGET_H
#define DECK_PREVIEW_TAG_ADDITION_WIDGET_H

View file

@ -2,8 +2,8 @@
* @file deck_preview_tag_dialog.h
* @ingroup VisualDeckPreviewWidgets
* @ingroup Dialogs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_PREVIEW_TAG_DIALOG_H
#define DECK_PREVIEW_TAG_DIALOG_H

View file

@ -1,8 +1,8 @@
/**
* @file deck_preview_tag_display_widget.h
* @ingroup VisualDeckPreviewWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_PREVIEW_TAG_DISPLAY_WIDGET_H
#define DECK_PREVIEW_TAG_DISPLAY_WIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file deck_preview_tag_item_widget.h
* @ingroup VisualDeckPreviewWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_PREVIEW_TAG_ITEM_WIDGET_H
#define DECK_PREVIEW_TAG_ITEM_WIDGET_H

View file

@ -28,8 +28,8 @@ DeckPreviewWidget::DeckPreviewWidget(QWidget *_parent,
deckLoader = new DeckLoader(this);
connect(deckLoader, &DeckLoader::loadFinished, this, &DeckPreviewWidget::initializeUi);
/* TODO: We shouldn't update the tags on *every* deck load, since it's kinda expensive. We should instead count how
many deck loads have finished already and if we've loaded all decks and THEN load all the tags at once. */
//! \todo Batch tag refresh: count finished deck loads and refresh tags once all decks are loaded.
// Currently expensive: refreshes on each individual deck load instead of once at the end.
connect(deckLoader, &DeckLoader::loadFinished, visualDeckStorageWidget->tagFilterWidget,
&VisualDeckStorageTagFilterWidget::refreshTags);
deckLoader->loadFromFileAsync(filePath, DeckFileFormat::getFormatFromName(filePath), false);

View file

@ -1,8 +1,8 @@
/**
* @file deck_preview_widget.h
* @ingroup VisualDeckPreviewWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_PREVIEW_WIDGET_H
#define DECK_PREVIEW_WIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file visual_deck_storage_folder_display_widget.h
* @ingroup VisualDeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef VISUAL_DECK_STORAGE_FOLDER_DISPLAY_WIDGET_H
#define VISUAL_DECK_STORAGE_FOLDER_DISPLAY_WIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file visual_deck_storage_search_widget.h
* @ingroup VisualDeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef VISUAL_DECK_STORAGE_SEARCH_WIDGET_H
#define VISUAL_DECK_STORAGE_SEARCH_WIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file visual_deck_storage_sort_widget.h
* @ingroup VisualDeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef VISUAL_DECK_STORAGE_SORT_WIDGET_H
#define VISUAL_DECK_STORAGE_SORT_WIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file visual_deck_storage_tag_filter_widget.h
* @ingroup VisualDeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef VISUAL_DECK_STORAGE_TAG_FILTER_WIDGET_H
#define VISUAL_DECK_STORAGE_TAG_FILTER_WIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file visual_deck_storage_widget.h
* @ingroup VisualDeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef VISUAL_DECK_STORAGE_WIDGET_H
#define VISUAL_DECK_STORAGE_WIDGET_H