From 6e4094c714d30f8a9162bf2eca330414f128098e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9B=D0=B5=D0=BE=D0=BD=D0=B8=D0=B4=20=D0=AE=D1=80=D1=8C?= =?UTF-8?q?=D0=B5=D0=B2=20=28Leonid=20Yuriev=29?= Date: Tue, 3 May 2022 12:05:16 +0300 Subject: [PATCH] mdbx-docs: refine `Build options` for Doxygen. --- docs/Doxyfile.in | 4 +++- src/options.h | 28 +++++++++++++++------------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 4049f810..f8d1cf27 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -947,7 +947,9 @@ EXCLUDE_SYMBOLS = NOMINMAX __ORDER_BIG_ENDIAN__ __ORDER_LITTLE_ENDIAN__ \ MDBX_NOSANITIZE_ENUM MDBX_PRINTF_ARGS \ MDBX_HAVE_CXX20_CONCEPTS \ CONSTEXPR_ENUM_FLAGS_OPERATIONS DEFINE_ENUM_FLAG_OPERATORS \ - bool false true __dll_export __dll_import + bool false true __dll_export __dll_import \ + MDBX_64BIT_ATOMIC_CONFIG MDBX_64BIT_CAS_CONFIG MDBX_ENV_CHECKPID_CONFIG MDBX_LOCKING_CONFIG \ + MDBX_TRUST_RTC_CONFIG MDBX_TXN_CHECKOWNER_CONFIG MDBX_USE_OFDLOCKS_CONFIG # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include diff --git a/src/options.h b/src/options.h index 797c1b0e..30ffdf1b 100644 --- a/src/options.h +++ b/src/options.h @@ -109,7 +109,7 @@ #error MDBX_DPL_PREALLOC_FOR_RADIXSORT must be defined as 0 or 1 #endif /* MDBX_DPL_PREALLOC_FOR_RADIXSORT */ -/* Basically, this build-option is for TODO. Guess it should be replaced +/** Basically, this build-option is for TODO. Guess it should be replaced * with MDBX_ENABLE_WRITEMAP_SPILLING with the three variants: * 0/OFF = Don't track dirty pages at all and don't spilling ones. * This should be by-default on Linux and may-be other systems @@ -172,15 +172,6 @@ #error MDBX_ASSUME_MALLOC_OVERHEAD must be defined in range 0..64 and be multiple of 4 #endif /* MDBX_ASSUME_MALLOC_OVERHEAD */ -/** In case the MDBX_DEBUG is undefined set it corresponding to NDEBUG */ -#ifndef MDBX_DEBUG -#ifdef NDEBUG -#define MDBX_DEBUG 0 -#else -#define MDBX_DEBUG 1 -#endif -#endif /* MDBX_DEBUG */ - /** If defined then enables integration with Valgrind, * a memory analyzing tool. */ #ifndef MDBX_USE_VALGRIND @@ -400,9 +391,20 @@ ******************************************************************************* ******************************************************************************/ -#ifdef DOXYGEN -/* !!! Actually this is a fake definitions !!! - * !!! for documentation generation by Doxygen !!! */ +#ifndef DOXYGEN + +/* In case the MDBX_DEBUG is undefined set it corresponding to NDEBUG */ +#ifndef MDBX_DEBUG +#ifdef NDEBUG +#define MDBX_DEBUG 0 +#else +#define MDBX_DEBUG 1 +#endif +#endif /* MDBX_DEBUG */ + +#else + +/* !!! Actually this is a fake definitions for Doxygen !!! */ /** Controls enabling of debugging features. *