Skip to content
Snippets Groups Projects
Commit 35b6e2b0 authored by Timo Koch's avatar Timo Koch
Browse files

[doxygen] Introduce usage and module documentation groups

parent 18f21b81
No related branches found
No related tags found
1 merge request!3568[doc] Add handbook Chapter 2.3 parameters to doxygen
...@@ -13,19 +13,16 @@ SPDX-License-Identifier: GPL-3.0-or-later ...@@ -13,19 +13,16 @@ SPDX-License-Identifier: GPL-3.0-or-later
<!-- We manually create the navigation hierarchy of the pages --> <!-- We manually create the navigation hierarchy of the pages -->
<tab type="user" url="@ref installation" visible="yes" title="Installation" intro=""/> <tab type="user" url="@ref installation" visible="yes" title="Installation" intro=""/>
<tab type="user" url="@ref getting-started" visible="yes" title="Getting started" intro=""/> <tab type="user" url="@ref getting-started" visible="yes" title="Getting started" intro=""/>
<tab type="user" url="@ref runtime-parameters" visible="yes" title="Runtime Parameters" intro=""/>
<!-- This is how to create a hierarchy (can be removed once we have an example) -->
<!-- <tab type="usergroup" title="My Group">
<tab type="user" url="@ref mysubpage" title="My Page"/>
<tab type="user" url="@ref mysubpage2" title="My Page 2"/>
</tab> -->
<!-- The modules contains pages for each group and subpages for each subgroup --> <!-- The modules contains pages for each group and subpages for each subgroup -->
<!-- Note that extra documentation can be added to groups in separate markdown files --> <!-- Note that extra documentation can be added to groups in separate markdown files -->
<!-- For this write @addtogroup <groupname> at the top of that markdown page --> <!-- For this write @addtogroup <groupname> at the top of that markdown page -->
<tab type="user" url="@ref external-libraries" visible="yes" title="External libraries" intro=""/> <tab type="user" url="@ref external-libraries" visible="yes" title="External libraries" intro=""/>
<tab type="user" url="@ref examples-and-tutorials" visible="yes" title="Examples and tutorials" intro=""/> <tab type="user" url="@ref examples-and-tutorials" visible="yes" title="Examples and tutorials" intro=""/>
<tab type="modules" visible="yes" title="Module description" intro=""/> <tab type="usergroup" title="Usage documentation">
<tab type="user" url="@ref running-in-parallel" visible="yes" title="Running in parallel" intro=""/> <tab type="user" url="@ref runtime-parameters" visible="yes" title="Runtime Parameters" intro=""/>
<tab type="user" url="@ref running-in-parallel" visible="yes" title="Running in parallel" intro=""/>
</tab>
<tab type="modules" visible="yes" title="Module documentation" intro=""/>
<tab type="user" url="@ref python-bindings" visible="yes" title="Python bindings" intro=""/> <tab type="user" url="@ref python-bindings" visible="yes" title="Python bindings" intro=""/>
<tab type="user" url="@ref building-the-documentation" visible="yes" title="Build doxygen documentation" intro=""/> <tab type="user" url="@ref building-the-documentation" visible="yes" title="Build doxygen documentation" intro=""/>
<tab type="namespaces" visible="yes" title=""> <tab type="namespaces" visible="yes" title="">
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment