Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thorstink committed Sep 5, 2024
1 parent 05c5fac commit df8be5a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -2289,7 +2289,7 @@ ENABLE_PREPROCESSING = YES
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

MACRO_EXPANSION = NO
MACRO_EXPANSION = YES

# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
Expand Down Expand Up @@ -2330,7 +2330,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED =
PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
8 changes: 6 additions & 2 deletions symmetri/include/symmetri/colors.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
#include <vector>
namespace symmetri {

#ifndef DOXYGEN_SHOULD_SKIP_THIS

// https://rodusek.com/posts/2021/03/09/getting-an-unmangled-type-name-at-compile-time/

template <std::size_t... Idxs>
Expand Down Expand Up @@ -89,10 +91,12 @@ constexpr auto unique_id() {
}
}

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

/**
* @brief Tokens are elements that can reside in places. Tokens can have a color
* which makes them distinguishable from other tokens. Tokens that have the same
* color are not distinguishable. Users can create their own tokens-colors by
* color are not distinguishable. Users can create their own token-colors by
* either using the CREATE_CUSTOM_TOKEN-macro (compile-time) or by calling
* Token's public constructor which takes a token-name.
*
Expand All @@ -108,7 +112,7 @@ class Token {
protected:
/**
* @brief Creates a Token with a unique numerical id and a string
* representation based on the name of the argument-type.
* representation based on the name of the argument-type at compile-time.
*
* @tparam T the type representing the token-color
*/
Expand Down

0 comments on commit df8be5a

Please sign in to comment.