diff --git a/doxygen/mbedtls.doxyfile b/doxygen/mbedtls.doxyfile index 0c744daaa..7e8d19611 100644 --- a/doxygen/mbedtls.doxyfile +++ b/doxygen/mbedtls.doxyfile @@ -27,3 +27,15 @@ HAVE_DOT = YES DOT_GRAPH_MAX_NODES = 200 MAX_DOT_GRAPH_DEPTH = 1000 DOT_TRANSPARENT = YES + +# Doxygen accepts empty descriptions for commands such as \retval, +# but clang -Wdocumentation doesn't (since Clang 15, for \retval). +# https://github.com/Mbed-TLS/mbedtls/issues/6960 +# https://github.com/llvm/llvm-project/issues/60315 +# As a workaround, when documenting the status codes that a function can +# return, if you don't have anything to say beyond the status code's +# description, you can write something like +# \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription +# This does not change the documentation generated by Doxygen, but +# it pacifies clang -Wdocumentation. +ALIASES += emptydescription=""