michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add new @option Doxygen ALIAS

Browse source 
This new ALIAS can be used to add references to Kconfig options. To use
it enclose the Kconfig symbol name like this `@option{KCONFIG_FOO}`.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
This commit is contained in:
Fabio Utzig 2020-09-11 10:09:32 -03:00 • committed by Carles Cufí
commit cb644149c6
1 changed files with 1 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/zephyr.doxyfile.in
View file

@ -223,6 +223,7 @@ TAB_SIZE = 8
ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \ ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \
"endrst=\endverbatim" "endrst=\endverbatim"
ALIASES += option{1}="\verbatim embed:rst:inline :option:`\1` \endverbatim"
ALIASES += req{1}="\ref ZEPH_\1 \"ZEPH-\1\" " ALIASES += req{1}="\ref ZEPH_\1 \"ZEPH-\1\" "
ALIASES += satisfy{1}="\xrefitem satisfy \"Satisfies requirement\" \"Requirement Implementation\" \1" ALIASES += satisfy{1}="\xrefitem satisfy \"Satisfies requirement\" \"Requirement Implementation\" \1"
ALIASES += verify{1}="\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1" ALIASES += verify{1}="\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1"