Skip to content

Commit

Permalink
Merge pull request #1555 from jphickey/fix-1554-doc-tags
Browse files Browse the repository at this point in the history
Fix #1554, add doxygen aliases for OSAL parameter/retvals

NOTE: Manually merged/propagated to CFE-common resolve warnings
when referencing OSAL headers from CFE usersguide build.
  • Loading branch information
jphickey committed Jun 3, 2021
2 parents 4a3129c + 41dff63 commit 51ecd53
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions cmake/cfe-common.doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ ALIASES += "event=\xrefitem cfeevents \"Event Message\" \"cFE Even
"cfetimetlm=\xrefitem cfetimetlm \"Name\" \"cFE Time Services Telemetry\" " \
"cfecmdmnemonic=\xrefitem cfecmdmnems \"Command Mnemonic(s)\" \"cFE Command Mnemonic Cross Reference\" " \
"cfetlmmnemonic=\xrefitem cfetlmmnems \"Telemetry Mnemonic(s)\" \"cFE Telemetry Mnemonic Cross Reference\" "

ALIASES += nonnull="(must not be null)"
ALIASES += nonzero="(must not be zero)"
ALIASES += covtest="(return value only verified in coverage test)"

OPTIMIZE_OUTPUT_FOR_C = YES
#---------------------------------------------------------------------------
# Build related configuration options
Expand Down

0 comments on commit 51ecd53

Please sign in to comment.