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

doxygen: fix parameter name typos and misused \p commands

Browse source 
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
This commit is contained in:
Andrzej Kurek 2023-05-06 09:38:57 -04:00
parent 43dfd51ab4
commit 00b54e6885
5 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/mbedtls/ecdsa.h
View file

@ -327,8 +327,8 @@ int mbedtls_ecdsa_sign_restartable(
* \param md_alg The hash algorithm used to hash the original data. * \param md_alg The hash algorithm used to hash the original data.
* \param f_rng_blind The RNG function used for blinding. This must not be * \param f_rng_blind The RNG function used for blinding. This must not be
* \c NULL. * \c NULL.
* \param p_rng_blind The RNG context to be passed to \p f_rng. This may be * \param p_rng_blind The RNG context to be passed to \p f_rng_blind. This may be
* \c NULL if \p f_rng doesn't need a context parameter. * \c NULL if \p f_rng_blind doesn't need a context parameter.
* \param rs_ctx The restart context to use. This may be \c NULL * \param rs_ctx The restart context to use. This may be \c NULL
* to disable restarting. If it is not \c NULL, it * to disable restarting. If it is not \c NULL, it
* must point to an initialized restart context. * must point to an initialized restart context.

10
include/mbedtls/ssl.h
View file

@ -3810,8 +3810,8 @@ static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
/** /**
* \brief Retrieve SNI extension value for the current handshake. * \brief Retrieve SNI extension value for the current handshake.
* Available in \p f_cert_cb of \c mbedtls_ssl_conf_cert_cb(), * Available in \c f_cert_cb of \c mbedtls_ssl_conf_cert_cb(),
* this is the same value passed to \p f_sni callback of * this is the same value passed to \c f_sni callback of
* \c mbedtls_ssl_conf_sni() and may be used instead of * \c mbedtls_ssl_conf_sni() and may be used instead of
* \c mbedtls_ssl_conf_sni(). * \c mbedtls_ssl_conf_sni().
* *
@ -3820,7 +3820,7 @@ static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
* 0 if SNI extension is not present or not yet processed. * 0 if SNI extension is not present or not yet processed.
* *
* \return const pointer to SNI extension value. * \return const pointer to SNI extension value.
* - value is valid only when called in \p f_cert_cb * - value is valid only when called in \c f_cert_cb
* registered with \c mbedtls_ssl_conf_cert_cb(). * registered with \c mbedtls_ssl_conf_cert_cb().
* - value is NULL if SNI extension is not present. * - value is NULL if SNI extension is not present.
* - value is not '\0'-terminated. Use \c name_len for len. * - value is not '\0'-terminated. Use \c name_len for len.
@ -4116,7 +4116,7 @@ void MBEDTLS_DEPRECATED mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, i
* negotiated. * negotiated.
* *
* \param conf SSL configuration * \param conf SSL configuration
* \param tls_version TLS protocol version number (\p mbedtls_ssl_protocol_version) * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
* (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid) * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
*/ */
static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf, static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf,
@ -4173,7 +4173,7 @@ void MBEDTLS_DEPRECATED mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, i
* negotiated. * negotiated.
* *
* \param conf SSL configuration * \param conf SSL configuration
* \param tls_version TLS protocol version number (\p mbedtls_ssl_protocol_version) * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
* (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid) * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
*/ */
static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf, static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf,

2
include/mbedtls/ssl_cache.h
View file

@ -137,7 +137,7 @@ int mbedtls_ssl_cache_set(void *data,
* *
* \param data The SSL cache context to use. * \param data The SSL cache context to use.
* \param session_id The pointer to the buffer holding the session ID * \param session_id The pointer to the buffer holding the session ID
* associated to \p session. * associated to session.
* \param session_id_len The length of \p session_id in bytes. * \param session_id_len The length of \p session_id in bytes.
* *
* \return \c 0 on success. This indicates the cache entry for * \return \c 0 on success. This indicates the cache entry for

4
include/psa/crypto.h
View file

@ -4407,9 +4407,9 @@ psa_status_t psa_sign_hash_start(
* \retval #PSA_ERROR_BUFFER_TOO_SMALL * \retval #PSA_ERROR_BUFFER_TOO_SMALL
* The size of the \p signature buffer is too small. You can * The size of the \p signature buffer is too small. You can
* determine a sufficient buffer size by calling * determine a sufficient buffer size by calling
* #PSA_SIGN_OUTPUT_SIZE(\c key_type, \c key_bits, \p alg) * #PSA_SIGN_OUTPUT_SIZE(\c key_type, \c key_bits, \c alg)
* where \c key_type and \c key_bits are the type and bit-size * where \c key_type and \c key_bits are the type and bit-size
* respectively of \p key. * respectively of \c key.
* *
* \retval #PSA_ERROR_BAD_STATE * \retval #PSA_ERROR_BAD_STATE
* An operation was not previously started on this context via * An operation was not previously started on this context via

16
include/psa/crypto_extra.h
View file

@ -1545,7 +1545,7 @@ psa_status_t psa_pake_set_user(psa_pake_operation_t *operation,
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* Success. * Success.
* \retval #PSA_ERROR_INVALID_ARGUMENT * \retval #PSA_ERROR_INVALID_ARGUMENT
* \p user_id is not valid for the \p operation's algorithm and cipher * \p peer_id is not valid for the \p operation's algorithm and cipher
* suite. * suite.
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED
* The algorithm doesn't associate a second identity with the session. * The algorithm doesn't associate a second identity with the session.
@ -1627,8 +1627,8 @@ psa_status_t psa_pake_set_role(psa_pake_operation_t *operation,
* \c PSA_PAKE_STEP_XXX constants for more * \c PSA_PAKE_STEP_XXX constants for more
* information. * information.
* \param output_size Size of the \p output buffer in bytes. This must * \param output_size Size of the \p output buffer in bytes. This must
* be at least #PSA_PAKE_OUTPUT_SIZE(\p alg, \p * be at least #PSA_PAKE_OUTPUT_SIZE(\c alg, \c
* primitive, \p step) where \p alg and * primitive, \p output_step) where \c alg and
* \p primitive are the PAKE algorithm and primitive * \p primitive are the PAKE algorithm and primitive
* in the operation's cipher suite, and \p step is * in the operation's cipher suite, and \p step is
* the output step. * the output step.
@ -1693,9 +1693,9 @@ psa_status_t psa_pake_output(psa_pake_operation_t *operation,
* \retval #PSA_ERROR_INVALID_SIGNATURE * \retval #PSA_ERROR_INVALID_SIGNATURE
* The verification fails for a #PSA_PAKE_STEP_ZK_PROOF input step. * The verification fails for a #PSA_PAKE_STEP_ZK_PROOF input step.
* \retval #PSA_ERROR_INVALID_ARGUMENT * \retval #PSA_ERROR_INVALID_ARGUMENT
* \p is not compatible with the \p operation’s algorithm, or the * \p input_length is not compatible with the \p operation’s algorithm,
* \p input is not valid for the \p operation's algorithm, cipher suite * or the \p input is not valid for the \p operation's algorithm,
* or \p step. * cipher suite or \p step.
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED
* \p step p is not supported with the \p operation's algorithm, or the * \p step p is not supported with the \p operation's algorithm, or the
* \p input is not supported for the \p operation's algorithm, cipher * \p input is not supported for the \p operation's algorithm, cipher
@ -1877,7 +1877,7 @@ psa_status_t psa_pake_abort(psa_pake_operation_t *operation);
* The value of this macro must be at least as large as the largest value * The value of this macro must be at least as large as the largest value
* returned by PSA_PAKE_OUTPUT_SIZE() * returned by PSA_PAKE_OUTPUT_SIZE()
* *
* See also #PSA_PAKE_OUTPUT_SIZE(\p alg, \p primitive, \p step). * See also #PSA_PAKE_OUTPUT_SIZE(\p alg, \p primitive, \p output_step).
*/ */
#define PSA_PAKE_OUTPUT_MAX_SIZE 65 #define PSA_PAKE_OUTPUT_MAX_SIZE 65
@ -1889,7 +1889,7 @@ psa_status_t psa_pake_abort(psa_pake_operation_t *operation);
* The value of this macro must be at least as large as the largest value * The value of this macro must be at least as large as the largest value
* returned by PSA_PAKE_INPUT_SIZE() * returned by PSA_PAKE_INPUT_SIZE()
* *
* See also #PSA_PAKE_INPUT_SIZE(\p alg, \p primitive, \p step). * See also #PSA_PAKE_INPUT_SIZE(\p alg, \p primitive, \p output_step).
*/ */
#define PSA_PAKE_INPUT_MAX_SIZE 65 #define PSA_PAKE_INPUT_MAX_SIZE 65