Skip to content

Commit 602290e

Browse files
gmarullkartben
authored andcommitted
doc: doc-guidelines: document :project: option for doxygengroup
The doxygengroup now supports specifying a project, document this feature. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent 9a1c378 commit 602290e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/contribute/documentation/guidelines.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1006,6 +1006,15 @@ Doxygen API documentation
10061006

10071007
.. doxygengroup:: can_interface
10081008

1009+
1010+
.. rubric:: Options
1011+
1012+
.. rst:directive:option:: project
1013+
:type: project name (optional)
1014+
1015+
Associated Doxygen project. This can be useful when multiple Doxygen
1016+
projects are configured.
1017+
10091018
.. rst:role:: c:group
10101019
10111020
This role is used to reference a Doxygen group in the Zephyr tree. In the HTML documentation,

0 commit comments

Comments
 (0)