Documentation fixes
Correct indentation, brackets, and comments.
diff --git a/include/mbedtls/ecdsa.h b/include/mbedtls/ecdsa.h
index ba7aba1..f991470 100644
--- a/include/mbedtls/ecdsa.h
+++ b/include/mbedtls/ecdsa.h
@@ -213,7 +213,7 @@
* \param f_rng The RNG function.
* \param p_rng The RNG parameter.
*
- * \note The signature \p sig is expected to be ASN.1 SEQUENCE
+ * \note The signature \p sig is expected to in be ASN.1 SEQUENCE
* format, as described in <em>Standards for Efficient
* Cryptography Group (SECG): SEC1 Elliptic Curve
* Cryptography</em>, section C.5.
diff --git a/include/mbedtls/pk.h b/include/mbedtls/pk.h
index d712e77..0e92377 100644
--- a/include/mbedtls/pk.h
+++ b/include/mbedtls/pk.h
@@ -54,10 +54,10 @@
/**@{*/
#define MBEDTLS_ERR_PK_ALLOC_FAILED -0x3F80 /**< Memory allocation failed. */
-#define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00 /**< Type mismatch, eg attempt to encrypt with an ECDSA key */
+#define MBEDTLS_ERR_PK_TYPE_MISMATCH -0x3F00 /**< Type mismatch, eg attempt to encrypt with an ECDSA key. */
#define MBEDTLS_ERR_PK_BAD_INPUT_DATA -0x3E80 /**< Bad input parameters to function. */
#define MBEDTLS_ERR_PK_FILE_IO_ERROR -0x3E00 /**< Read/write of file failed. */
-#define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80 /**< Unsupported key version */
+#define MBEDTLS_ERR_PK_KEY_INVALID_VERSION -0x3D80 /**< Unsupported key version. */
#define MBEDTLS_ERR_PK_KEY_INVALID_FORMAT -0x3D00 /**< Invalid key tag or value. */
#define MBEDTLS_ERR_PK_UNKNOWN_PK_ALG -0x3C80 /**< Key algorithm is unsupported (only RSA and EC are supported). */
#define MBEDTLS_ERR_PK_PASSWORD_REQUIRED -0x3C00 /**< Private key password can't be empty. */
@@ -68,9 +68,9 @@
#define MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE -0x3980 /**< Unavailable feature, e.g. RSA disabled for RSA key. */
#define MBEDTLS_ERR_PK_SIG_LEN_MISMATCH -0x3900 /**< The signature is valid but its length is less than expected. */
#define MBEDTLS_ERR_PK_HW_ACCEL_FAILED -0x3880 /**< PK hardware accelerator failed. */
-#define MBEDTLS_ERR_PK_INVALID_SIGNATURE -0x3800 /**< Invalid signature */
-#define MBEDTLS_ERR_PK_BUFFER_TOO_SMALL -0x3780 /**< Output buffer too small */
-#define MBEDTLS_ERR_PK_NOT_PERMITTED -0x3700 /**< Operation not permitted */
+#define MBEDTLS_ERR_PK_INVALID_SIGNATURE -0x3800 /**< Invalid signature. */
+#define MBEDTLS_ERR_PK_BUFFER_TOO_SMALL -0x3780 /**< Output buffer too small. */
+#define MBEDTLS_ERR_PK_NOT_PERMITTED -0x3700 /**< Operation not permitted. */
/**@}*/
@@ -88,14 +88,14 @@
* unrecognized type. Call \c mbedtls_pk_can_do() to check
* whether a key is of a recognized type. */
typedef enum {
- MBEDTLS_PK_NONE=0, /**< Unused context object */
- MBEDTLS_PK_RSA, /**< RSA key pair (normal software implementation) with PKCS#1 v1.5 or PSS context */
- MBEDTLS_PK_ECKEY, /**< Generic ECC key pair */
- MBEDTLS_PK_ECKEY_DH, /**< ECC key pair restricted to key exchanges */
- MBEDTLS_PK_ECDSA, /**< ECC key pair restricted to signature/verification */
- MBEDTLS_PK_RSA_ALT, /**< RSA (alternative implementation) */
- MBEDTLS_PK_RSASSA_PSS, /**< RSA key pair; same context as MBEDTLS_PK_RSA, but used to represent keys with the algorithm identifier id-RSASSA-PSS */
- MBEDTLS_PK_OPAQUE, /**< Opaque key pair (cryptographic material held in an external module).*/
+ MBEDTLS_PK_NONE=0, /**< Unused context object. */
+ MBEDTLS_PK_RSA, /**< RSA key pair (normal software implementation) with PKCS#1 v1.5 or PSS context. */
+ MBEDTLS_PK_ECKEY, /**< Generic ECC key pair. */
+ MBEDTLS_PK_ECKEY_DH, /**< ECC key pair restricted to key exchanges. */
+ MBEDTLS_PK_ECDSA, /**< ECC key pair restricted to signature/verification. */
+ MBEDTLS_PK_RSA_ALT, /**< RSA (alternative implementation). */
+ MBEDTLS_PK_RSASSA_PSS, /**< RSA key pair; same context as MBEDTLS_PK_RSA, but used to represent keys with the algorithm identifier id-RSASSA-PSS. */
+ MBEDTLS_PK_OPAQUE, /**< Opaque key pair (cryptographic material held in an external module). */
} mbedtls_pk_type_t;
/**
@@ -154,7 +154,7 @@
} mbedtls_pk_context;
/**
- * \brief Access the type name
+ * \brief Get the key type name of a PK context.
*
* \param ctx Context to use
*
@@ -163,7 +163,7 @@
const char * mbedtls_pk_get_name( const mbedtls_pk_context *ctx );
/**
- * \brief Get the key type
+ * \brief Get the key type of a PK context.
*
* \param ctx Context to use
*
diff --git a/include/mbedtls/pk_info.h b/include/mbedtls/pk_info.h
index 6ee47d8..6e6fd47 100644
--- a/include/mbedtls/pk_info.h
+++ b/include/mbedtls/pk_info.h
@@ -3,7 +3,7 @@
*
* \brief Public Key cryptography abstraction layer: engine interface
*
- * This file defines the interface the public-key cryptography engines
+ * This file defines the interface which public-key cryptography engines
* (PK engines) must implement. A PK engine defines how a public-private
* key pair is represented and how to perform cryptographic operations
* with it. Mbed TLS contains built-in PK engines implemented either
@@ -135,7 +135,7 @@
* In case of an error, or an unsupported key type, 0 should be returned.
*
* Opaque implementations may omit this method if they do not support
- * signature. */
+ * signing. */
size_t (*signature_size_func)( const void *ctx );
/** Verify signature
@@ -239,8 +239,7 @@
* #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE.
*
* Alternatively, check_pair_func may return another PK, RSA or ECP error
- * code if applicable.
- * */
+ * code if applicable. */
int (*check_pair_func)( const mbedtls_pk_context *pub, const mbedtls_pk_context *prv );
/** Allocate a new context
@@ -248,7 +247,7 @@
* mbedtls_pk_setup() calls this function.
*
* If this function returns NULL, the allocation is considered to
- * have failed and the the object remains uninitialized.
+ * have failed and the object remains uninitialized.
*
* Opaque implementations may omit this method. In this case,
* mbedtls_pk_setup() will set the \c pk_ctx field of the
@@ -261,9 +260,8 @@
/** Free the given context
*
* mbedtls_pk_free() calls this function. It must free the data allocated
- * by \b ctx_alloc_func as well as any other resource that belongs to
- * the object.
- * */
+ * by \c ctx_alloc_func as well as any other resource that belongs to
+ * the object. */
void (*ctx_free_func)( void *ctx );
/** Interface with the debug module
@@ -276,10 +274,10 @@
};
/**
- * Methods that opaque key pair objects must implement.
- *
* \brief Initializer for opaque key engines
*
+ * Methods that opaque key pair objects must implement.
+ *
* The value of this macro is a suitable initializer for an object of type
* mbedtls_pk_info_t. It is guaranteed to remain so in future versions of the
* library, even if the type mbedtls_pk_info_t changes.
@@ -288,7 +286,7 @@
* parameters are constant.
*
* \param name For transparent keys, this reflects the key type. For opaque
- * keys, this reflects the cryptographic module driver.
+ * keys, this reflects the cryptographic module driver.
* \param get_bitlen \ref mbedtls_pk_info_t.get_bitlen method
* \param can_do \ref mbedtls_pk_info_t.can_do method
* \param signature_size_func \ref mbedtls_pk_info_t.signature_size_func method
@@ -302,9 +300,7 @@
* \param debug_func \ref mbedtls_pk_info_t.debug_func method
*
* \return Initializer for an object of type mbedtls_pk_info_t with the
- * specified field values
- *
- * */
+ * specified field values */
#define MBEDTLS_PK_OPAQUE_INFO_1( \
name \
, get_bitlen \