Fix all Doxygen issues

crypto/nrf_cc310_bl/include/crys_error.h

@@ -48,7 +48,6 @@ extern "C"
 for each module of the layers listed below.
 @defgroup crys_error CryptoCell general base error codes
 @{
-@ingroup cryptocell_api
 */
 
 /*! The definitions of the error number space used for the different modules */
@@ -267,7 +266,3 @@ typedef uint32_t CRYSError_t;
 @}
  */
 #endif
-
-
-
-

crypto/nrf_cc310_bl/include/ssi_pal_types.h

@@ -38,7 +38,6 @@
 @brief This file contains the platform dependent definitions and types.
 @defgroup ssi_pal_types CryptoCell PAL platform dependent types
 @{
-@ingroup ssi_pal
 */
 
 #ifndef SSI_PAL_TYPES_H

crypto/nrf_cc310_mbedcrypto/include/cc3xx.h

@@ -27,10 +27,10 @@
  * \note This file must be included by psa_crypto_driver_wrappers.c. The
  * definition of the context types used in the implementation is provided
  * through \ref cc3xx_crypto_primitives_private.h which is included, when
- * \ref PSA_CRYPTO_DRIVER_CC3XX is defined, in turn by psa/crypto.h, then
+ * `PSA_CRYPTO_DRIVER_CC3XX` is defined, in turn by psa/crypto.h, then
  * psa/crypto_struct.h and finally by psa/crypto_driver_context_primitives.h
  * and by psa/crypto_driver_context_composites.h from the mbedTLS module.
- * When \ref PSA_CRYPTO_DRIVER_CC3XX is not defined, the implementation
+ * When `PSA_CRYPTO_DRIVER_CC3XX` is not defined, the implementation
  * must explicitly include \ref cc3xx_crypto_primitives_private.h while the
  * interface can include \ref cc3xx_crypto_primitives.h only
  *

crypto/nrf_cc310_mbedcrypto/include/cc3xx_psa_aead.h

@@ -39,7 +39,7 @@ extern "C" {
  * \param[in]  ciphertext_size        Size in bytes of the ciphertext buffer
  * \param[out] ciphertext_length      Size in bytes of the encrypted data
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t
@@ -68,7 +68,7 @@ cc3xx_aead_encrypt(const psa_key_attributes_t *attributes,
  * \param[in]  plaintext_size         Size in bytes of the plaintext buffer
  * \param[out] plaintext_length       Size in bytes of the decrypted data
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t
@@ -88,13 +88,13 @@ cc3xx_aead_decrypt(const psa_key_attributes_t *attributes,
  * \param[in] key_buffer      The buffer containing the key material.
  * \param[in] key_buffer_size Size of \p key_buffer in bytes.
  * \param[in] alg             The AEAD algorithm
- *                            (#PSA_ALG_IS_AEAD(\p alg) must be true).
+ *                            (PSA_ALG_IS_AEAD(\p alg) must be true).
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_BAD_STATE
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_BAD_STATE
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_NOT_SUPPORTED
  */
 psa_status_t cc3xx_aead_encrypt_setup(
         cc3xx_aead_operation_t *operation,
@@ -110,13 +110,13 @@ psa_status_t cc3xx_aead_encrypt_setup(
  * \param[in] key_buffer      The buffer containing the key material.
  * \param[in] key_buffer_size Size of \p key_buffer in bytes.
  * \param[in] alg             The AEAD algorithm
- *                            (#PSA_ALG_IS_AEAD(\p alg) must be true).
+ *                            (PSA_ALG_IS_AEAD(\p alg) must be true).
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_BAD_STATE
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_BAD_STATE
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_NOT_SUPPORTED
  */
 psa_status_t cc3xx_aead_decrypt_setup(
         cc3xx_aead_operation_t *operation,
@@ -131,12 +131,12 @@ psa_status_t cc3xx_aead_decrypt_setup(
  * \param[in] nonce        Buffer containing the nonce to use.
  * \param[in] nonce_length Size of the nonce in bytes.
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_GENERIC_ERROR
- * \retval #PSA_ERROR_NOT_SUPPORTED
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_DATA_INVALID
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_GENERIC_ERROR
+ * \retval PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_DATA_INVALID
  */
 psa_status_t cc3xx_aead_set_nonce(
         cc3xx_aead_operation_t *operation,
@@ -150,10 +150,10 @@ psa_status_t cc3xx_aead_set_nonce(
  * \param[in] ad_length        Size of the additional data in bytes.
  * \param[in] plaintext_length Size of the plaintext to encrypt in bytes.
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_NOT_SUPPORTED
  */
 psa_status_t cc3xx_aead_set_lengths(
         cc3xx_aead_operation_t *operation,
@@ -167,11 +167,11 @@ psa_status_t cc3xx_aead_set_lengths(
  * \param[in] input        Buffer containing the additional data.
  * \param[in] input_size   Size of the input buffer in bytes.
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_NOT_SUPPORTED
- * \retval #PSA_ERROR_DATA_INVALID
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_ERROR_DATA_INVALID
  */
 psa_status_t cc3xx_aead_update_ad(
         cc3xx_aead_operation_t *operation,
@@ -188,11 +188,11 @@ psa_status_t cc3xx_aead_update_ad(
  * \param[in]  output_size   Size of the output buffer in bytes.
  * \param[out] output_length The number of bytes that make up the output.
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_NOT_SUPPORTED
- * \retval #PSA_ERROR_DATA_INVALID
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_ERROR_DATA_INVALID
  */
 psa_status_t cc3xx_aead_update(
         cc3xx_aead_operation_t *operation,
@@ -213,10 +213,10 @@ psa_status_t cc3xx_aead_update(
  * \param[in] tag_size           Size of the tag buffer in bytes.
  * \param[out] tag_length        The number of bytes that make up the tag.
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_NOT_SUPPORTED
  */
 psa_status_t cc3xx_aead_finish(
         cc3xx_aead_operation_t *operation,
@@ -237,10 +237,10 @@ psa_status_t cc3xx_aead_finish(
  * \param[in] tag               Buffer containing the tag
  * \param[in] tag_size          Size of the tag buffer in bytes
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_NOT_SUPPORTED
  */
 psa_status_t cc3xx_aead_verify(
         cc3xx_aead_operation_t *operation,
@@ -254,8 +254,8 @@ psa_status_t cc3xx_aead_verify(
  *
  * \param[out] operation Initialized AEAD operation.
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_NOT_SUPPORTED
  */
 psa_status_t cc3xx_aead_abort(cc3xx_aead_operation_t *operation);
 

crypto/nrf_cc310_mbedcrypto/include/cc3xx_psa_asymmetric_encryption.h

@@ -37,7 +37,7 @@ extern "C" {
  * \param[in]  output_size     Size in bytes of the output buffer
  * \param[out] output_length   Size in bytes of the encrypted data
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_asymmetric_encrypt(const psa_key_attributes_t *attributes,
@@ -65,7 +65,7 @@ psa_status_t cc3xx_asymmetric_encrypt(const psa_key_attributes_t *attributes,
  * \param[in]  output_size     Size in bytes of the output buffer
  * \param[out] output_length   Size in bytes of the decrypted data
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_asymmetric_decrypt(const psa_key_attributes_t *attributes,

crypto/nrf_cc310_mbedcrypto/include/cc3xx_psa_asymmetric_signature.h

@@ -35,7 +35,7 @@ extern "C" {
  * \param[in]  signature_size   Size in bytes of the signature buffer
  * \param[out] signature_length Size in bytes of the signature
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_sign_message(const psa_key_attributes_t *attributes,
@@ -56,7 +56,7 @@ psa_status_t cc3xx_sign_message(const psa_key_attributes_t *attributes,
  * \param[in] signature        Signature to verify
  * \param[in] signature_length Size in bytes of the signature
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_verify_message(const psa_key_attributes_t *attributes,
@@ -77,7 +77,7 @@ psa_status_t cc3xx_verify_message(const psa_key_attributes_t *attributes,
  * \param[in]  signature_size   Size in bytes of the signature buffer
  * \param[out] signature_length Size in bytes of the signature
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_sign_hash(const psa_key_attributes_t *attributes,
@@ -97,7 +97,7 @@ psa_status_t cc3xx_sign_hash(const psa_key_attributes_t *attributes,
  * \param[in] signature        Signature to verify
  * \param[in] signature_length Size in bytes of the signature
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_verify_hash(const psa_key_attributes_t *attributes,

crypto/nrf_cc310_mbedcrypto/include/cc3xx_psa_cipher.h

@@ -34,11 +34,11 @@ extern "C" {
  * \param[in] alg        Algorithm to setup for which PSA_ALG_IS_CIPHER(alg)
  *                       must be true
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_NOT_SUPPORTED
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_BAD_STATE
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_BAD_STATE
  *
  */
 psa_status_t cc3xx_cipher_encrypt_setup(
@@ -57,11 +57,11 @@ psa_status_t cc3xx_cipher_encrypt_setup(
  * \param[in] alg        Algorithm to setup for which PSA_ALG_IS_CIPHER(alg)
  *                       must be true
  *
- * \retval #PSA_SUCCESS
- * \retval #PSA_ERROR_NOT_SUPPORTED
- * \retval #PSA_ERROR_INVALID_ARGUMENT
- * \retval #PSA_ERROR_CORRUPTION_DETECTED
- * \retval #PSA_ERROR_BAD_STATE
+ * \retval PSA_SUCCESS
+ * \retval PSA_ERROR_NOT_SUPPORTED
+ * \retval PSA_ERROR_INVALID_ARGUMENT
+ * \retval PSA_ERROR_CORRUPTION_DETECTED
+ * \retval PSA_ERROR_BAD_STATE
  *
  */
 psa_status_t cc3xx_cipher_decrypt_setup(
@@ -76,7 +76,7 @@ psa_status_t cc3xx_cipher_decrypt_setup(
  * \param[in] iv        Buffer holding the IV to setup
  * \param[in] iv_length Size in bytes of the IV
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_cipher_set_iv(
@@ -93,7 +93,7 @@ psa_status_t cc3xx_cipher_set_iv(
  * \param[in]  output_size   Size in bytes of the output buffer
  * \param[out] output_length Size in bytes of the actual output
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_cipher_update(
@@ -109,7 +109,7 @@ psa_status_t cc3xx_cipher_update(
  * \param[in]  output_size   Size in bytes of the output buffer
  * \param[out] output_length Size in bytes of the encrypted output
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_cipher_finish(
@@ -120,7 +120,7 @@ psa_status_t cc3xx_cipher_finish(
  *
  * \param[out] operation Pointer to the operation object
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_cipher_abort(
@@ -141,7 +141,7 @@ psa_status_t cc3xx_cipher_abort(
  * \param[in]  output_size     Size in bytes of the output buffer
  * \param[out] output_length   Size in bytes of the encrypted data
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_cipher_encrypt(
@@ -170,7 +170,7 @@ psa_status_t cc3xx_cipher_encrypt(
  * \param[in]  output_size     Size in bytes of the output buffer
  * \param[out] output_length   Size in bytes of the decrypted data
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_cipher_decrypt(

crypto/nrf_cc310_mbedcrypto/include/cc3xx_psa_entropy.h

@@ -30,7 +30,7 @@ extern "C" {
  * \param[out] output        Collected entropy from the TRNG source
  * \param[in]  output_size   Size of the output buffer
  *
- * \retval  PSA_SUCCESS on success. Error code from \ref psa_status_t on
+ * \retval  PSA_SUCCESS on success. Error code from psa_status_t on
  *          failure
  */
 psa_status_t cc3xx_get_entropy(uint32_t flags, size_t *estimate_bits,