File common.h

Parent directory (arbitrary)

Provides various different types, typedefs, and functions used throughout.

Definition (arbitrary/common.h)

Detailed Description

The brief file description is done using the \brief command from Doxygen. The current text you are using has “advanced” reStructuredText syntax such as grid tables and directives.

Tip

To document a file with directives or other “advanced” syntax, you will need to use the rst verbatim environment. See the description for DEFAULT_DOXYGEN_STDIN_BASE for the definition and usage of this environment.

Note

See the walk() function for details on what is / is not supported in terms of Doxygen documentation constructs for file level documentation. When in doubt, simply use rst / endrst and bypass Exhale’s “miniparser”.

I can have some C++ code shown:

throw std::runtime_error("Would you rather I segfault?")

Or some Python code:

raise RuntimeError("Would you rather I dereference None?")

All using the .. code-block:: environment:

I can have some C++ code shown:

.. code-block:: cpp

   throw std::runtime_error("Would you rather I segfault?")

Or some Python code:

.. code-block:: py

   raise RuntimeError("Would you rather I dereference None?")

And since grid tables are just so damn wonderful, we’ll do one just for kicks

Did you Know?

How is that possible?

You can link to other Sphinx docs!

Set it up in your conf.py:

  • intersphinx: 'sphinx.ext.intersphinx'

  • Specify: intersphinx_mapping.

Checkout the Using Intersphinx guide for more information.

Included By