.. _file_arbitrary_common.h: File common.h ============= |exhale_lsh| :ref:`Parent directory ` (``arbitrary``) .. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS Provides various different types, typedefs, and functions used throughout. Definition (``arbitrary/common.h``) ----------------------------------- .. toctree:: :maxdepth: 1 program_listing_file_arbitrary_common.h.rst 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 :py:data:`~exhale.configs.DEFAULT_DOXYGEN_STDIN_BASE` for the definition and usage of this environment. .. note:: See the :py:func:`~exhale.parse.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: .. 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?") All using the ``.. code-block::`` environment: .. code-block:: rst 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 :ref:`using_intersphinx` guide for more information. | +--------------------------------------------------------------------------------------+ .. _intersphinx: http://www.sphinx-doc.org/en/stable/ext/intersphinx.html Included By ----------- - :ref:`file_arbitrary_BaseClass.h` Namespaces ---------- - :ref:`namespace_arbitrary` - :ref:`namespace_arbitrary__nested` - :ref:`namespace_arbitrary__second_nested` - :ref:`namespace_external` - :ref:`namespace_first` - :ref:`namespace_first__second` - :ref:`namespace_first__second__third` - :ref:`namespace_first__second__third__fourth` - :ref:`namespace_first__second__third__fourth__fifth` Classes ------- - :ref:`exhale_struct_structarbitrary_1_1arbitrary__struct` - :ref:`exhale_struct_structarbitrary_1_1zed__struct` - :ref:`exhale_struct_structfirst_1_1second_1_1third_1_1fourth_1_1fifth_1_1deeper__namespace__testing` - :ref:`exhale_struct_structfirst_1_1second_1_1third_1_1fourth_1_1fifth_1_1deeper__namespace__testing_1_1nested__struct` - :ref:`exhale_struct_structfirst_1_1second_1_1third_1_1only__namespace__testing` - :ref:`exhale_struct_structparams` - :ref:`exhale_class_classarbitrary_1_1second__nested_1_1NestingFirstLastChild` - :ref:`exhale_class_classarbitrary_1_1second__nested_1_1NestingLastChild` Enums ----- - :ref:`exhale_enum_common_8h_1aaaefe258eb51ae67529f4f61905faaea` Functions --------- - :ref:`exhale_function_namespacearbitrary_1a446fbc904da8fb6658bd225af99db8bd` - :ref:`exhale_function_common_8h_1a4518f92e3bbec5f012ef8fa00f783426` Defines ------- - :ref:`exhale_define_common_8h_1a577cd817cb71b655998cad4387cdaeba` - :ref:`exhale_define_common_8h_1a12bb24ea980ca8fb1f46b1992bc9c83a` Typedefs -------- - :ref:`exhale_typedef_namespacearbitrary_1_1second__nested_1a5fc279b36d01b7c1c74a7d7740fddac8` - :ref:`exhale_typedef_common_8h_1ac295d62d22554ae61bda468a948b2742` Unions ------ - :ref:`exhale_union_unionarbitrary_1_1NamespacedUnion` - :ref:`exhale_union_unionarbitrary_1_1nested_1_1NestedNamespacedUnion` - :ref:`exhale_union_unionparams_1_1U` - :ref:`exhale_union_unionSupremeUnion` Variables --------- - :ref:`exhale_variable_namespacearbitrary_1_1second__nested_1a45d7ac21b928d022ac24438117c366d6` - :ref:`exhale_variable_common_8h_1a8b3ff05f33a75ab3c4ecff8ba87c381d` - :ref:`exhale_variable_namespaceexternal_1aab497f79f3a402809c6d73325648f46f`