[Docs] Add \rst to Doxygen syntax

Allows writing verbatim reST in C comments to be rendered in documentation. Stolen from https://breathe.readthedocs.io/en/latest/markups.html.
24minFan · Mar 21, 2020 · a079a97 · a079a97
1 parent 527bb35
commit a079a97
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/Documentation/Doxyfile b/Documentation/Doxyfile
@@ -11,3 +11,6 @@ WARN_NO_PARAMDOC = YES
 WARN_AS_ERROR = NO
 OPTIMIZE_OUTPUT_FOR_C = YES
 EXTRACT_STATIC = YES
+
+ALIASES = "rst=\verbatim embed:rst:leading-asterisk"
+ALIASES += "endrst=\endverbatim"
diff --git a/Documentation/howto-doc.rst b/Documentation/howto-doc.rst
@@ -167,6 +167,20 @@ Preferred Doxygen style
    a |~| coredump. Write an explanation, how the things go together and place
    the ``.. doxygenfunction::`` directives where aproppriate.
 
+3. You can use ``\rst`` and ``\endrst`` to write reST in Doxygen comments:
+
+   .. code-block:: c
+
+      /*!
+       * \brief An example function
+       *
+       * \rst
+       * .. note::
+       *
+       *    This works!
+       * \endrst
+       */
+
 Further reading
 ---------------