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]>
zephyrproject-rtos · Jan 8, 2025 · 602290e · 602290e
1 parent 9a1c378
commit 602290e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc/contribute/documentation/guidelines.rst b/doc/contribute/documentation/guidelines.rst
@@ -1006,6 +1006,15 @@ Doxygen API documentation
 
       .. 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
 
    This role is used to reference a Doxygen group in the Zephyr tree. In the HTML documentation,