-
-
Notifications
You must be signed in to change notification settings - Fork 201
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation page for doxygenpage directive
Add initial documentation with "doxygenpage" usage relying on previously added xrefsect examples. Signed-off-by: Fabio Utzig <[email protected]>
- Loading branch information
Showing
2 changed files
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,7 @@ Directives & Config Variables | |
file | ||
group | ||
autofile | ||
page | ||
|
||
.. contents:: Table of Contents | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
|
||
.. _page-example: | ||
|
||
doxygenpage Directive | ||
===================== | ||
|
||
This directive generates the appropriate output for the contents of a doxygen | ||
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 documentation`_. | ||
|
||
It takes the standard ``project`` and ``path`` options. | ||
|
||
:: | ||
|
||
.. doxygenpage:: <page name> | ||
:project: ... | ||
:path: ... | ||
|
||
Checkout the :ref:`doxygengroup documentation <page-example>` for more details | ||
and to see it in action. | ||
|
||
.. _doxygen documentation: https://www.doxygen.nl/manual/commands.html#cmdxrefitem | ||
|
||
.. contents:: | ||
|
||
|
||
Basic Example | ||
------------- | ||
|
||
.. cpp:namespace:: @ex_page_basic | ||
|
||
The plain ``doxygenpage`` directive will output the page name and description | ||
and any variable entries which were defined to be part of this page (with an | ||
\xrefitem usage). | ||
|
||
.. code-block:: rst | ||
.. doxygenpage:: xrefsample | ||
:project: xrefsect | ||
It produces this output: | ||
|
||
.. doxygenpage:: xrefsample | ||
:project: xrefsect | ||
|
||
|
||
Failing Example | ||
--------------- | ||
|
||
.. cpp:namespace:: @ex_page_failing | ||
|
||
This intentionally fails: | ||
|
||
.. code-block:: rst | ||
.. doxygengroup:: madeuppage | ||
:project: xrefsect | ||
It produces the following warning message: | ||
|
||
.. warning:: Cannot find file "madeuppage" in doxygen xml output for project | ||
"xrefsect" from directory: ../../examples/specific/xrefsect/xml/ |