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,9 +1,20 @@
#ifndef DERANGEMENTS_H__
#define DERANGEMENTS_H__
#include "Colors.h"
/***************************************************************************************
* @file Derangements.h
*
* @brief Defines constants and functions for working with derangements.
* @copyright
* Copyright 2023 Tom Hicks
* Licensed under the MIT license see the LICENSE file for details.
***************************************************************************************/
#include <string>
#include <vector>
/** \addtogroup Derangements
* @{
*/
namespace SBF {
struct DerangementType {
int id;
@@ -173,4 +184,5 @@ namespace SBF {
const DerangementType& GetDerangement(int derangementId);
void FillDerangements(std::vector<DerangementType> derangements);
} // End namespace SBF
/** @}*/
#endif // End !defined DERANGEMENTS_H__