Misc documentation fixes/improvements

This commit is contained in:
Manuel Pégourié-Gonnard 2017-08-23 14:40:21 +02:00
parent 7037e222ea
commit eaf55beead
3 changed files with 10 additions and 2 deletions

View file

@ -40,6 +40,10 @@ typedef enum
/**
* \brief ECDH context structure
*
* \warning Performing multiple operations concurrently on the same
* ECDSA context is not supported; objects of this type
* should not be shared between multiple threads.
*/
typedef struct
{
@ -159,7 +163,7 @@ int mbedtls_ecdh_read_params( mbedtls_ecdh_context *ctx,
* ServerKeyEchange for static ECDH: import ECDH parameters
* from a certificate's EC key information.)
*
* \param ctx ECDH constext to set
* \param ctx ECDH context to set
* \param key EC key to use
* \param side Is it our key (1) or the peer's key (0) ?
*

View file

@ -52,6 +52,10 @@ extern "C" {
/**
* \brief ECDSA context structure
*
* \warning Performing multiple operations concurrently on the same
* ECDSA context is not supported; objects of this type
* should not be shared between multiple threads.
*/
typedef mbedtls_ecp_keypair mbedtls_ecdsa_context;

View file

@ -425,7 +425,7 @@ int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt,
* \param flags result of the verification
* \param f_vrfy verification function
* \param p_vrfy verification parameter
* \param rs_ctx resart context
* \param rs_ctx restart context
*
* \return See \c mbedtls_crt_verify_with_profile(), or
* MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of