commit b9f0674ef194ea281b264c32fc663c82bf392e0d
author David Horstmann <david.horstmann@arm.com> Thu Mar 16 16:07:12 2023 +0000
committer Gilles Peskine <Gilles.Peskine@arm.com> Wed Aug 02 16:06:32 2023 +0200
tree c3ef386ef142e7d3f0d1bbe5f4b47573f06aa1fb
parent bd2947684cb6adbbd22b773d1512fc6c5ac2208f

Ignore mbedtls macros causing warnings

Sphinx's breathe plugin cannot readily parse the Mbed TLS macros, so
define the less essential ones away at the doxygen step to reduce the
number of warnings.

Signed-off-by: David Horstmann <david.horstmann@arm.com>

doxygen/mbedtls.doxyfile

diff --git a/doxygen/mbedtls.doxyfile b/doxygen/mbedtls.doxyfile
index 1a421ef..cd3937f 100644
--- a/doxygen/mbedtls.doxyfile
+++ b/doxygen/mbedtls.doxyfile
@@ -44,3 +44,12 @@
 ALIASES += emptydescription=""
 
 GENERATE_XML           = YES
+
+# Define away Mbed TLS macros that make parsing definitions difficult.
+# MBEDTLS_DEPRECATED is not included in this list as it's important to
+# display deprecated status in the documentation.
+PREDEFINED             = "MBEDTLS_CHECK_RETURN_CRITICAL="   \
+                         "MBEDTLS_CHECK_RETURN_TYPICAL="    \
+                         "MBEDTLS_CHECK_RETURN_OPTIONAL="   \
+                         "MBEDTLS_PRINTF_ATTRIBUTE(a,b)="   \
+