jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-06-17 12:37:46 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

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