commit f0bbd7e3fd6c5ce10dbc5ab0bc4e3e11759a45ca
author Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com> Mon Oct 15 13:22:41 2018 +0200
committer Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com> Mon Oct 15 13:22:41 2018 +0200
tree 91931591c547d43a794bac41f233c86ee542791d
parent 6346a75dfb96d330387b711644dc7934d31301f4

Misc documentation fixes/improvements.

include/mbedtls/ecp.h

diff --git a/include/mbedtls/ecp.h b/include/mbedtls/ecp.h
index 15aee04..d13f3ba 100644
--- a/include/mbedtls/ecp.h
+++ b/include/mbedtls/ecp.h
@@ -50,7 +50,7 @@
 #define MBEDTLS_ERR_ECP_INVALID_KEY                       -0x4C80  /**< Invalid private or public key. */
 #define MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH                  -0x4C00  /**< The buffer contains a valid signature followed by more data. */
 #define MBEDTLS_ERR_ECP_HW_ACCEL_FAILED                   -0x4B80  /**< The ECP hardware accelerator failed. */
-#define MBEDTLS_ERR_ECP_IN_PROGRESS                       -0x4B00  /**< Operation in progress, try again with the same parameters. */
+#define MBEDTLS_ERR_ECP_IN_PROGRESS                       -0x4B00  /**< Operation in progress, call again with the same parameters to continue. */
 
 #ifdef __cplusplus
 extern "C" {
@@ -747,7 +747,7 @@
  * \param P         The point to multiply.
  * \param f_rng     The RNG function.
  * \param p_rng     The RNG context.
- * \param rs_ctx    The restart context.
+ * \param rs_ctx    The restart context (NULL disables restart).
  *
  * \return          \c 0 on success.
  * \return          #MBEDTLS_ERR_ECP_INVALID_KEY if \p m is not a valid private
@@ -804,7 +804,7 @@
  * \param P         The point to multiply by \p m.
  * \param n         The integer by which to multiply \p Q.
  * \param Q         The point to be multiplied by \p n.
- * \param rs_ctx    The restart context.
+ * \param rs_ctx    The restart context (NULL disables restart).
  *
  * \return          \c 0 on success.
  * \return          #MBEDTLS_ERR_ECP_INVALID_KEY if \p m or \p n are not