Skip to content

Commit 41dff63

Browse files
committed
Fix #1554, add doxygen aliases for OSAL parameter/retvals
Adds "nonnull", "nonzero", and "covtest" tags to mark parameters and return values in documentation. This info is helpful when auditing the test cases.
1 parent 8443a46 commit 41dff63

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

cmake/osal-common.doxyfile.in

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ ABBREVIATE_BRIEF = "The $name class " \
1616
the
1717
TAB_SIZE = 8
1818
OPTIMIZE_OUTPUT_FOR_C = YES
19+
ALIASES += nonnull="(must not be null)"
20+
ALIASES += nonzero="(must not be zero)"
21+
ALIASES += covtest="(return value only verified in coverage test)"
22+
1923
#---------------------------------------------------------------------------
2024
# Build related configuration options
2125
#---------------------------------------------------------------------------

0 commit comments

Comments
 (0)