Improve doc of pk_parse_* functions
diff --git a/include/polarssl/pk.h b/include/polarssl/pk.h
index 013d973..6f21dab 100644
--- a/include/polarssl/pk.h
+++ b/include/polarssl/pk.h
@@ -400,6 +400,12 @@
* \param pwd password for decryption (optional)
* \param pwdlen size of the password
*
+ * \note On entry, ctx must be empty, either freshly initialised
+ * with pk_init() or reset with pk_free(). If you need a
+ * specific key type, check the result with pk_can_do().
+ *
+ * \note The key is also checked for correctness.
+ *
* \return 0 if successful, or a specific PK or PEM error code
*/
int pk_parse_key( pk_context *ctx,
@@ -414,6 +420,12 @@
* \param key input buffer
* \param keylen size of the buffer
*
+ * \note On entry, ctx must be empty, either freshly initialised
+ * with pk_init() or reset with pk_free(). If you need a
+ * specific key type, check the result with pk_can_do().
+ *
+ * \note The key is also checked for correctness.
+ *
* \return 0 if successful, or a specific PK or PEM error code
*/
int pk_parse_public_key( pk_context *ctx,
@@ -428,6 +440,12 @@
* \param path filename to read the private key from
* \param password password to decrypt the file (can be NULL)
*
+ * \note On entry, ctx must be empty, either freshly initialised
+ * with pk_init() or reset with pk_free(). If you need a
+ * specific key type, check the result with pk_can_do().
+ *
+ * \note The key is also checked for correctness.
+ *
* \return 0 if successful, or a specific PK or PEM error code
*/
int pk_parse_keyfile( pk_context *ctx,
@@ -440,6 +458,12 @@
* \param ctx key to be initialized
* \param path filename to read the private key from
*
+ * \note On entry, ctx must be empty, either freshly initialised
+ * with pk_init() or reset with pk_free(). If you need a
+ * specific key type, check the result with pk_can_do().
+ *
+ * \note The key is also checked for correctness.
+ *
* \return 0 if successful, or a specific PK or PEM error code
*/
int pk_parse_public_keyfile( pk_context *ctx, const char *path );