lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-11-03 20:33:16 +03:00
Code Activity

Format literal # in a way that doesn't confuse older Doxygen

Browse Source 
With Doxygen 1.8.11 (as on Ubuntu 16.04), `#include` doesn't protect the
hash character enough, and Doxygen tries to link to something called
include. (Doxygen 1.8.17 doesn't have this problem.)

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2022-04-11 16:42:37 +02:00
parent 86198d71e3
commit d742baa134
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/mbedtls/config.h
View File

@@ -3641,9 +3641,9 @@
* `"mbedtls/mbedtls_config.h"`. * `"mbedtls/mbedtls_config.h"`.
* This header file specifies the compile-time configuration of Mbed TLS. * This header file specifies the compile-time configuration of Mbed TLS.
* *
* This macro is expanded after an `#include` directive. This is a popular but * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
* non-standard feature of the C language, so this feature is only available * non-standard feature of the C language, so this feature is only available
* with compilers that perform macro expansion on an `#include` line. * with compilers that perform macro expansion on an <tt>\#include</tt> line.
* *
* The value of this symbol is typically a path in double quotes, relative * The value of this symbol is typically a path in double quotes, relative
* to a directory on the include search pah. * to a directory on the include search pah.
@@ -3656,9 +3656,9 @@
* If defined, this is a header which will be included after * If defined, this is a header which will be included after
* `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE. * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
* *
* This macro is expanded after an `#include` directive. This is a popular but * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
* non-standard feature of the C language, so this feature is only available * non-standard feature of the C language, so this feature is only available
* with compilers that perform macro expansion on an `#include` line. * with compilers that perform macro expansion on an <tt>\#include</tt> line.
* *
* The value of this symbol is typically a path in double quotes, relative * The value of this symbol is typically a path in double quotes, relative
* to a directory on the include search pah. * to a directory on the include search pah.
@@ -3674,9 +3674,9 @@
* through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
* is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled. * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
* *
* This macro is expanded after an `#include` directive. This is a popular but * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
* non-standard feature of the C language, so this feature is only available * non-standard feature of the C language, so this feature is only available
* with compilers that perform macro expansion on an `#include` line. * with compilers that perform macro expansion on an <tt>\#include</tt> line.
* *
* The value of this symbol is typically a path in double quotes, relative * The value of this symbol is typically a path in double quotes, relative
* to a directory on the include search pah. * to a directory on the include search pah.
@@ -3689,9 +3689,9 @@
* If defined, this is a header which will be included after * If defined, this is a header which will be included after
* `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE. * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
* *
* This macro is expanded after an `#include` directive. This is a popular but * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
* non-standard feature of the C language, so this feature is only available * non-standard feature of the C language, so this feature is only available
* with compilers that perform macro expansion on an `#include` line. * with compilers that perform macro expansion on an <tt>\#include</tt> line.
* *
* The value of this symbol is typically a path in double quotes, relative * The value of this symbol is typically a path in double quotes, relative
* to a directory on the include search pah. * to a directory on the include search pah.