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,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 <cstdint>
#include <vector>
/** \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__