Mbed-TLS / mbedtls

An open source, portable, easy to use, readable and flexible TLS library, and reference implementation of the PSA Cryptography API. Releases are on a varying cadence, typically around 3 - 6 months between releases.
https://www.trustedfirmware.org/projects/mbed-tls/
Other
5.05k stars 2.51k forks source link

psa_crypto_pake.h is missing `\emptydescription` #7886

Open bzcheeseman opened 1 year ago

bzcheeseman commented 1 year ago

Summary

I am using Clang 15.0.7 to build mbedTLS and seeing this:

error: empty paragraph passed to '\retval' command [-Werror,-Wdocumentation]
 * \retval #PSA_ERROR_CORRUPTION_DETECTED

I include mbedTLS as a CMake subdirectory in a larger project.

All the errors are in the psa_crypto_pake.h file, which I also notice is missing the \emptydescription tags the other files have. I tried manually adding the -Wno-documentation flag, but it's swallowed because the -Wdocumentation flag is re-appended to CMAKE_C_FLAGS in library/CMakeLists.txt.

The rest of the build proceeds as expected (or rather, when I remove the flag, the build works).

System information

Mbed TLS version (number or commit id): 3.4.0 (1873d3bfc2da771672bd8e7e8f41f57e0af77f33) Compiler and options: Clang 15.0.7 on Ubuntu

Expected behavior

The build should not fail with this error.

Actual behavior

The build fails with

error: empty paragraph passed to '\retval' command [-Werror,-Wdocumentation]
 * \retval #PSA_ERROR_CORRUPTION_DETECTED

Steps to reproduce

Build the mbedcrypto target with Clang 15.0.7 or later.

M4urici0GM commented 8 months ago

Up