lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-28 00:21:48 +03:00
Code Activity

Enable certain documented defines only when generating doxygen

Browse Source 
Avoid an "unrecognized define" error.
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
This commit is contained in:
Andrzej Kurek
2023-07-03 06:52:37 -04:00
parent 04bfe5797b
commit 2b3c06edb3
3 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doxygen/mbedtls.doxyfile
View File

@ -51,4 +51,5 @@ PREDEFINED = "MBEDTLS_CHECK_RETURN_CRITICAL=" \
"MBEDTLS_CHECK_RETURN_TYPICAL=" \ "MBEDTLS_CHECK_RETURN_TYPICAL=" \
"MBEDTLS_CHECK_RETURN_OPTIONAL=" \ "MBEDTLS_CHECK_RETURN_OPTIONAL=" \
"MBEDTLS_PRINTF_ATTRIBUTE(a,b)=" \ "MBEDTLS_PRINTF_ATTRIBUTE(a,b)=" \
"__DOXYGEN__" \

2
include/mbedtls/mbedtls_config.h
View File

@ -3711,6 +3711,7 @@
* MBEDTLS_PLATFORM_STD_CALLOC and MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used, * MBEDTLS_PLATFORM_STD_CALLOC and MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
* dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases. * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
*/ */
/** \def MBEDTLS_PLATFORM_STD_CALLOC /** \def MBEDTLS_PLATFORM_STD_CALLOC
* *
* Default allocator to use, can be undefined. See the description above for details. * Default allocator to use, can be undefined. See the description above for details.
@ -3721,6 +3722,7 @@
* The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE. * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
*/ */
//#define MBEDTLS_PLATFORM_STD_CALLOC calloc //#define MBEDTLS_PLATFORM_STD_CALLOC calloc
/** \def MBEDTLS_PLATFORM_STD_FREE /** \def MBEDTLS_PLATFORM_STD_FREE
* *
* Default free to use, can be undefined. See the description above for more details (same principles as for MBEDTLS_PLATFORM_STD_CALLOC apply). * Default free to use, can be undefined. See the description above for more details (same principles as for MBEDTLS_PLATFORM_STD_CALLOC apply).

9
include/mbedtls/platform.h
View File

@ -130,6 +130,15 @@ extern "C" {
#endif #endif
#endif /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */ #endif /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */
/* Enable certain documented defines only when generating doxygen to avoid
* an "unrecognized define" error. */
#if defined(__DOXYGEN__) && !defined(MBEDTLS_PLATFORM_STD_CALLOC)
#define MBEDTLS_PLATFORM_STD_CALLOC
#endif
#if defined(__DOXYGEN__) && !defined(MBEDTLS_PLATFORM_STD_FREE)
#define MBEDTLS_PLATFORM_STD_FREE
#endif
/** \} name SECTION: Module settings */ /** \} name SECTION: Module settings */