michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: doc-guidelines: document :project: option for doxygengroup

Browse source 
The doxygengroup now supports specifying a project, document this
feature.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2025-01-02 10:06:05 +01:00 • committed by Benjamin Cabé
commit 602290e838
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/contribute/documentation/guidelines.rst
View file

@ -1006,6 +1006,15 @@ Doxygen API documentation
.. doxygengroup:: can_interface .. doxygengroup:: can_interface
.. rubric:: Options
.. rst:directive:option:: project
:type: project name (optional)
Associated Doxygen project. This can be useful when multiple Doxygen
projects are configured.
.. rst:role:: c:group .. rst:role:: c:group
This role is used to reference a Doxygen group in the Zephyr tree. In the HTML documentation, This role is used to reference a Doxygen group in the Zephyr tree. In the HTML documentation,