Skip to content

Commit e8de998

Browse files
committed
Improve documentation.
1 parent 9ed31ab commit e8de998

File tree

7 files changed

+29
-1
lines changed

7 files changed

+29
-1
lines changed

include/constants.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424

2525
#include <string_view>
2626

27+
/**
28+
* @namespace steppable::constants
29+
* @brief Numerical constants used in Steppable.
30+
*/
2731
namespace steppable::constants
2832
{
2933
/// @brief 100 digits of pi.

include/exceptions.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232

3333
#include <exception>
3434

35+
/**
36+
* @namespace steppable::exceptions
37+
* @brief Contains Steppable exceptions.
38+
*/
3539
namespace steppable::exceptions
3640
{
3741
/**

include/format.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@
4343
#include <string>
4444
#include <vector>
4545

46+
/**
47+
* @namespace steppable::__internals::format
48+
* @brief Contains string formatting utilities.
49+
*/
4650
namespace steppable::__internals::format
4751
{
4852
// https://stackoverflow.com/a/49812356/14868780

include/output.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@
5151
#include <iostream>
5252
#include <string>
5353

54+
/**
55+
* @namespace steppable::output
56+
* @brief Message-printing utilities for Steppable.
57+
*/
5458
namespace steppable::output
5559
{
5660
using namespace steppable::__internals;

include/platform.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
#include <mutex>
3939

4040
/**
41-
* @namespace steppable::__internals::util
41+
* @namespace steppable::__internals::utils
4242
* @brief Namespace for internal functions
4343
* @note This namespace should not be used by other programs outside of the Steppable core.
4444
*/

include/testing.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ using namespace std::literals;
8383
return 1; \
8484
}
8585

86+
/**
87+
* @namespace steppable::testing
88+
* @brief Includes testing utilities for Steppable.
89+
*/
8690
namespace steppable::testing
8791
{
8892
/**

include/util.hpp

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,10 @@ namespace steppable::__internals::utils
187187
#endif
188188
} // namespace steppable::__internals::utils
189189

190+
/**
191+
* @namespace steppable::__internals::numUtils
192+
* @brief Utilities to operate numbers.
193+
*/
190194
namespace steppable::__internals::numUtils
191195
{
192196
/**
@@ -342,6 +346,10 @@ namespace steppable::__internals::numUtils
342346
bool isPowerOfTen(const std::string& number);
343347
} // namespace steppable::__internals::numUtils
344348

349+
/**
350+
* @namespace steppable::__internals::stringUtils
351+
* @brief Utilities to operate strings.
352+
*/
345353
namespace steppable::__internals::stringUtils
346354
{
347355
/**

0 commit comments

Comments
 (0)