gpu: nvgpu: whitelisting doxygen cleanup

Do some doxygen cleanup for the whitelisting macros:
   - Previously doxygen documentation was being generated for the no-op
     whitelisting macros. Enable the NV_IS_COVERITY define in the
     doxygen build. This generates doxygen documentation for the actual
     whitelisting macros.
   - Create a doxygen group for the whitelisting macros. This adds
     additional documentation for the whitelisting macros.
   - Add doxygen line breaks

JIRA NVGPU-3820

Change-Id: Id452147a3a909da7981303d0908f2aff4a2ff86b
Signed-off-by: Adeel Raza <araza@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2194711
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Adeel Raza
2019-09-10 17:47:10 -07:00
committed by Alex Waterman
parent bf49996bd2
commit 62c5941a71
2 changed files with 15 additions and 11 deletions

View File

@@ -2040,6 +2040,8 @@ INCLUDE_FILE_PATTERNS =
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED =
# Enable documentation for coverity whitelisting macros
PREDEFINED += NV_IS_COVERITY
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The