[Doxygen] More extra-pages for cards/developer documentation and various fixes (#6316)

* Docu stash

Took 1 hour 53 minutes

Took 5 minutes


Took 16 seconds

Took 33 seconds

* Remove file headers.

Took 8 minutes

* Group to card set.

Took 8 seconds

* More extra pages.

Took 28 seconds

* Small fix for now.

Took 3 minutes

* Expand on picture loading.

Took 44 minutes

* Fix line break breaking link.

Took 2 minutes

* Images and user documentation.

Took 1 hour 49 minutes

* Update doc/doxygen-extra-pages/developer_documentation/primer_cards.md

Co-authored-by: RickyRister <42636155+RickyRister@users.noreply.github.com>

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
Co-authored-by: RickyRister <42636155+RickyRister@users.noreply.github.com>
This commit is contained in:
BruebachL
2025-11-15 13:07:15 +01:00
committed by GitHub
parent 1c1599a9f4
commit 28dfd62163
30 changed files with 580 additions and 31 deletions

View File

@@ -1,9 +1,3 @@
/**
* @file card_info.h
* @ingroup Cards
* @brief TODO: Document this.
*/
#ifndef CARD_INFO_H
#define CARD_INFO_H
@@ -54,6 +48,10 @@ class CardInfo : public QObject
Q_OBJECT
private:
/** @name Private Card Properties
* @anchor PrivateCardProperties
*/
///@{
CardInfoPtr smartThis; ///< Smart pointer to self for safe cross-references.
QString name; ///< Full name of the card.
QString simpleName; ///< Simplified name for fuzzy matching.
@@ -69,6 +67,7 @@ private:
bool landscapeOrientation; ///< Orientation flag for rendering.
int tableRow; ///< Row index in a table or visual representation.
bool upsideDownArt; ///< Whether artwork is flipped for visual purposes.
///@}
public:
/**

View File

@@ -1,10 +1,3 @@
/**
* @file card_database.h
* @ingroup CardDatabase
* @brief The CardDatabase is responsible for holding the card and set maps, managing card additions/removals,
* and providing access to sets and card querying via CardDatabaseQuerier.
*/
#ifndef CARDDATABASE_H
#define CARDDATABASE_H

View File

@@ -1,12 +1,3 @@
/**
* @file card_database_loader.h
* @ingroup CardDatabase
* @brief The CardDatabaseLoader is responsible for discovering, loading, and saving card databases from files on disk.
*
* This class interacts with available parsers to populate a CardDatabase instance. It also handles
* loading main, token, spoiler, and custom card databases.
*/
#ifndef COCKATRICE_CARD_DATABASE_LOADER_H
#define COCKATRICE_CARD_DATABASE_LOADER_H

View File

@@ -5,7 +5,7 @@
/**
* @class ExactCard
* @ingroup Cards
* @ingroup CardPrintings
*
* @brief Represents a specific card instance, defined by its CardInfo
* and a particular printing.

View File

@@ -14,7 +14,7 @@ using SetToPrintingsMap = QMap<QString, QList<PrintingInfo>>;
/**
* @class PrintingInfo
* @ingroup Cards
* @ingroup CardPrintings
*
* @brief Represents metadata for a specific variation of a card within a set.
*

View File

@@ -15,7 +15,7 @@ using CardSetPtr = QSharedPointer<CardSet>;
/**
* @class CardSet
* @ingroup Cards
* @ingroup CardSets
*
* @brief A collection of cards grouped under a common identifier.
*

View File

@@ -1,6 +1,6 @@
/**
* @file card_set_comparator.h
* @ingroup Cards
* @ingroup CardSets
* @brief TODO: Document this.
*/

View File

@@ -8,7 +8,7 @@
/**
* @class CardSetList
* @ingroup Cards
* @ingroup CardSets
*
* @brief A list-like container for CardSet objects with extended management methods.
*