Doxygen card_relation_type.h

Took 3 minutes
This commit is contained in:
Lukas Brübach 2025-11-10 07:22:39 +01:00
parent 43e04922cf
commit 9bb7be2e4e

View file

@ -4,7 +4,13 @@
#include <QString> #include <QString>
/** /**
* Represents how a card relates to another (attach, transform, etc.). * @enum CardRelationType
* @ingroup Cards
* @brief Types of attachments between cards.
*
* DoesNotAttach: No attachment is present.
* AttachTo: This card attaches to another card.
* TransformInto: This card transforms into another card.
*/ */
enum class CardRelationType enum class CardRelationType
{ {
@ -13,7 +19,7 @@ enum class CardRelationType
TransformInto = 2, TransformInto = 2,
}; };
// Optional helper // Helper function to transform the enum values into human-readable strings
inline QString cardAttachTypeToString(CardRelationType type) inline QString cardAttachTypeToString(CardRelationType type)
{ {
switch (type) { switch (type) {