Documentation fix
Added more elaborate descriptions, fixed minor issues.
diff --git a/include/mbedtls/oid.h b/include/mbedtls/oid.h
index 826ee64..782764d 100644
--- a/include/mbedtls/oid.h
+++ b/include/mbedtls/oid.h
@@ -227,7 +227,7 @@
#define MBEDTLS_OID_HMAC_SHA1 MBEDTLS_OID_RSA_COMPANY "\x02\x07" /**< id-hmacWithSHA1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 7 } */
-#define MBEDTLS_MD_OID_MAX_SIZE 10 /**< Maximum length of an OID of a supported digest algorithm*/
+#define MBEDTLS_MD_OID_MAX_SIZE 10 /**< Maximum length of an OID of a supported digest algorithm */
/*
* Encryption algorithms
diff --git a/include/mbedtls/pkcs11_client.h b/include/mbedtls/pkcs11_client.h
index 83aed51..6d314a9 100644
--- a/include/mbedtls/pkcs11_client.h
+++ b/include/mbedtls/pkcs11_client.h
@@ -56,7 +56,9 @@
#include "pk.h"
/**
- * \brief Set up a PK context for a key pair in a PKCS#11 token
+ * \brief Set up a PK context from a key pair in a PKCS#11 token.
+ * This allows to access the token's cryptographic
+ * functionality through the PK interface.
*
* \param ctx PK context to fill, which must have been initialized
* with mbedtls_pk_init().
@@ -84,7 +86,7 @@
*
* This function imports a PK object containing a
* public key or a private-public key pair into a
- * PKCS#11 token.
+ * PKCS#11 token.
*
* \param ctx PK context, which must contain a transparent pk
* object (type \c MBEDTLS_PK_RSA,
@@ -113,10 +115,12 @@
* will be authorized for encryption.
*
* \param hSession Cryptoki session.
- * \param hPublicKey If non-null, on output, Cryptoki handle of the public
- * key. If null, the public key is not imported.
- * \param hPrivateKey If non-null, on output, Cryptoki handle of the private
- * key. If null, the private key is not imported.
+ * \param hPublicKey If not NULL, receives the Cryptoki handle of the public
+ * key on success. If NULL, the public key is not
+ * imported.
+ * \param hPrivateKey If not NULL, receives the Cryptoki handle of the
+ * private key on success. If NULL, the private key is
+ * not imported.
*
* \return 0 on success,
* or MBEDTLS_ERR_PK_XXX error code.
diff --git a/include/mbedtls/rsa.h b/include/mbedtls/rsa.h
index 046bfc5..90a5907 100644
--- a/include/mbedtls/rsa.h
+++ b/include/mbedtls/rsa.h
@@ -738,7 +738,7 @@
/**
* \brief Encode a hash into a DigestInfo structure as specified
- * by PKCS#1(RFC 8017, EMSA-PKCS1-v1_5-ENCODE step 2).
+ * by PKCS#1 (RFC 8017, EMSA-PKCS1-v1_5-ENCODE step 2).
* Note: function works backwards in data buffer.
*
* \param p Reference to the current position pointer