commit f48af7fe7677bf6e30baa7ef73cc64e8b4c4f2f4
author Gilles Peskine <Gilles.Peskine@arm.com> Wed Mar 28 18:44:14 2018 +0200
committer itayzafrir <itay.zafrir@arm.com> Wed Sep 05 11:53:26 2018 +0300
tree 50191a6485be676fc7682580dccc59411e89d738
parent 9e7dc717b05296f4459c173d85b32f316167355e

psa_generate_key: specify what the extra parameters mean

include/psa/crypto.h

diff --git a/include/psa/crypto.h b/include/psa/crypto.h
index 3835ce4..f5db4d2 100644
--- a/include/psa/crypto.h
+++ b/include/psa/crypto.h
@@ -1407,7 +1407,7 @@
  *                            supported.
  * \param salt_length       Size of the \c salt buffer in bytes.
  *                          If \c salt is \c NULL, pass 0.
- * \param output            Buffer where the encrypted message is to be written.
+ * \param output            Buffer where the decrypted message is to be written.
  * \param output_size       Size of the \c output buffer in bytes.
  * \param output_length     On success, the number of bytes
  *                          that make up the returned output.
@@ -1485,9 +1485,9 @@
  * table below. For vendor-defined key types, the vendor documentation
  * shall define the parameter type and the default parameters.
  *
- * Type | Parameter type | Default parameters
- * ---- | -------------- | ------------------
- * `PSA_KEY_TYPE_RSA_KEYPAIR` | `unsigned int` | 65537
+ * Type | Parameter type | Meaning | Parameters used if `parameters == NULL`
+ * ---- | -------------- | ------- | ---------------------------------------
+ * `PSA_KEY_TYPE_RSA_KEYPAIR` | `unsigned int` | Public exponent | 65537
  *
  * \retval PSA_SUCCESS
  * \retval PSA_ERROR_NOT_SUPPORTED