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

Standardize Doxygen documentation style to @brief format

Browse source 
Convert leading triple-slash (///) comments to JavaDoc-style
    (/** @brief */) documentation blocks across game, deck list, and
    card library modules.

    - Leading /// comments → /** @brief ... */
    - Enum value comments → ///<
    - Trailing ///< member comments are unchanged
This commit is contained in:
DawnFire42 2026-05-13 12:56:22 -04:00
parent 0549892092
commit f361cd65e0
No known key found for this signature in database
GPG key ID: 24BB855EE2911B33
26 changed files with 207 additions and 177 deletions
Download patch file Download diff file Expand all files Collapse all files

16
libcockatrice_card/libcockatrice/card/database/card_database.h
View file

@ -30,27 +30,27 @@ class CardDatabase : public QObject
Q_OBJECT
protected:
/// Controller to determine set priority when choosing preferred printings.
/** @brief Controller to determine set priority when choosing preferred printings. */
ICardSetPriorityController *setPriorityController;
/// Cards indexed by exact name
/** @brief Cards indexed by exact name. */
CardNameMap cards;
/// Cards indexed by simplified name (normalized)
/** @brief Cards indexed by simplified name (normalized). */
CardNameMap simpleNameCards;
/// Sets indexed by short name
/** @brief Sets indexed by short name. */
SetNameMap sets;
FormatRulesNameMap formats;
/// Loader responsible for file discovery and parsing
/** @brief Loader responsible for file discovery and parsing. */
CardDatabaseLoader *loader;
/// Current load status of the database
/** @brief Current load status of the database. */
LoadStatus loadStatus;
/// Querier for higher-level card lookups
/** @brief Querier for higher-level card lookups. */
CardDatabaseQuerier *querier;
private:
@ -64,7 +64,7 @@ private:
*/
void refreshCachedReverseRelatedCards();
/// Mutexes for thread safety
/** @brief Mutexes for thread safety. */
QBasicMutex *clearDatabaseMutex = new QBasicMutex(), *addCardMutex = new QBasicMutex(),
*removeCardMutex = new QBasicMutex();

6
libcockatrice_card/libcockatrice/card/database/card_database_manager.h
View file

@ -67,13 +67,13 @@ private:
/** @brief Private destructor. */
~CardDatabaseManager() = default;
/// Static card preference provider pointer (default: Noop)
/** @brief Static card preference provider pointer (default: Noop). */
static ICardPreferenceProvider *cardPreferenceProvider;
/// Static path provider pointer (default: Noop)
/** @brief Static path provider pointer (default: Noop). */
static ICardDatabasePathProvider *pathProvider;
/// Static set priority controller pointer (default: Noop)
/** @brief Static set priority controller pointer (default: Noop). */
static ICardSetPriorityController *setPriorityController;
};

16
libcockatrice_card/libcockatrice/card/set/card_set.h
View file

@ -107,31 +107,31 @@ public:
*/
[[nodiscard]] QString getCorrectedShortName() const;
/// @return Short identifier of the set.
/** @return Short identifier of the set. */
[[nodiscard]] QString getShortName() const
{
return shortName;
}
/// @return Descriptive name of the set.
/** @return Descriptive name of the set. */
[[nodiscard]] QString getLongName() const
{
return longName;
}
/// @return Type/category string of the set.
/** @return Type/category string of the set. */
[[nodiscard]] QString getSetType() const
{
return setType;
}
/// @return Release date of the set.
/** @return Release date of the set. */
[[nodiscard]] QDate getReleaseDate() const
{
return releaseDate;
}
/// @return Priority level of the set.
/** @return Priority level of the set. */
[[nodiscard]] Priority getPriority() const
{
return priority;
@ -190,7 +190,7 @@ public:
enabled = _enabled;
}
/// @return The sort key assigned to this set.
/** @return The sort key assigned to this set. */
[[nodiscard]] int getSortKey() const
{
return sortKey;
@ -202,7 +202,7 @@ public:
*/
void setSortKey(unsigned int _sortKey);
/// @return True if the set is enabled.
/** @return True if the set is enabled. */
[[nodiscard]] bool getEnabled() const
{
return enabled;
@ -214,7 +214,7 @@ public:
*/
void setEnabled(bool _enabled);
/// @return True if the set is considered known.
/** @return True if the set is considered known. */
[[nodiscard]] bool getIsKnown() const
{
return isknown;