[API-NEXT,v2,1/2] api: crypto: clarify for odp_crypto_session_create

Message ID 1502114410-25867-2-git-send-email-odpbot@yandex.ru
State New
Headers show
Series
  • [API-NEXT,v2,1/2] api: crypto: clarify for odp_crypto_session_create
Related show

Commit Message

Github ODP bot Aug. 7, 2017, 2 p.m.
From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>


Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>

---
/** Email created from pull request 95 (lumag:crypto-session-create)
 ** https://github.com/Linaro/odp/pull/95
 ** Patch: https://github.com/Linaro/odp/pull/95.patch
 ** Base sha: 2394317ab247fa14b4e239aec512afee7eac4524
 ** Merge commit sha: bc2a40cc94ced5ba8ec7b86fbdef99958ed37009
 **/
 include/odp/api/spec/crypto.h | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Patch hide | download patch | download mbox

diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h
index 6d4807c4..715ba9a5 100644
--- a/include/odp/api/spec/crypto.h
+++ b/include/odp/api/spec/crypto.h
@@ -647,11 +647,12 @@  int odp_crypto_auth_capability(odp_auth_alg_t auth,
  *
  * Create a crypto session according to the session parameters. Use
  * odp_crypto_session_param_init() to initialize parameters into their
- * default values.
+ * default values. If call ends up with an error no new session will be
+ * created.
  *
- * @param param             Session parameters
- * @param session           Created session else ODP_CRYPTO_SESSION_INVALID
- * @param status            Failure code if unsuccessful
+ * @param      param        Session parameters
+ * @param[out] session      Created session else ODP_CRYPTO_SESSION_INVALID
+ * @param[out] status       Failure code if unsuccessful
  *
  * @retval 0 on success
  * @retval <0 on failure