Standardize Doxygen documentation (#6885)

libcockatrice_card/libcockatrice/card/card_info_comparator.h

@@ -1,8 +1,8 @@
 /**
  * @file card_info_comparator.h
  * @ingroup Cards
- * @brief TODO: Document this.
  */
+//! \todo Document this file.
 
 #ifndef CARD_INFO_COMPARATOR_H
 #define CARD_INFO_COMPARATOR_H

libcockatrice_card/libcockatrice/card/database/card_database.h

@@ -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();
 
@@ -133,7 +133,7 @@ public:
     ICardSetPriorityController *getPriorityController()
     {
         return setPriorityController;
-    };
+    }
 
 public slots:
     /**

libcockatrice_card/libcockatrice/card/database/card_database_manager.h

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

libcockatrice_card/libcockatrice/card/game_specific_terms.h

@@ -1,8 +1,8 @@
 /**
  * @file game_specific_terms.h
  * @ingroup Cards
- * @brief TODO: Document this.
  */
+//! \todo Document this file.
 
 #ifndef GAME_SPECIFIC_TERMS_H
 #define GAME_SPECIFIC_TERMS_H

libcockatrice_card/libcockatrice/card/set/card_set.h

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

libcockatrice_card/libcockatrice/card/set/card_set_comparator.h

@@ -1,8 +1,8 @@
 /**
  * @file card_set_comparator.h
  * @ingroup CardSets
- * @brief TODO: Document this.
  */
+//! \todo Document this file.
 
 #ifndef SET_PRIORITY_COMPARATOR_H
 #define SET_PRIORITY_COMPARATOR_H