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

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

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

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;
/**

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

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

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

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

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