From 382aa14611389ebf141527aa51f6f8a7d388a465 Mon Sep 17 00:00:00 2001 From: Tom Hicks Date: Sun, 16 Apr 2023 03:01:18 -0700 Subject: [PATCH] Adds doxygen comments and MIT license comment to Abilities.h. --- sbf-cpp/Abilities.h | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/sbf-cpp/Abilities.h b/sbf-cpp/Abilities.h index d733e30..139a778 100644 --- a/sbf-cpp/Abilities.h +++ b/sbf-cpp/Abilities.h @@ -1,8 +1,20 @@ #ifndef ABILITIES_H__ #define ABILITIES_H__ +/*************************************************************************************** +* @file Abilities.h +* +* @brief Defines AbiiltyType, ability and ability group constants, and ability and +* ability group functions. +* @copyright +* Copyright 2023 Tom Hicks +* Licensed under the MIT license see the LICENSE file for details. +***************************************************************************************/ #include #include +/** \addtogroup Abilities + * @{ +*/ namespace SBF { const int kAbilityTalentsId = 1; const std::string kAbilityTalentsSingular = "Talent"; @@ -158,30 +170,30 @@ namespace SBF { /// @return True if left and right are not equal and false otherwise. bool operator!=(const AbilityType& left, const AbilityType& right); - /// @brief Fills the provided vector with all of the available ability groups. - /// @param abilities The vector to fill. It will be cleared before filling. + /// @brief Fills the provided vector with all of the available ability groups. It will be cleared before filling. + /// @param abilities The vector to fill. void FillAbilities(std::vector& abilities); - /// @brief Fills the provided vector with all of the ability labels in the specified group. - /// @param abilities The vector to fill. It will be cleared before filling. + /// @brief Fills the provided vector with all of the ability labels in the specified group. It will be cleared before filling. + /// @param abilities The vector to fill. /// @param abilityGroupId The id of the ability group to fill for. void FillAbilitiesForAbilityGroup(std::vector& abilities, int abilityGroupId); - /// @brief Fills the provided vector with all of the ability labels in the specified group. - /// @param labels The vector to fill. It will be cleared before filling. + /// @brief Fills the provided vector with all of the ability labels in the specified group. It will be cleared before filling. + /// @param labels The vector to fill. /// @param abilityGroupId The id of the ability group to fill for. void FillAbilityLabels(std::vector& labels, int abilityGroupId); - /// @brief Fills the provided vector with all of the knowledge labels. - /// @param knowledgeLabels The vector to fill. It will be cleared before filling. + /// @brief Fills the provided vector with all of the knowledge labels. It will be cleared before filling. + /// @param knowledgeLabels The vector to fill. void FillKnowledgeLabels(std::vector& knowledgeLabels); - /// @brief Fills the provided vector with all of the skill labels. - /// @param skillLabels The vector to fill. It will be cleared before filling. + /// @brief Fills the provided vector with all of the skill labels. It will be cleared before filling. + /// @param skillLabels The vector to fill. void FillSkillLabels(std::vector& skillLabels); - /// @brief Fills the provided vector with all of the talent labels. - /// @param talentLabels The vector to fill. It will be cleared before filling. + /// @brief Fills the provided vector with all of the talent labels. It will be cleared before filling. + /// @param talentLabels The vector to fill. void FillTalentLabels(std::vector& talentLabels); /// @brief Gets an ability group for a given id. @@ -215,4 +227,5 @@ namespace SBF { /// @return The label for the specific ability. const std::string GetTalentLabel(int talentId); } // End namespace SBF +/** @}*/ #endif // End !defined ABILITIES_H__