Skip to content

Commit 446432a

Browse files
gmarullnashif
authored andcommitted
doc: doxygen: add support for function properties
Add aliases for setting function properties. A function may have 0, one or more function properties. Example usage: @funcprops \isr_ok, \async These aliases will translate to API Terminology references when Doxygen is rendered on Sphinx. On the Doxygen side they will just translate to plain text. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent e5eb1b1 commit 446432a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/zephyr.doxyfile.in

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,15 @@ ALIASES += req{1}="\ref ZEPH_\1 \"ZEPH-\1\" "
228228
ALIASES += satisfy{1}="\xrefitem satisfy \"Satisfies requirement\" \"Requirement Implementation\" \1"
229229
ALIASES += verify{1}="\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1"
230230

231+
ALIASES += "funcprops=\par \"Function properties (list may not be complete)\""
232+
ALIASES += "reschedule=\htmlonly reschedule \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_reschedule`</verbatim> \endxmlonly"
233+
ALIASES += "sleep=\htmlonly sleep \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_sleep`</verbatim> \endxmlonly"
234+
ALIASES += "no_wait=\htmlonly no-wait \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_no-wait`</verbatim> \endxmlonly"
235+
ALIASES += "isr_ok=\htmlonly isr-ok \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_isr-ok`</verbatim> \endxmlonly"
236+
ALIASES += "pre_kernel_ok=\htmlonly pre-kernel-ok \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_pre-kernel-ok`</verbatim> \endxmlonly"
237+
ALIASES += "async=\htmlonly async \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_async`</verbatim> \endxmlonly"
238+
ALIASES += "supervisor=\htmlonly supervisor \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_supervisor`</verbatim> \endxmlonly"
239+
231240
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
232241
# only. Doxygen will then generate output that is more tailored for C. For
233242
# instance, some of the names that are used will be different. The list of all

0 commit comments

Comments
 (0)