Merge pull request #7827 from davidhorstmann-arm/reword-net-free-description-2544
Reword the description of `mbedtls_net_free()`
This commit is contained in:
commit
d50562c33c
1 changed files with 8 additions and 0 deletions
|
@ -286,6 +286,10 @@ int mbedtls_net_recv_timeout(void *ctx, unsigned char *buf, size_t len,
|
||||||
* \brief Closes down the connection and free associated data
|
* \brief Closes down the connection and free associated data
|
||||||
*
|
*
|
||||||
* \param ctx The context to close
|
* \param ctx The context to close
|
||||||
|
*
|
||||||
|
* \note This function frees and clears data associated with the
|
||||||
|
* context but does not free the memory pointed to by \p ctx.
|
||||||
|
* This memory is the responsibility of the caller.
|
||||||
*/
|
*/
|
||||||
void mbedtls_net_close(mbedtls_net_context *ctx);
|
void mbedtls_net_close(mbedtls_net_context *ctx);
|
||||||
|
|
||||||
|
@ -293,6 +297,10 @@ void mbedtls_net_close(mbedtls_net_context *ctx);
|
||||||
* \brief Gracefully shutdown the connection and free associated data
|
* \brief Gracefully shutdown the connection and free associated data
|
||||||
*
|
*
|
||||||
* \param ctx The context to free
|
* \param ctx The context to free
|
||||||
|
*
|
||||||
|
* \note This function frees and clears data associated with the
|
||||||
|
* context but does not free the memory pointed to by \p ctx.
|
||||||
|
* This memory is the responsibility of the caller.
|
||||||
*/
|
*/
|
||||||
void mbedtls_net_free(mbedtls_net_context *ctx);
|
void mbedtls_net_free(mbedtls_net_context *ctx);
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue