diff --git a/sbf-cpp/Archetypes.h b/sbf-cpp/Archetypes.h index 7238920..783a7fe 100644 --- a/sbf-cpp/Archetypes.h +++ b/sbf-cpp/Archetypes.h @@ -1,8 +1,19 @@ #ifndef ARCHETYPES_H__ #define ARCHETYPES_H__ +/*************************************************************************************** +* @file Archetypes.h +* +* @brief Defines constants and functions for working with archetypes. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Archetypes + * @{ +*/ namespace SBF { const int kArchetypeArchitectId = 1; const std::string kArchetypeArchitectLabel = "Architect"; @@ -99,7 +110,14 @@ namespace SBF { kArchetypeVisionaryLabel, }; + /// @brief Gets the label for the given archetype id. + /// @param archetypeId The id of the archetype to get the label for. + /// @return The label for the requested archetype. std::string GetArchetypeLabel(int archetypeId); + + /// @brief Fills the provided vector with all of the archetype labels. It clears the vector before filling. + /// @param archetypeLabels The vector to fill. void FillArchetypeLabels(std::vector& archetypeLabels); } // End namespace SBF +/** @}*/ #endif // End !defined ARCHETYPES_H__ diff --git a/sbf-cpp/Attributes.h b/sbf-cpp/Attributes.h index 55d5469..5e16ff1 100644 --- a/sbf-cpp/Attributes.h +++ b/sbf-cpp/Attributes.h @@ -1,8 +1,19 @@ #ifndef ATTRIBUTES_H__ #define ATTRIBUTES_H__ +/*************************************************************************************** +* @file Attributes.h +* +* @brief Defines constants and functions for working with attribute groups and attriubtes. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Attributes + * @{ +*/ namespace SBF { const int kPhysicalAttributeStrengthId = 1; const std::string kPhysicalAttributeStrengthLabel = "Strength"; @@ -87,8 +98,21 @@ namespace SBF { kAttributeGroupMentalLabel, }; + /// @brief Gets the label for the attribute group with the specified id. + /// @param attributeGroupId The id of the attribute group to return the label for. + /// @return The label of the specified attribute group. std::string GetAttributeGroupLabel(int attributeGroupId); + + /// @brief Gets the label for the attribute with the specified group id an attribute id. + /// @param attributeGroupId The id of the attribute group to return the label for. + /// @param attributeId The id of the attribute withing the group to return the label for. + /// @return The label of the specified attribute. std::string GetAttributeLabel(int attributeGroupId, int attributeId); + + /// @brief + /// @param attributeGroupId + /// @param attributeId + /// @return std::string GetAttributeLabelAbbreviation(int attributeGroupId, int attributeId); std::string GetPhysicalAttributeLabel(int attributeId); std::string GetPhysicalAttributeLabelAbbreviation(int attributeId); @@ -103,4 +127,5 @@ namespace SBF { void FillSocialAttributeLabels(std::vector& socialAttributeLabels); void FillMentalAttributeLabels(std::vector& mentalAttributeLabels); } // End namespace SBF +/** @}*/ #endif // End !defined ATTRIBUTES_H__ diff --git a/sbf-cpp/Backgrounds.h b/sbf-cpp/Backgrounds.h index 6363731..c4329d0 100644 --- a/sbf-cpp/Backgrounds.h +++ b/sbf-cpp/Backgrounds.h @@ -1,8 +1,19 @@ #ifndef BACKGROUNDS_H__ #define BACKGROUNDS_H__ +/*************************************************************************************** +* @file Backgrounds.h +* +* @brief Defines constants and funcions for working with backgrounds. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Backgrounds + * @{ +*/ namespace SBF { const int kBackgroundPoints = 5; const int kBackgroundAlliesId = 1; @@ -42,4 +53,5 @@ namespace SBF { std::string GetBackgroundLabel(int backgroundId); void FillBackgroundLabels(std::vector& backgroundLabels); } // End namespace SBF +/** @}*/ #endif // End !defined BACKGROUNDS_H__ diff --git a/sbf-cpp/Character.h b/sbf-cpp/Character.h index 2727a2c..b18db5b 100644 --- a/sbf-cpp/Character.h +++ b/sbf-cpp/Character.h @@ -1,5 +1,13 @@ #ifndef CHARACTER_H__ #define CHARACTER_H__ +/*************************************************************************************** +* @file Character.h +* +* @brief Defines CharacterType. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include "Colors.h" #include "Ranks.h" #include "Clans.h" @@ -13,6 +21,9 @@ #include #include +/** \addtogroup Character + * @{ +*/ namespace SBF { int GetDisciplinePoints(); int GetVirtuePoints(); @@ -151,4 +162,5 @@ namespace SBF { int background_status; }; // End class CharacterType } // End namespace SBF +/** @}*/ #endif // !defined CHARACTER_H__ diff --git a/sbf-cpp/Clans.h b/sbf-cpp/Clans.h index d1dbc3c..65853f4 100644 --- a/sbf-cpp/Clans.h +++ b/sbf-cpp/Clans.h @@ -1,8 +1,19 @@ #ifndef CLANS_H__ #define CLANS_H__ +/*************************************************************************************** +* @file Clans.h +* +* @brief Defines constants and functions for working with clans. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Clans + * @{ +*/ namespace SBF { const int kClanAnarch = 1; const std::string kClanAnarchLabel = "Anarch"; @@ -65,4 +76,5 @@ namespace SBF { std::string GetClanLabel(int clanId); void FillClanLabels(std::vector& clans); } // End namespace SBF +/** @}*/ #endif // End !defined CLANS_H__ diff --git a/sbf-cpp/Colors.h b/sbf-cpp/Colors.h index e128a4e..063610a 100644 --- a/sbf-cpp/Colors.h +++ b/sbf-cpp/Colors.h @@ -1,8 +1,19 @@ #ifndef COLORS_H__ #define COLORS_H__ +/*************************************************************************************** +* @file Colors.h +* +* @brief Defines constants and functions for working with screen colors. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Abilities + * @{ +*/ namespace SBF { const uint8_t kColorDarkBlack = 0; const uint8_t kColorDarkBlue = 1; @@ -30,4 +41,5 @@ namespace SBF { void FillColors(std::vector colors); } // End namespace SBF +/** @}*/ #endif // End !defined COLORS_H__ diff --git a/sbf-cpp/Derangements.h b/sbf-cpp/Derangements.h index 668b71a..5189956 100644 --- a/sbf-cpp/Derangements.h +++ b/sbf-cpp/Derangements.h @@ -1,9 +1,20 @@ #ifndef DERANGEMENTS_H__ #define DERANGEMENTS_H__ #include "Colors.h" +/*************************************************************************************** +* @file Derangements.h +* +* @brief Defines constants and functions for working with derangements. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Derangements + * @{ +*/ namespace SBF { struct DerangementType { int id; @@ -173,4 +184,5 @@ namespace SBF { const DerangementType& GetDerangement(int derangementId); void FillDerangements(std::vector derangements); } // End namespace SBF +/** @}*/ #endif // End !defined DERANGEMENTS_H__ diff --git a/sbf-cpp/Disciplines.h b/sbf-cpp/Disciplines.h index 5fd76e3..d26a924 100644 --- a/sbf-cpp/Disciplines.h +++ b/sbf-cpp/Disciplines.h @@ -1,8 +1,20 @@ #ifndef DISCIPLINES_H__ #define DISCIPLINES_H__ +/*************************************************************************************** +* @file Disciplines.h +* +* @brief Defines constants and functions for working with disciplines. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ + #include #include +/** \addtogroup Disciplines + * @{ +*/ namespace SBF { const int kDisciplinePoints = 3; const int kDisciplineAnimalismId = 1; @@ -84,4 +96,5 @@ namespace SBF { const std::string GetDisciplineLabel(int disciplineId); void FillDisciplineLabels(std::vector disciplineLabels); } // End namespace SBF +/** @}*/ #endif // End !defined DISCIPLINES_H__ diff --git a/sbf-cpp/Genders.h b/sbf-cpp/Genders.h index 464dedb..d69ab1f 100644 --- a/sbf-cpp/Genders.h +++ b/sbf-cpp/Genders.h @@ -1,8 +1,19 @@ #ifndef GENDERS_H__ #define GENDERS_H__ +/*************************************************************************************** +* @file Genders.h +* +* @brief Defines constants and functions for working with genders. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Genders + * @{ +*/ namespace SBF { const int kGenderMaleId = 1; const std::string kGenderMaleLabel = "Male"; @@ -26,4 +37,5 @@ namespace SBF { const std::string& GetGenderLabel(int genderId); void FillGenderLabels(std::vector genderLabels); } // End namespace SBF +/** @}*/ #endif // End !defined GENDERS_H__ diff --git a/sbf-cpp/Menus.h b/sbf-cpp/Menus.h index 5adb54a..9e73854 100644 --- a/sbf-cpp/Menus.h +++ b/sbf-cpp/Menus.h @@ -1,5 +1,14 @@ #ifndef MENUS_H__ #define MENUS_H__ +/*************************************************************************************** +* @file Menus.h +* +* @brief Defines constants and functions for working with menus. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ + namespace SBF { struct MenuStyle; struct MenuItem; @@ -8,6 +17,9 @@ namespace SBF { #include #include +/** \addtogroup Menus + * @{ + */ namespace SBF { using std::string; @@ -47,5 +59,5 @@ namespace SBF { void NewMenuItemWithColor(MenuItem& item, string label, int id, uint8_t color); } // End namespace SBF - +/** @}*/ #endif // !defined MENUS_H__ diff --git a/sbf-cpp/Ranks.h b/sbf-cpp/Ranks.h index 2d02c9c..ede6b21 100644 --- a/sbf-cpp/Ranks.h +++ b/sbf-cpp/Ranks.h @@ -1,8 +1,19 @@ #ifndef RANKS_H__ #define RANKS_H__ +/*************************************************************************************** +* @file Ranks.h +* +* @brief Defines constants and functions for working with ranks. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup + * @{ +*/ namespace SBF { const int kRankPrimaryId = 1; const std::string kRankPrimaryLabel = "Primary"; @@ -24,4 +35,5 @@ namespace SBF { const RankType& GetRank(int rankId); void FillRanks(std::vector ranks); } // End namespace SBF +/** @}*/ #endif // !defined RANKS_H__ diff --git a/sbf-cpp/Utils.h b/sbf-cpp/Utils.h index 2d91733..5592677 100644 --- a/sbf-cpp/Utils.h +++ b/sbf-cpp/Utils.h @@ -1,7 +1,18 @@ #ifndef UTILS_H__ #define UTILS_H__ +/*************************************************************************************** +* @file Utils.h +* +* @brief Defines various utility functions. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include +/** \addtogroup Utils + * @{ +*/ namespace SBF { using std::string; @@ -13,4 +24,5 @@ namespace SBF { string string_dollar(size_t length, char ch); } // End namespace SBF +/** @}*/ #endif // End !defined UTILS_H__ diff --git a/sbf-cpp/Virtues.h b/sbf-cpp/Virtues.h index 5f306d2..eae6121 100644 --- a/sbf-cpp/Virtues.h +++ b/sbf-cpp/Virtues.h @@ -1,8 +1,19 @@ #ifndef VIRTUES_H__ #define VIRTUES_H__ +/*************************************************************************************** +* @file Virtues.h +* +* @brief Defines constants and functions for working with virtues. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Virtues + * @{ +*/ namespace SBF { const int kVirtuePoints = 7; const int kVirtueSelfControlId = 1; @@ -21,4 +32,5 @@ namespace SBF { const std::string GetVirtueLabel(int virtueId); void FillVirtueLabels(std::vector virtueLabels); } // End namespace SBF +/** @}*/ #endif // End !defined VIRTUES_H__ diff --git a/sbf-cpp/main.h b/sbf-cpp/main.h index e69de29..b342754 100644 --- a/sbf-cpp/main.h +++ b/sbf-cpp/main.h @@ -0,0 +1,19 @@ +#ifndef MAIN_H__ +#define MAIN_H__ +/*************************************************************************************** +* @file main.h +* +* @brief Defines stuff for the main app. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ + +/** \addtogroup Unsorted + * @{ +*/ +namespace SBF { + +} +/** @}*/ +#endif \ No newline at end of file diff --git a/sbf-cpp/sbf.h b/sbf-cpp/sbf.h index b7506e7..5373ec4 100644 --- a/sbf-cpp/sbf.h +++ b/sbf-cpp/sbf.h @@ -1,8 +1,21 @@ +#ifndef SBF_H__ +#define SBF_H__ +/*************************************************************************************** +* @file sbf.h +* +* @brief Holds code copied from the BASIC version that hasn't been relocated yet. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include "Colors.h" #include "Menus.h" #include "Character.h" #include +/** \addtogroup Unsorted + * @{ +*/ namespace SBF { using std::string; @@ -809,3 +822,5 @@ End Sub */ } // End namespace SBF +/** #}*/ +#endif // End !defined SBF_H__ diff --git a/sbf-cpp/test.h b/sbf-cpp/test.h index 3c8b2ad..c6b032c 100644 --- a/sbf-cpp/test.h +++ b/sbf-cpp/test.h @@ -1,5 +1,14 @@ #ifndef TEST_H__ #define TEST_H__ +/*************************************************************************************** +* @file test.h +* +* @brief Defines structs and functions for implementing TinyTest. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ + #include #include #include