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 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 <string>
#include <vector>
/** \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<RankType> ranks);
} // End namespace SBF
/** @}*/
#endif // !defined RANKS_H__