Improve documentation wording and formatting

This commit is contained in:
Manuel Pégourié-Gonnard 2018-09-12 10:55:15 +02:00
parent 1c1c20ed4d
commit 12e4a8be2a
5 changed files with 23 additions and 18 deletions

View file

@ -683,8 +683,9 @@
* Enable "non-blocking" ECC operations that can return early and be resumed.
*
* This enables \c mbedtls_ecp_set_max_ops() and allows various functions
* to return \c MBEDTLS_ERR_ECP_IN_PROGRESS when needed, and then be called
* again later with the same arguments in order to further progress and
* to return #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL
* module, #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) when needed, and then be
* called again later with the same arguments in order to further progress and
* eventually complete the operation, see \c mbedtls_ecp_set_max_ops().
*
* This is useful in non-threaded environments if you want to avoid blocking