mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-23 16:20:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix Doxygen warnings

Browse Source
This commit is contained in:
Gilles Peskine 2019-03-06 18:01:43 +01:00
parent c3044a6a36
commit e5c025c7ab
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/psa/crypto_accel_driver.h
View File

@ -644,7 +644,7 @@ typedef psa_status_t (*psa_drv_accel_aead_decrypt_t)(const uint8_t *p_key,
* Where `ALGO` is the name of the signing algorithm * Where `ALGO` is the name of the signing algorithm
* *
* This function supports any asymmetric-key output from psa_export_key() as * This function supports any asymmetric-key output from psa_export_key() as
* the buffer in \ref p_key. Refer to the documentation of \ref * the buffer in \p p_key. Refer to the documentation of \ref
* psa_export_key() for the formats. * psa_export_key() for the formats.
* *
* \param[in] p_key A buffer containing the private key * \param[in] p_key A buffer containing the private key
@ -683,7 +683,7 @@ typedef psa_status_t (*psa_drv_accel_asymmetric_sign_t)(const uint8_t *p_key,
* Where `ALGO` is the name of the signing algorithm * Where `ALGO` is the name of the signing algorithm
* *
* This function supports any output from \ref psa_export_public_key() as the * This function supports any output from \ref psa_export_public_key() as the
* buffer in \ref p_key. Refer to the documentation of \ref * buffer in \p p_key. Refer to the documentation of \ref
* psa_export_public_key() for the format of public keys and to the * psa_export_public_key() for the format of public keys and to the
* documentation of \ref psa_export_key() for the format for other key types. * documentation of \ref psa_export_key() for the format for other key types.
* *
@ -721,7 +721,7 @@ typedef psa_status_t (*psa_drv_accel_asymmetric_verify_t)(const uint8_t *p_key,
* Where `ALGO` is the name of the encryption algorithm * Where `ALGO` is the name of the encryption algorithm
* *
* This function supports any output from \ref psa_export_public_key() as the * This function supports any output from \ref psa_export_public_key() as the
* buffer in \ref p_key. Refer to the documentation of \ref * buffer in \p p_key. Refer to the documentation of \ref
* psa_export_public_key() for the format of public keys and to the * psa_export_public_key() for the format of public keys and to the
* documentation of \ref psa_export_key() for the format for other key types. * documentation of \ref psa_export_key() for the format for other key types.
* *
@ -774,7 +774,7 @@ typedef psa_status_t (*psa_drv_accel_asymmetric_encrypt_t)(const uint8_t *p_key,
* Where `ALGO` is the name of the encryption algorithm * Where `ALGO` is the name of the encryption algorithm
* *
* This function supports any asymmetric-key output from psa_export_key() as * This function supports any asymmetric-key output from psa_export_key() as
* the buffer in \ref p_key. Refer to the documentation of \ref * the buffer in \p p_key. Refer to the documentation of \ref
* psa_export_key() for the formats. * psa_export_key() for the formats.
* *
* \param[in] p_key A buffer containing the private key material * \param[in] p_key A buffer containing the private key material

6
include/psa/crypto_se_driver.h
View File

@ -767,10 +767,10 @@ typedef psa_status_t (*psa_drv_se_export_key_t)(psa_key_slot_number_t key,
* \brief A function that generates a symmetric or asymmetric key on a secure * \brief A function that generates a symmetric or asymmetric key on a secure
* element * element
* *
* If `type` is asymmetric (`#define PSA_KEY_TYPE_IS_ASYMMETRIC(type) == 1`), * If \p type is asymmetric (`#PSA_KEY_TYPE_IS_ASYMMETRIC(\p type) == 1`),
* the public component of the generated key will be placed in `p_pubkey_out`. * the public component of the generated key will be placed in `p_pubkey_out`.
* The format of the public key information will match the format specified for * The format of the public key information will match the format specified for
* the `psa_export_key()` function for the key type. * the psa_export_key() function for the key type.
* *
* \param[in] key_slot Slot where the generated key will be placed * \param[in] key_slot Slot where the generated key will be placed
* \param[in] type The type of the key to be generated * \param[in] type The type of the key to be generated
@ -784,7 +784,7 @@ typedef psa_status_t (*psa_drv_se_export_key_t)(psa_key_slot_number_t key,
* interpretation of this parameter should match the * interpretation of this parameter should match the
* interpretation in the `extra` parameter is the * interpretation in the `extra` parameter is the
* `psa_generate_key` function * `psa_generate_key` function
* \param[in] extra_size The size in bytes of the \ref extra buffer * \param[in] extra_size The size in bytes of the \p extra buffer
* \param[out] p_pubkey_out The buffer where the public key information will * \param[out] p_pubkey_out The buffer where the public key information will
* be placed * be placed
* \param[in] pubkey_out_size The size in bytes of the `p_pubkey_out` buffer * \param[in] pubkey_out_size The size in bytes of the `p_pubkey_out` buffer