Doc: fix doxygen comments.
Some existing doxygen comments resulted in bad or bad looking
documentation. These were fixed.
Change-Id: I20ab5a81c54d3bdc0e056965ad7de293d472cdf9
Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
diff --git a/interface/include/crypto_psa_wrappers.h b/interface/include/crypto_psa_wrappers.h
index c34f828..81d3894 100644
--- a/interface/include/crypto_psa_wrappers.h
+++ b/interface/include/crypto_psa_wrappers.h
@@ -39,10 +39,12 @@
* \brief This function is a TF-M compatible wrapper for the
* \ref tfm_crypto_cipher_update implemented in the Crypto service
*
- * \param[in] input_s Pointer to the structure containing input parameters
- * associated with \ref psa_cipher_update_input
- * \param[out] output_s Pointer to the structure containing output parameters
- * associated with \ref psa_cipher_update_output
+ * \param[out] operation Pointer to the structure containing output parameters
+ * associated with \ref psa_cipher_update_output
+ * \param[in] input_s Pointer to the structure containing input parameters
+ * associated with \ref psa_cipher_update_input
+ * \param[out] output_s Pointer to the structure containing output parameters
+ * associated with \ref psa_cipher_update_output
*
*/
enum tfm_crypto_err_t tfm_crypto_cipher_update_wrapper(
diff --git a/interface/include/psa_client.h b/interface/include/psa_client.h
index 1fc8637..9fe25d9 100644
--- a/interface/include/psa_client.h
+++ b/interface/include/psa_client.h
@@ -96,7 +96,7 @@
* \param[in] in_vec Array of input \ref psa_invec structures
* \param[in] in_len Number of input \ref psa_invec structures
* \param[in] out_vec Array of input \ref psa_outvec structures
- * \param[in] in_len Number of input \ref psa_outvec structures
+ * \param[in] out_len Number of input \ref psa_outvec structures
*
* \retval >=0 Application-specific return code
* \retval <0 Application-specific error code
diff --git a/interface/include/psa_initial_attestation_api.h b/interface/include/psa_initial_attestation_api.h
index 2a674bd..1a7636f 100644
--- a/interface/include/psa_initial_attestation_api.h
+++ b/interface/include/psa_initial_attestation_api.h
@@ -188,12 +188,12 @@
* \param[in] challenge_obj Pointer to buffer where challenge input is
* stored. Nonce and / or hash of attested data.
* Must be always
- * \ref PSA_INITIAL_ATTEST_CHALLENGE_SIZE bytes
+ * \ref PSA_INITIAL_ATTEST_TOKEN_SIZE bytes
* long.
* \param[in] challenge_size Size of challenge object in bytes.
* \param[out] token Pointer to the buffer where attestation token
* must be stored.
- * \param[in/out] token_size Size of allocated buffer for token, which
+ * \param[in,out] token_size Size of allocated buffer for token, which
* updated by initial attestation service with
* final token size.
*
diff --git a/interface/include/psa_protected_storage.h b/interface/include/psa_protected_storage.h
index bd1d91e..91a1604 100644
--- a/interface/include/psa_protected_storage.h
+++ b/interface/include/psa_protected_storage.h
@@ -200,7 +200,7 @@
* \retval PSA_PS_ERROR_STORAGE_FAILURE If the data is not written correctly in the physical storage
* \retval PSA_PS_ERROR_OFFSET_INVALID The operation failed because an offset was supplied that is invalid
* for the allocated size of the space
- * reserved for the `uid` when \ref psa_psa_create
+ * reserved for the `uid` when \ref psa_ps_create
* was called. For example, offset + size
* is too large
* \retval PSA_PS_ERROR_INVALID_ARGUMENT The operation failed because one or more of the given arguments were invalid (null pointer, wrong flags, etc)
diff --git a/interface/include/psa_service.h b/interface/include/psa_service.h
index 38467b0..e27b420 100644
--- a/interface/include/psa_service.h
+++ b/interface/include/psa_service.h
@@ -226,8 +226,6 @@
/**
* \brief Clears the PSA_DOORBELL signal.
*
- * \param[in] void
- *
* \retval void Success
* \retval "Does not return" The Secure Partition's doorbell signal is not
* currently asserted
diff --git a/interface/include/tfm_crypto_defs.h b/interface/include/tfm_crypto_defs.h
index 4e532ca..4573811 100644
--- a/interface/include/tfm_crypto_defs.h
+++ b/interface/include/tfm_crypto_defs.h
@@ -81,7 +81,7 @@
* \brief A macro to translate psa_status_t values to the corresponding return
* values for the TFM Crypto service
*
- * \return Values specified by \ref enum tfm_crypto_err_t
+ * \return Values specified by \ref tfm_crypto_err_t
*
*/
#define PSA_STATUS_TO_TFM_CRYPTO_ERR(val) \
diff --git a/interface/include/tfm_crypto_veneers.h b/interface/include/tfm_crypto_veneers.h
index 9e95475..82654ef 100644
--- a/interface/include/tfm_crypto_veneers.h
+++ b/interface/include/tfm_crypto_veneers.h
@@ -239,7 +239,7 @@
* \note A successful call to this function releases the cipher operation
* context provided as parameter
*
- * \param[in/out] operation Cipher operation context
+ * \param[in,out] operation Cipher operation context
* \param[out] output Buffer containing output data
* \param[in] output_size Size of the output buffer
* \param[out] output_length Size of the produced output
@@ -258,7 +258,7 @@
* \note A successful call to this function releases the cipher operation
* context provided as parameter
*
- * \param[in/out] operation Cipher operation context
+ * \param[in,out] operation Cipher operation context
*
* \return Return values as described in \ref tfm_crypto_err_t
*/
@@ -282,7 +282,7 @@
* \brief Add a new input chunk to the data for which the final hash value
* will be computed (veneer function)
*
- * \param[in/out] operation Hash operation context
+ * \param[in,out] operation Hash operation context
* \param[in] input Buffer containing the input data
* \param[in] input_length Size of the provided input data
*
@@ -299,7 +299,7 @@
* \note A successful call to this function releases the hash operation
* context provided as parameter
*
- * \param[in/out] operation Hash operation context
+ * \param[in,out] operation Hash operation context
* \param[out] hash Buffer containing hash data
* \param[in] hash_size Size of the hash buffer
* \param[out] hash_length Size of the produced hash
@@ -319,7 +319,7 @@
* context provided as parameter. The hash operation is released
* also in case TFM_CRYPTO_ERR_PSA_ERROR_INVALID_SIGNATURE is returned
*
- * \param[in/out] operation Hash operation context
+ * \param[in,out] operation Hash operation context
* \param[in] hash Buffer containing the provided hash value
* \param[in] hash_length Size of the provided hash value
*
@@ -336,7 +336,7 @@
* \note A successful call to this function releases the hash operation
* context provided as parameter
*
- * \param[in/out] operation Hash operation context
+ * \param[in,out] operation Hash operation context
*
* \return Return values as described in \ref tfm_crypto_err_t
*/
@@ -380,7 +380,7 @@
* \brief Adds a new input chunk to the data for which the final MAC value
* will be computed (veneer function)
*
- * \param[in/out] operation MAC operation context
+ * \param[in,out] operation MAC operation context
* \param[in] input Buffer containing the input data
* \param[in] input_length Size of the provided input data
*
@@ -398,7 +398,7 @@
* \note A successful call to this function releases the MAC operation
* context provided as parameter
*
- * \param[in/out] operation MAC operation context
+ * \param[in,out] operation MAC operation context
* \param[out] mac Buffer containing MAC data
* \param[in] mac_size Size of the MAC buffer
* \param[out] mac_length Size of the produced MAC
@@ -418,7 +418,7 @@
* context provided as parameter. The MAC operation is released
* also in case TFM_CRYPTO_ERR_PSA_ERROR_INVALID_SIGNATURE is returned
*
- * \param[in/out] operation MAC operation context
+ * \param[in,out] operation MAC operation context
* \param[in] mac Buffer containing the provided MAC value
* \param[in] mac_length Size of the provided MAC value
*
@@ -435,7 +435,7 @@
* \note A successful call to this function releases the MAC operation
* context provided as parameter
*
- * \param[in/out] operation MAC operation context
+ * \param[in,out] operation MAC operation context
*
* \return Return values as described in \ref tfm_crypto_err_t
*/