cuberite/polarssl
1
0
Fork 0
mirror of https://github.com/cuberite/polarssl.git synced 2025-09-10 07:36:28 -04:00
Code Issues Packages Projects Releases Wiki Activity

doxygen: \p commands misuse - review comments

Browse Source 
Apply comments suggested in review.
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
This commit is contained in:
Andrzej Kurek 2023-05-06 09:57:40 -04:00
parent c00fb7f379
commit 532ec20983
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/mbedtls/camellia.h
View File

@ -231,7 +231,7 @@ int mbedtls_camellia_crypt_cfb128(mbedtls_camellia_context *ctx,
* *note Due to the nature of CTR mode, you should use the same * *note Due to the nature of CTR mode, you should use the same
* key for both encryption and decryption. In particular, calls * key for both encryption and decryption. In particular, calls
* to this function should be preceded by a key-schedule via * to this function should be preceded by a key-schedule via
* mbedtls_camellia_setkey_enc() regardless of whether \c mode * mbedtls_camellia_setkey_enc() regardless of whether the mode
* is #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. * is #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT.
* *
* \warning You must never reuse a nonce value with the same key. Doing so * \warning You must never reuse a nonce value with the same key. Doing so

2
include/mbedtls/cipher.h
View File

@ -779,7 +779,7 @@ int mbedtls_cipher_update(mbedtls_cipher_context_t *ctx,
* \param ctx The generic cipher context. This must be initialized and * \param ctx The generic cipher context. This must be initialized and
* bound to a key. * bound to a key.
* \param output The buffer to write data to. This needs to be a writable * \param output The buffer to write data to. This needs to be a writable
* buffer of at least \c block_size Bytes. * buffer of at least block_size Bytes.
* \param olen The length of the data written to the \p output buffer. * \param olen The length of the data written to the \p output buffer.
* This may not be \c NULL. * This may not be \c NULL.
* *

4
include/mbedtls/ssl.h
View File

@ -2573,8 +2573,8 @@ int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
* *
* \param session The session structure to be saved. * \param session The session structure to be saved.
* \param buf The buffer to write the serialized data to. It must be a * \param buf The buffer to write the serialized data to. It must be a
* writeable buffer of at least \p olen bytes, or may be \c * writeable buffer of at least \p buf_len bytes, or may be \c
* NULL if \p olen is \c 0. * NULL if \p buf_len is \c 0.
* \param buf_len The number of bytes available for writing in \p buf. * \param buf_len The number of bytes available for writing in \p buf.
* \param olen The size in bytes of the data that has been or would have * \param olen The size in bytes of the data that has been or would have
* been written. It must point to a valid \c size_t. * been written. It must point to a valid \c size_t.