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,7 +1,18 @@
#ifndef UTILS_H__
#define UTILS_H__
/***************************************************************************************
* @file Utils.h
*
* @brief Defines various utility functions.
* @copyright
* Copyright 2023 Tom Hicks
* Licensed under the MIT license see the LICENSE file for details.
***************************************************************************************/
#include <string>
/** \addtogroup Utils
* @{
*/
namespace SBF {
using std::string;
@@ -13,4 +24,5 @@ namespace SBF {
string string_dollar(size_t length, char ch);
} // End namespace SBF
/** @}*/
#endif // End !defined UTILS_H__