yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve documentation of documentation workaround

Browse source 
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2023-02-21 10:21:12 +01:00
parent 4386cf188d
commit 787f7c8d10
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doxygen/mbedtls.doxyfile
View file

@ -32,9 +32,12 @@ DOT_TRANSPARENT = YES
# but clang -Wdocumentation doesn't (since Clang 15, for \retval). # but clang -Wdocumentation doesn't (since Clang 15, for \retval).
# https://github.com/Mbed-TLS/mbedtls/issues/6960 # https://github.com/Mbed-TLS/mbedtls/issues/6960
# https://github.com/llvm/llvm-project/issues/60315 # https://github.com/llvm/llvm-project/issues/60315
# As a workaround, when documenting the status codes that a function can # We often use \retval declarations with just a constant name to
# return, if you don't have anything to say beyond the status code's # document which error codes a function can return. If the documentation
# description, you can write something like # of the error code is enough to explain the error, then an empty
# description on the \retval statement is ok. However, the source code
# of the description needs to be made non-empty to pacify Clang.
# In such cases, you can write something like
# \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription # \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
# This does not change the documentation generated by Doxygen, but # This does not change the documentation generated by Doxygen, but
# it pacifies clang -Wdocumentation. # it pacifies clang -Wdocumentation.