Docs: Add an alias used in PSA crypto headers
The PSA Crypto headers resort to using the adhoc command
\emptydescription to immediately mark a field which does
not have a description, with the following rationale:
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.
Align the TF-M doxygen rules to have this command in the list
of ALIASES and avoid warnings
Signed-off-by: Antonio de Angelis <antonio.deangelis@arm.com>
Change-Id: I3c1751d75a3b3e408a12ce0f90590e5347b6c050
diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in
index 4bf2738..c2b5661 100644
--- a/docs/doxygen/Doxyfile.in
+++ b/docs/doxygen/Doxyfile.in
@@ -245,7 +245,7 @@
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
-ALIASES =
+ALIASES = emptydescription=""
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"