Reword the description of mbedtls_net_free()

This makes it clearer that the context itself is not being freed.

Signed-off-by: David Horstmann <david.horstmann@arm.com>
This commit is contained in:
David Horstmann 2023-06-23 23:19:40 +01:00
parent 3048c8c906
commit 07c22c6708

View file

@ -283,16 +283,16 @@ int mbedtls_net_recv_timeout(void *ctx, unsigned char *buf, size_t len,
uint32_t timeout); uint32_t timeout);
/** /**
* \brief Closes down the connection and free associated data * \brief Close down the connection and clear the context
* *
* \param ctx The context to close * \param ctx The context to close
*/ */
void mbedtls_net_close(mbedtls_net_context *ctx); void mbedtls_net_close(mbedtls_net_context *ctx);
/** /**
* \brief Gracefully shutdown the connection and free associated data * \brief Gracefully shutdown the connection and clear the context
* *
* \param ctx The context to free * \param ctx The context to gracefully shutdown
*/ */
void mbedtls_net_free(mbedtls_net_context *ctx); void mbedtls_net_free(mbedtls_net_context *ctx);