.. _namespace-example:

doxygennamespace Directive
==========================

This directive generates the appropriate output for the contents of a
namespace.

It takes the standard ``project``, ``path``, ``outline`` and ``no-link`` options
and additionally the ``content-only``, ``desc-only``, ``members``,
``protected-members``, ``private-members`` and ``undoc-members`` options.

``content-only``
   If this flag is specified, then the directive does not output the name of the
   namespace or the namespace description and instead outputs the contents of
   the namespace. This can be useful for structuring your documentation but
   leaving out the namespace declaration itself which is often undocumented.

``desc-only``
   If specified, only the description and name of the namespace will be
   displayed.

``members``
   If specified, the public members of any classes in the namespace output will be
   displayed. Unlike the ``doxygenclass`` ``members`` option, this does not
   optionally take a list of member names to display as this will be applied
   across multiple classes within the namespace.

``protected-members``
   If specified, the protected members of any classes in the namespace output will
   be displayed.

``private-members``
   If specified, the private members of any classes in the namespace output will be
   displayed.

``undoc-members``
   If specified, the undocumented members of any classes in the namespace output
   will be displayed provided the appropriate ``members`` or ``private-members``
   options are specified as well.

If you would like to always specify some combination of ``members``,
``protected-members``, ``private-members`` and ``undoc-members`` then you can
use the :ref:`breathe_default_members <breathe-default-members>` configuration
variable to set it in the ``conf.py``.

.. contents::


Basic Example
-------------

.. cpp:namespace:: @ex_namespace_basic

The plain ``doxygennamespace`` directive will output the namespace name and
description and any top level publicly visible members of the namespace.

.. code-block:: rst

   .. doxygennamespace:: foo
      :project: namespace

It produces this output:

.. doxygennamespace:: foo
   :project: namespace

Content-Only Example
--------------------

.. cpp:namespace:: @ex_namespace_content_only

The ``content-only`` option changes the output to only include the content of
the namespace and not the namespace name or description. So this:

.. code-block:: rst

   .. doxygennamespace:: foo
      :project: namespace
      :content-only:

Produces this output:

.. doxygennamespace:: foo
   :project: namespace
   :content-only:

.. note::

   As you can see from the output, section headings like 'Functions' are missing
   from the :content-only: display. This is due to an implementation detail. If
   post an issue on github if you'd like it addressed.


Members Example
---------------

.. cpp:namespace:: @ex_namespace_members

The ``members`` option changes the output to include the public members of any
classes. The output for any class in the namespace should be the same as if it had
be produced by the :ref:`doxygenclass directive <class-example>` with the
``members`` option specified.

::

   .. doxygennamespace:: foo
      :project: namespace
      :members:

It produces this output:

.. doxygennamespace:: foo
   :project: namespace
   :members:


Protected Members Example
-------------------------

.. cpp:namespace:: @ex_namespace_members_protected

The ``protected-members`` option changes the output to include the protected
members of any classes. The output for any class in the namespace should be the same
as if it had be produced by the :ref:`doxygenclass directive <class-example>`
with the ``protected-members`` option specified.

::

   .. doxygennamespace:: foo
      :project: namespace
      :protected-members:

It produces this output:

.. doxygennamespace:: foo
   :project: namespace
   :protected-members:


Private-Members Example
-----------------------

.. cpp:namespace:: @ex_namespace_members_private

The ``private-members`` option changes the output to include the private members
of any classes. The output for any class in the namespace should be the same as if
it had be produced by the :ref:`doxygenclass directive <class-example>` with the
``private-members`` option specified.

.. code-block:: rst

   .. doxygennamespace:: foo
      :project: namespace
      :private-members:

Produces this output:

.. doxygennamespace:: foo
   :project: namespace
   :private-members:


Undocumented Members Example
----------------------------

.. cpp:namespace:: @ex_namespace_members_undocumented

The ``undoc-members`` option changes the output to include any undocumentated
members from the sections (public, protected, private) that are being displayed
for the classes in the namespace output.

.. code-block:: rst

   .. doxygennamespace:: foo
      :project: namespace
      :private-members:
      :undoc-members:

Produces this output:

.. doxygennamespace:: foo
   :project: namespace
   :private-members:
   :undoc-members:

.. note::

   Undocumented classes are still not shown in the output due to an
   implementation issue. Please post an issue on github if you would like this
   resolved.


Outline Example
---------------

.. cpp:namespace:: @ex_namespace_outline

This displays only the names of the members of the namespace and not their
documentation. The other options determine which members are displayed.

.. code-block:: rst

   .. doxygennamespace:: foo
      :project: namespace
      :members:
      :outline:

It produces this output:

.. doxygennamespace:: foo
   :project: namespace
   :members:
   :outline:


Nested Example
--------------

.. cpp:namespace:: @ex_namespace_nested

The referenced namespace can be nested in another namespace.

.. code-block:: rst

   .. doxygennamespace:: foo::ns
      :project: namespace

Produces this output:

.. doxygennamespace:: foo::ns
   :project: namespace


Failing Example
---------------

.. cpp:namespace:: @ex_namespace_failing

This intentionally fails:

.. code-block:: rst

   .. doxygennamespace:: madeupnamespace
      :project: namespace

It produces the following warning message:

.. warning:: doxygennamespace: Cannot find namespace “madeupnamespace” in
             doxygen xml output for project “namespace” from directory:
             ../../examples/specific/namespacefile/xml/