Improve documentation of mbedtls_platform_gmtime_r()
This commit is contained in:
parent
7dd82b4f51
commit
c52ef407ba
@ -146,12 +146,8 @@
|
||||
* Comment if your system does not have a correct clock.
|
||||
*
|
||||
* \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
|
||||
* behaves similarly to the gmtime() function from the C standard,
|
||||
* but is thread-safe. Mbed TLS will try to identify the underlying platform
|
||||
* and configure an appropriate underlying implementation (e.g. gmtime_r() for
|
||||
* POSIX and gmtime_s() for Windows). If this is not possible, then
|
||||
* gmtime() will be used. Refer to the documentation for
|
||||
* mbedtls_platform_gmtime_r() for more information.
|
||||
* behaves similarly to the gmtime_r() function from the C standard. Refer to
|
||||
* the documentation for mbedtls_platform_gmtime_r() for more information.
|
||||
*
|
||||
* \note It is possible to configure an implementation for
|
||||
* mbedtls_platform_gmtime_r() at compile-time by using the macro
|
||||
|
@ -67,14 +67,13 @@ void mbedtls_platform_zeroize( void *buf, size_t len );
|
||||
|
||||
#if defined(MBEDTLS_HAVE_TIME_DATE)
|
||||
/**
|
||||
* \brief Thread-safe implementation of gmtime()
|
||||
* \brief Platform-specific implementation of gmtime_r()
|
||||
*
|
||||
* The function is an abstraction that when called behaves similar
|
||||
* to the gmtime() function from the C standard, but is thread
|
||||
* safe.
|
||||
* The function is a thread-safe abstraction that behaves
|
||||
* similar to the gmtime_r() function from the C standard.
|
||||
*
|
||||
* Mbed TLS will try to identify the underlying platform and
|
||||
* configure an appropriate underlying implementation (e.g.
|
||||
* make use of an appropriate underlying implementation (e.g.
|
||||
* gmtime_r() for POSIX and gmtime_s() for Windows). If this is
|
||||
* not possible, then gmtime() will be used. In this case, calls
|
||||
* from the library to gmtime() will be guarded by the mutex
|
||||
|
Loading…
Reference in New Issue
Block a user