From 41dff6325302ffc6921c7b74c99c1cdf59141bb9 Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Thu, 20 May 2021 09:09:10 -0400 Subject: [PATCH] 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. --- cmake/osal-common.doxyfile.in | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cmake/osal-common.doxyfile.in b/cmake/osal-common.doxyfile.in index c52f671fa..435474023 100644 --- a/cmake/osal-common.doxyfile.in +++ b/cmake/osal-common.doxyfile.in @@ -16,6 +16,10 @@ ABBREVIATE_BRIEF = "The $name class " \ the TAB_SIZE = 8 OPTIMIZE_OUTPUT_FOR_C = YES +ALIASES += nonnull="(must not be null)" +ALIASES += nonzero="(must not be zero)" +ALIASES += covtest="(return value only verified in coverage test)" + #--------------------------------------------------------------------------- # Build related configuration options #---------------------------------------------------------------------------