psa_pake_setup(): simplify documentation

This level of detail can be confusing and could require even more detail
to clear it up. Simplifying it instead in alignment wiht the
documentation of existing setup functions.

Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2021-06-03 13:21:33 +01:00
parent b4db90fb27
commit 3293dae00e

View File

@ -1317,10 +1317,7 @@ static psa_pake_operation_t psa_pake_operation_init(void);
* - A successful call to psa_pake_get_implicit_key(). * - A successful call to psa_pake_get_implicit_key().
* *
* \param[in,out] operation The operation object to set up. It must have * \param[in,out] operation The operation object to set up. It must have
* been initialized as per the documentation for * been initialized but not set up yet.
* #psa_pake_operation_t and not yet in use (no
* other function has been called on it since the
* last initialization).
* \param cipher_suite The cipher suite to use. (A cipher suite fully * \param cipher_suite The cipher suite to use. (A cipher suite fully
* characterizes a PAKE algorithm and determines * characterizes a PAKE algorithm and determines
* the algorithm as well.) * the algorithm as well.)