diff --git a/Documentation/Doxyfile b/Documentation/Doxyfile index 593371f5b8..df5333b6b6 100644 --- 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 index 1d211ff9b0..6a4132f173 100644 --- 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 ---------------