michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add traceability aliases to doxygen

Browse source 
Add aliases @verify and @satisfy to drive traceability using doxygen.

See https://stackoverflow.com/questions/537043/custom-tags-with-doxygen
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-10-19 08:59:14 -04:00 • committed by Carles Cufí
commit 7c055c8cf5
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/zephyr.doxyfile.in
View file

@ -223,7 +223,9 @@ TAB_SIZE = 8
ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \ ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \
"endrst=\endverbatim" "endrst=\endverbatim"
ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" " ALIASES += req{1}="\ref ZEPH_\1 \"ZEPH-\1\" "
ALIASES += satisfy{1}="\xrefitem satisfy \"Satisfies requirement\" \"Requirement Implementation\" \1"
ALIASES += verify{1}="\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For # only. Doxygen will then generate output that is more tailored for C. For
@ -746,8 +748,8 @@ INPUT = custom-doxygen/mainpage.md \
@ZEPHYR_BASE@/kernel/include/kernel_arch_interface.h \ @ZEPHYR_BASE@/kernel/include/kernel_arch_interface.h \
@ZEPHYR_BASE@/include/ \ @ZEPHYR_BASE@/include/ \
@ZEPHYR_BASE@/lib/libc/minimal/include/ \ @ZEPHYR_BASE@/lib/libc/minimal/include/ \
@ZEPHYR_BASE@/subsys/testsuite/ztest/include/ \ @ZEPHYR_BASE@/subsys/testsuite/ztest/include/ \
@ZEPHYR_BASE@/tests/kernel/ @ZEPHYR_BASE@/tests/kernel/
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses