mbedtls/library
Gilles Peskine ed73355d2e Make \retval commands non-empty
Pacify Clang >=15 which complained:
```
include/psa/crypto.h:91:23: error: empty paragraph passed to '\retval' command [-Werror,-Wdocumentation]
 * \retval #PSA_SUCCESS
   ~~~~~~~~~~~~~~~~~~~^
```

This commit performs the following systematic replacement:
```
perl -i -0777 -p -e 's/([\\@])(retval +\S+)\n(?! *\*? *([^\n \\*\/]|\\[cp]\b))/$1$2 ${1}emptydescription\n/g' $(git ls-files '*.[hc]' '*.function' '*.jinja')
```
i.e. add an `\emptydescription` argument to `\retval` commands (or
`@retval`, which we don't normally used) that are followed by a single word,
unless the next line looks like it contains text which would be the
description.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2023-02-14 19:21:09 +01:00
..
.gitignore Add psa_crypto_driver_wrappers.c to .gitignore 2021-12-18 13:29:10 +05:30
aes.c Switch to the new code style 2023-01-11 14:50:10 +01:00
aesni.c Tidy-up - move asm #define into build_info.h 2023-01-20 14:04:48 +00:00
aesni.h Switch to the new code style 2023-01-11 14:50:10 +01:00
alignment.h Improve documentation 2023-01-20 14:04:48 +00:00
aria.c Switch to the new code style 2023-01-11 14:50:10 +01:00
asn1parse.c Switch to the new code style 2023-01-11 14:50:10 +01:00
asn1write.c Switch to the new code style 2023-01-11 14:50:10 +01:00
base64.c Switch to the new code style 2023-01-11 14:50:10 +01:00
bignum.c mbedtls_mpi_sub_abs: Skip memcpy when redundant (#6701). 2023-01-17 11:52:22 -05:00
bignum_core.c Switch to the new code style 2023-01-11 14:50:10 +01:00
bignum_core.h Fix typos in doxygen commands in new bignum modules 2023-02-01 08:43:54 +00:00
bignum_mod.c bignum_mod_raw: Renamed m -> N in mbedtls_mpi_mod_raw_neg() 2023-01-17 11:25:26 +05:30
bignum_mod.h Fix typos in doxygen commands in new bignum modules 2023-02-01 08:43:54 +00:00
bignum_mod_raw.c Merge pull request #6941 from gabor-mezei-arm/6375_quasi-reduction_function 2023-01-31 11:25:25 +01:00
bignum_mod_raw.h Merge pull request #6957 from tom-cosgrove-arm/fix-spelling-of-doxygen-return 2023-01-24 21:56:45 +01:00
bignum_mod_raw_invasive.h Update documentation 2023-01-23 19:10:26 +01:00
bn_mul.h Tidy-up - move asm #define into build_info.h 2023-01-20 14:04:48 +00:00
camellia.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ccm.c Fix use of sizeof without brackets 2023-02-02 12:40:50 +00:00
chacha20.c Switch to the new code style 2023-01-11 14:50:10 +01:00
chachapoly.c Switch to the new code style 2023-01-11 14:50:10 +01:00
check_crypto_config.h Switch to the new code style 2023-01-11 14:50:10 +01:00
cipher.c Switch to the new code style 2023-01-11 14:50:10 +01:00
cipher_wrap.c Switch to the new code style 2023-01-11 14:50:10 +01:00
cipher_wrap.h Switch to the new code style 2023-01-11 14:50:10 +01:00
cmac.c Switch to the new code style 2023-01-11 14:50:10 +01:00
CMakeLists.txt Bump versions for libmbedcrypto and libmbedtls 2022-12-14 17:04:00 +00:00
common.h Move definition of asm out of public header 2023-01-20 14:04:48 +00:00
constant_time.c Inhibit compiler from optimising out const-time asm 2023-01-30 09:26:48 +00:00
constant_time_internal.h Switch to the new code style 2023-01-11 14:50:10 +01:00
constant_time_invasive.h Switch to the new code style 2023-01-11 14:50:10 +01:00
ctr_drbg.c Remove redundant SIZE_MAX guards 2023-02-10 16:03:44 +00:00
debug.c move ticket_flags debug helpers 2023-01-13 11:06:01 +08:00
des.c Switch to the new code style 2023-01-11 14:50:10 +01:00
dhm.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ecdh.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ecdsa.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ecjpake.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ecp.c Remove unneeded include 2023-01-30 16:27:48 +01:00
ecp_curves.c Fix use of sizeof without brackets 2023-02-02 12:40:50 +00:00
ecp_internal_alt.h Switch to the new code style 2023-01-11 14:50:10 +01:00
ecp_invasive.h Switch to the new code style 2023-01-11 14:50:10 +01:00
entropy.c Fix use of sizeof without brackets 2023-02-02 12:40:50 +00:00
entropy_poll.c Switch to the new code style 2023-01-11 14:50:10 +01:00
entropy_poll.h Switch to the new code style 2023-01-11 14:50:10 +01:00
gcm.c Switch to the new code style 2023-01-11 14:50:10 +01:00
hash_info.c Switch to the new code style 2023-01-11 14:50:10 +01:00
hash_info.h Switch to the new code style 2023-01-11 14:50:10 +01:00
hkdf.c Switch to the new code style 2023-01-11 14:50:10 +01:00
hmac_drbg.c Switch to the new code style 2023-01-11 14:50:10 +01:00
lmots.c Switch to the new code style 2023-01-11 14:50:10 +01:00
lmots.h Switch to the new code style 2023-01-11 14:50:10 +01:00
lms.c Switch to the new code style 2023-01-11 14:50:10 +01:00
Makefile Bump versions for libmbedcrypto and libmbedtls 2022-12-14 17:04:00 +00:00
md.c Switch to the new code style 2023-01-11 14:50:10 +01:00
md5.c Switch to the new code style 2023-01-11 14:50:10 +01:00
md_wrap.h Switch to the new code style 2023-01-11 14:50:10 +01:00
memory_buffer_alloc.c Switch to the new code style 2023-01-11 14:50:10 +01:00
mps_common.h Switch to the new code style 2023-01-11 14:50:10 +01:00
mps_error.h Switch to the new code style 2023-01-11 14:50:10 +01:00
mps_reader.c Switch to the new code style 2023-01-11 14:50:10 +01:00
mps_reader.h Switch to the new code style 2023-01-11 14:50:10 +01:00
mps_trace.c Switch to the new code style 2023-01-11 14:50:10 +01:00
mps_trace.h Switch to the new code style 2023-01-11 14:50:10 +01:00
net_sockets.c Switch to the new code style 2023-01-11 14:50:10 +01:00
nist_kw.c Switch to the new code style 2023-01-11 14:50:10 +01:00
oid.c pk: move MBEDTLS_PK_CAN_ECDSA_SOME macro to pk.h and fix tests 2023-02-13 11:15:06 +01:00
padlock.c Tidy-up - move asm #define into build_info.h 2023-01-20 14:04:48 +00:00
padlock.h Switch to the new code style 2023-01-11 14:50:10 +01:00
pem.c Switch to the new code style 2023-01-11 14:50:10 +01:00
pk.c Remove redundant SIZE_MAX guards 2023-02-10 16:03:44 +00:00
pk_wrap.c Remove redundant SIZE_MAX guards 2023-02-10 16:03:44 +00:00
pk_wrap.h pk: move MBEDTLS_PK_CAN_ECDSA_SOME macro to pk.h and fix tests 2023-02-13 11:15:06 +01:00
pkcs5.c Switch to the new code style 2023-01-11 14:50:10 +01:00
pkcs7.c Fix code-style 2023-02-09 09:21:14 +00:00
pkcs12.c Switch to the new code style 2023-01-11 14:50:10 +01:00
pkparse.c pkarse: Added pk_group_id_from_specified() documentation. 2023-01-23 10:33:06 +00:00
pkwrite.c Switch to the new code style 2023-01-11 14:50:10 +01:00
pkwrite.h Switch to the new code style 2023-01-11 14:50:10 +01:00
platform.c Switch to the new code style 2023-01-11 14:50:10 +01:00
platform_util.c Switch to the new code style 2023-01-11 14:50:10 +01:00
poly1305.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto.c Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_aead.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_aead.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_cipher.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_cipher.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_client.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_core.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_driver_wrappers.h Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_ecp.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_ecp.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_hash.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_hash.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_invasive.h Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_its.h Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_mac.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_mac.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_pake.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_random_impl.h Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_rsa.c Remove redundant SIZE_MAX guards 2023-02-10 16:03:44 +00:00
psa_crypto_rsa.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_se.c Remove redundant SIZE_MAX guards 2023-02-10 16:03:44 +00:00
psa_crypto_se.h Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_slot_management.c Switch to the new code style 2023-01-11 14:50:10 +01:00
psa_crypto_slot_management.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_storage.c Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_crypto_storage.h Make \retval commands non-empty 2023-02-14 19:21:09 +01:00
psa_its_file.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ripemd160.c Fix use of sizeof without brackets 2023-02-02 12:40:50 +00:00
rsa.c Switch to the new code style 2023-01-11 14:50:10 +01:00
rsa_alt_helpers.c Switch to the new code style 2023-01-11 14:50:10 +01:00
rsa_alt_helpers.h Switch to the new code style 2023-01-11 14:50:10 +01:00
sha1.c Switch to the new code style 2023-01-11 14:50:10 +01:00
sha256.c Tidy-up - move asm #define into build_info.h 2023-01-20 14:04:48 +00:00
sha512.c Tidy-up - move asm #define into build_info.h 2023-01-20 14:04:48 +00:00
ssl_cache.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ssl_ciphersuites.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ssl_client.c Rename the finalize_client{server}_hello() 2023-02-08 05:47:48 +00:00
ssl_client.h Switch to the new code style 2023-01-11 14:50:10 +01:00
ssl_cookie.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ssl_debug_helpers.h refine ticket_flags printing helper 2023-01-16 11:28:49 +08:00
ssl_misc.h Merge pull request #6773 from yanrayw/6675-change-early_secrets-to-local 2023-02-14 09:03:32 +01:00
ssl_msg.c Remove redundant SIZE_MAX guards 2023-02-10 16:03:44 +00:00
ssl_ticket.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ssl_tls.c Set hs_psk,ciphercuit_info and kex mode when writing pre-share key 2023-02-08 05:44:00 +00:00
ssl_tls12_client.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ssl_tls12_server.c Switch to the new code style 2023-01-11 14:50:10 +01:00
ssl_tls13_client.c Rebase code to restore reco-delay and fix some style issues 2023-02-08 07:41:42 +00:00
ssl_tls13_generic.c Replace session_negotiate->ciphersuite with handshake->ciphersuite_info->id 2023-02-08 05:47:48 +00:00
ssl_tls13_invasive.h Switch to the new code style 2023-01-11 14:50:10 +01:00
ssl_tls13_keys.c Merge pull request #6773 from yanrayw/6675-change-early_secrets-to-local 2023-02-14 09:03:32 +01:00
ssl_tls13_keys.h Enhancement: change some functions to static in ssl_tls13_keys.c 2023-01-12 14:54:26 +08:00
ssl_tls13_server.c Rename the finalize_client{server}_hello() 2023-02-08 05:47:48 +00:00
threading.c Switch to the new code style 2023-01-11 14:50:10 +01:00
timing.c Switch to the new code style 2023-01-11 14:50:10 +01:00
version.c Switch to the new code style 2023-01-11 14:50:10 +01:00
x509.c X.509: Add length consistency checks to x509_get_other_name() 2023-02-07 05:24:32 -05:00
x509_create.c Switch to the new code style 2023-01-11 14:50:10 +01:00
x509_crl.c Switch to the new code style 2023-01-11 14:50:10 +01:00
x509_crt.c Don't use lstrlenW() on Windows 2023-02-10 12:52:13 +00:00
x509_csr.c Fix code style 2023-01-26 22:30:45 +01:00
x509write_crt.c x509: replace/fix name of new function for setting serial 2023-01-26 17:43:09 +01:00
x509write_csr.c Switch to the new code style 2023-01-11 14:50:10 +01:00