Updated doxygen descriptions, particularly the @return/@retval descriptions.
No change of implementation necessary.
Signed-off-by: Ola Liljedahl <ola.liljed...@linaro.org>
---
(This document/code contribution attached is provided under the terms of
agreement LES-LTM-21309)
include/odp/api/crypto.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/include/odp/api/crypto.h b/include/odp/api/crypto.h
index e9530a3..0ee9d83 100644
--- a/include/odp/api/crypto.h
+++ b/include/odp/api/crypto.h
@@ -265,7 +265,8 @@ typedef struct odp_crypto_op_result {
* @param session Created session else ODP_CRYPTO_SESSION_INVALID
* @param status Failure code if unsuccessful
*
- * @return 0 if successful else -1
+ * @retval 0 on success
+ * @retval <0 on failure
*/
int
odp_crypto_session_create(odp_crypto_session_params_t *params,
@@ -314,7 +315,8 @@ odp_crypto_compl_free(odp_crypto_compl_t completion_event);
* @param posted Pointer to return posted, TRUE for async operation
* @param result Results of operation (when posted returns FALSE)
*
- * @return 0 if successful else -1
+ * @retval 0 on success
+ * @retval <0 on failure
*/
int
odp_crypto_operation(odp_crypto_op_params_t *params,
--
1.9.1
_______________________________________________
lng-odp mailing list
lng-odp@lists.linaro.org
http://lists.linaro.org/mailman/listinfo/lng-odp
