1
0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-08-08 17:42:09 +03:00

Add links for macros in doxygen documentation

Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
Manuel Pégourié-Gonnard
2023-02-23 09:40:24 +01:00
parent f3953c878e
commit 39a4f4285d
2 changed files with 8 additions and 8 deletions

View File

@@ -2644,7 +2644,7 @@
* \def MBEDTLS_MD_C * \def MBEDTLS_MD_C
* *
* Enable the generic layer for message digest (hashing) and HMAC. * Enable the generic layer for message digest (hashing) and HMAC.
* This will automatically enabled MBEDTLS_MD_LIGHT * This will automatically enable #MBEDTLS_MD_LIGHT
* *
* Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C, * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
* MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C, * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
@@ -2676,11 +2676,11 @@
/** /**
* \def MBEDTLS_MD_LIGHT * \def MBEDTLS_MD_LIGHT
* *
* Enable the "light" subset of MBEDTLS_MD_C: just hashing and basic * Enable the "light" subset of #MBEDTLS_MD_C: just hashing and basic
* meta-data (see md.h for details). * meta-data (see md.h for details).
* *
* This is automatically enabled whenever MBEDTLS_MD_C is enabled, but it is * This is automatically enabled whenever #MBEDTLS_MD_C is enabled, but it is
* possible to enable this without MBEDTLS_MD_C if support for HMAC or extra * possible to enable this without #MBEDTLS_MD_C if support for HMAC or extra
* metadata functions is not needed. * metadata functions is not needed.
* *
* Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C, * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,

View File

@@ -6,12 +6,12 @@
* *
* Availability of functions in this modules is controled by two * Availability of functions in this modules is controled by two
* feature macros: * feature macros:
* - MBEDTLS_MD_C enables the whole module; * - #MBEDTLS_MD_C enables the whole module;
* - MBEDTLS_MD_LIGHT enables only functions for hashing and accessing * - #MBEDTLS_MD_LIGHT enables only functions for hashing and accessing
* most hash metadata (everything except string names); is it * most hash metadata (everything except string names); is it
* automatically set whenever MBEDTLS_MD_C is defined. * automatically set whenever #MBEDTLS_MD_C is defined.
* *
* The functions that are only available when MBEDTLS_MD_C is defined * The functions that are only available when #MBEDTLS_MD_C is defined
* are grouped at the end of the file and guarded by this macro. * are grouped at the end of the file and guarded by this macro.
* *
* \author Adriaan de Jong <dejong@fox-it.com> * \author Adriaan de Jong <dejong@fox-it.com>