From d742baa13489cb183d0a65d465f79ca1e5c146c5 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Mon, 11 Apr 2022 16:42:37 +0200 Subject: [PATCH] Format literal # in a way that doesn't confuse older Doxygen 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 --- include/mbedtls/config.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/include/mbedtls/config.h b/include/mbedtls/config.h index bf28de5fb..f8e9882f7 100644 --- a/include/mbedtls/config.h +++ b/include/mbedtls/config.h @@ -3641,9 +3641,9 @@ * `"mbedtls/mbedtls_config.h"`. * 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 \#include directive. This is a popular but * 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 \#include line. * * The value of this symbol is typically a path in double quotes, relative * to a directory on the include search pah. @@ -3656,9 +3656,9 @@ * If defined, this is a header which will be included after * `"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 \#include directive. This is a popular but * 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 \#include line. * * The value of this symbol is typically a path in double quotes, relative * to a directory on the include search pah. @@ -3674,9 +3674,9 @@ * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and * 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 \#include directive. This is a popular but * 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 \#include line. * * The value of this symbol is typically a path in double quotes, relative * to a directory on the include search pah. @@ -3689,9 +3689,9 @@ * If defined, this is a header which will be included after * `"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 \#include directive. This is a popular but * 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 \#include line. * * The value of this symbol is typically a path in double quotes, relative * to a directory on the include search pah.