Skip to content

Commit

Permalink
Update doxygenpage directive documentation
Browse files Browse the repository at this point in the history
Indicate support for the content-only option.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
  • Loading branch information
gmarull committed Feb 22, 2021
1 parent 2072d4c commit 418b974
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion documentation/source/directives.rst
Original file line number Diff line number Diff line change
Expand Up @@ -396,13 +396,15 @@ page. A doxygen page is created for each "key" of every \\xrefitem command used
for markup in the source comments. For more information check the
`doxygen xrefitem documentation`_.

It takes the standard ``project`` and ``path`` options.
It takes the standard ``project`` and ``path`` options and additionally the
``content-only`` option.

::

.. doxygenpage:: <page name>
:project: ...
:path: ...
:content-only:

Checkout the :ref:`doxygenpage documentation <page-example>` for more details
and to see it in action.
Expand Down

0 comments on commit 418b974

Please sign in to comment.