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,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 <string>
#include <vector>
/** \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<std::string> disciplineLabels);
} // End namespace SBF
/** @}*/
#endif // End !defined DISCIPLINES_H__