Adds doxygen comments to SBF namespace.

Adds doxygen header to header files.
This commit is contained in:
2023-04-16 04:08:33 -07:00
parent 7c9c42b17c
commit 5501de76e2
16 changed files with 220 additions and 1 deletions

View File

@@ -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 <string>
#include <vector>
/** \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<std::string>& socialAttributeLabels);
void FillMentalAttributeLabels(std::vector<std::string>& mentalAttributeLabels);
} // End namespace SBF
/** @}*/
#endif // End !defined ATTRIBUTES_H__