docs

Doxyfile

@@ -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
@@ -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

README.md

@@ -45,7 +45,7 @@ auto log = getLog(app); // get the event log
 - `net` is a multiset description of a Petri net
 - `initial` is the initial token distribution (also known as _initial marking_)
 - `goal` is the goal marking, the net terminates if this is reached
-- `task_system` is a simple SPMC-queue based based threadpool
+- `task_system` is a simple SPMC-queue based threadpool
 - `&foo` and `&bar` are user-supplied *Callbacks*
 - `app` is all the ingredients put together - creating something that can be *fired*! it outputs a result (`res`) and at all times an event log can be queried
 

symmetri/include/symmetri/colors.hpp

@@ -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>
@@ -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.
  *
@@ -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
    */