Improve wording in ECP documentation

This commit is contained in:
Hanno Becker 2018-12-18 13:00:34 +00:00
parent 57b684f9d1
commit 486f1b33d7

View File

@ -499,8 +499,8 @@ void mbedtls_ecp_point_free( mbedtls_ecp_point *pt );
* \brief This function frees the components of an ECP group. * \brief This function frees the components of an ECP group.
* *
* \param grp The group to free. This may be \c NULL, in which * \param grp The group to free. This may be \c NULL, in which
* case this function is a no-op. If it is not \c NULL, * case this function returns immediately. If it is not
* it must point to an initialized ECP group. * \c NULL, it must point to an initialized ECP group.
*/ */
void mbedtls_ecp_group_free( mbedtls_ecp_group *grp ); void mbedtls_ecp_group_free( mbedtls_ecp_group *grp );
@ -508,8 +508,8 @@ void mbedtls_ecp_group_free( mbedtls_ecp_group *grp );
* \brief This function frees the components of a key pair. * \brief This function frees the components of a key pair.
* *
* \param key The key pair to free. This may be \c NULL, in which * \param key The key pair to free. This may be \c NULL, in which
* case this function is a no-op. If it is not \c NULL, * case this function returns immediately. If it is not
* it must point to an initialized ECP key pair. * \c NULL, it must point to an initialized ECP key pair.
*/ */
void mbedtls_ecp_keypair_free( mbedtls_ecp_keypair *key ); void mbedtls_ecp_keypair_free( mbedtls_ecp_keypair *key );
@ -526,8 +526,8 @@ void mbedtls_ecp_restart_init( mbedtls_ecp_restart_ctx *ctx );
* \brief Free the components of a restart context. * \brief Free the components of a restart context.
* *
* \param ctx The restart context to free. This may be \c NULL, in which * \param ctx The restart context to free. This may be \c NULL, in which
* case this function is a no-op. If it is not \c NULL, * case this function returns immediately. If it is not
* it must point to an initialized restart context. * \c NULL, it must point to an initialized restart context.
*/ */
void mbedtls_ecp_restart_free( mbedtls_ecp_restart_ctx *ctx ); void mbedtls_ecp_restart_free( mbedtls_ecp_restart_ctx *ctx );
#endif /* MBEDTLS_ECP_RESTARTABLE */ #endif /* MBEDTLS_ECP_RESTARTABLE */