mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-01-03 23:43:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix doxygen warnings for generic names in config.h

Browse Source 
When we use the same documentation for a list of #defines, we used to use a
generic name in the \def command. Use the first name of the list instead so
that doxygen stops complaining, and mention the generic name in the longer
description.

This is not entirely satisfactory as the full list of macros will not be
included in the generated doc, but it's still an improvement as at least the
first macro is documented now, with a hint that there are others.
This commit is contained in:
Manuel Pégourié-Gonnard 2016-01-04 13:51:01 +01:00
parent 1989caf71c
commit 76da60c56e
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
include/mbedtls/config.h
View File

@ -131,10 +131,10 @@
//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS //#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
/** /**
* \def MBEDTLS_PLATFORM_XXX_ALT * \def MBEDTLS_PLATFORM_EXIT_ALT
* *
* Uncomment a macro to let mbed TLS support the function in the platform * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
* abstraction layer. * function in the platform abstraction layer.
* *
* Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
* provide a function "mbedtls_platform_set_printf()" that allows you to set an * provide a function "mbedtls_platform_set_printf()" that allows you to set an
@ -207,12 +207,12 @@
//#define MBEDTLS_TIMING_ALT //#define MBEDTLS_TIMING_ALT
/** /**
* \def MBEDTLS__MODULE_NAME__ALT * \def MBEDTLS_AES_ALT
* *
* Uncomment a macro to let mbed TLS use your alternate core implementation of * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
* a symmetric crypto or hash module (e.g. platform specific assembly * alternate core implementation of a symmetric crypto or hash module (e.g.
* optimized implementations). Keep in mind that the function prototypes * platform specific assembly optimized implementations). Keep in mind that
* should remain the same. * the function prototypes should remain the same.
* *
* This replaces the whole module. If you only want to replace one of the * This replaces the whole module. If you only want to replace one of the
* functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags. * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
@ -240,11 +240,11 @@
//#define MBEDTLS_SHA512_ALT //#define MBEDTLS_SHA512_ALT
/** /**
* \def MBEDTLS__FUNCTION_NAME__ALT * \def MBEDTLS_MD2_PROCESS_ALT
* *
* Uncomment a macro to let mbed TLS use you alternate core implementation of * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
* symmetric crypto or hash function. Keep in mind that function prototypes * alternate core implementation of symmetric crypto or hash function. Keep in
* should remain the same. * mind that function prototypes should remain the same.
* *
* This replaces only one function. The header file from mbed TLS is still * This replaces only one function. The header file from mbed TLS is still
* used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags. * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
@ -363,10 +363,11 @@
//#define MBEDTLS_CIPHER_NULL_CIPHER //#define MBEDTLS_CIPHER_NULL_CIPHER
/** /**
* \def MBEDTLS_CIPHER_PADDING_XXX * \def MBEDTLS_CIPHER_PADDING_PKCS7
* *
* Uncomment or comment macros to add support for specific padding modes * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
* in the cipher layer with cipher modes that support padding (e.g. CBC) * specific padding modes in the cipher layer with cipher modes that support
* padding (e.g. CBC)
* *
* If you disable all padding modes, only full blocks can be used with CBC. * If you disable all padding modes, only full blocks can be used with CBC.
* *
@ -406,10 +407,10 @@
#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES #define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
/** /**
* \def MBEDTLS_ECP_XXXX_ENABLED * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
* *
* Enables specific curves within the Elliptic Curve module. * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
* By default all supported curves are enabled. * module. By default all supported curves are enabled.
* *
* Comment macros to disable the curve and functions for it * Comment macros to disable the curve and functions for it
*/ */