AuroraMiddleware/mbedtls
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add additional comments to platform setup/teardown functions

Browse Source
This commit is contained in:
Simon Butcher 2017-07-21 02:08:00 +02:00
parent 9a6748cff1
commit d3be27a92a
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/mbedtls/platform.h
View File

@ -312,7 +312,13 @@ mbedtls_platform_context;
*
* \return 0 if successful
*
* \note This function should be called before any other library function
* \note This function is intended to allow platform specific initialisation,
* and should be called before any other library functions. Its
* implementation is platform specific, and by default, unless platform
* specific code is provided, it does nothing.
*
* Its use and whether its necessary to be called is dependent on the
* platform.
*/
int mbedtls_platform_setup( mbedtls_platform_context *ctx );
/**
@ -322,8 +328,13 @@ int mbedtls_platform_setup( mbedtls_platform_context *ctx );
*
* \return 0 if successful
*
* \note This function should be after every other mbed TLS module has been
* correctly freed using the appropriate free function.
* \note This function should be called after every other mbed TLS module has
* been correctly freed using the appropriate free function.
* Its implementation is platform specific, and by default, unless
* platform specific code is provided, it does nothing.
*
* Its use and whether its necessary to be called is dependent on the
* platform.
*/
void mbedtls_platform_teardown( mbedtls_platform_context *ctx );