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 BACKGROUNDS_H__
#define BACKGROUNDS_H__
/***************************************************************************************
* @file Backgrounds.h
*
* @brief Defines constants and funcions for working with backgrounds.
* @copyright
* Copyright 2023 Tom Hicks
* Licensed under the MIT license see the LICENSE file for details.
***************************************************************************************/
#include <string>
#include <vector>
/** \addtogroup Backgrounds
* @{
*/
namespace SBF {
const int kBackgroundPoints = 5;
const int kBackgroundAlliesId = 1;
@@ -42,4 +53,5 @@ namespace SBF {
std::string GetBackgroundLabel(int backgroundId);
void FillBackgroundLabels(std::vector<std::string>& backgroundLabels);
} // End namespace SBF
/** @}*/
#endif // End !defined BACKGROUNDS_H__