From bdd0b487ae08cada8dce088e12d0861575a8f628 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: Thu, 20 Jun 2024 12:50:22 +0300 Subject: [PATCH] =?UTF-8?q?mdbx-doc:=20=D0=BA=D0=BE=D1=80=D1=80=D0=B5?= =?UTF-8?q?=D0=BA=D1=82=D0=B8=D1=80=D0=BE=D0=B2=D0=BA=D0=B8=20=D0=B4=D0=BB?= =?UTF-8?q?=D1=8F=20Doxygen.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Doxyfile.in | 62 ++++-------------------------------------------- mdbx.h | 6 ++--- 2 files changed, 7 insertions(+), 61 deletions(-) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index ca91f8b8..8158a457 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -1022,6 +1022,7 @@ EXCLUDE_SYMBOLS = NOMINMAX \ MDBX_HAVE_CXX20_CONCEPTS \ CONSTEXPR_ENUM_FLAGS_OPERATIONS \ DEFINE_ENUM_FLAG_OPERATORS \ + MDBX_DEPRECATED_ENUM \ bool \ false \ true \ @@ -1217,46 +1218,6 @@ USE_HTAGS = NO VERBATIM_HEADERS = YES -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: -# http://clang.llvm.org/) for more accurate parsing at the cost of reduced -# performance. This can be particularly helpful with template rich C++ code for -# which doxygen's built-in parser lacks the necessary type information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS -# tag is set to YES then doxygen will add the directory of each input to the -# include path. -# The default value is: YES. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_ADD_INC_PATHS = YES - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -# If clang assisted parsing is enabled you can provide the clang parser with the -# path to the directory containing a file called compile_commands.json. This -# file is the compilation database (see: -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the -# options used when the source files were built. This is equivalent to -# specifying the -p option to a clang tool, such as clang-check. These options -# will then be passed to the parser. Any options specified with CLANG_OPTIONS -# will be added as well. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. - -CLANG_DATABASE_PATH = - #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- @@ -1414,15 +1375,6 @@ HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will @@ -2083,14 +2035,6 @@ LATEX_HIDE_INDICES = NO LATEX_BIB_STYLE = plain -# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_TIMESTAMP = NO - # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) # path from which the emoji images will be read. If a relative path is entered, # it will be relative to the LATEX_OUTPUT directory. If left blank the @@ -2382,7 +2326,9 @@ PREDEFINED = DOXYGEN \ MDBX_CXX20_LIKELY=[[likely]] \ MDBX_CXX20_UNLIKELY=[[unlikely]] \ MDBX_MAYBE_UNUSED=[[maybe_unused]] \ - MDBX_DEPRECATED=[[deprecated]] + MDBX_DEPRECATED=[[deprecated]] \ + MDBX_DEPRECATED_ENUM=[[deprecated]] \ + "DEFINE_ENUM_FLAG_OPERATORS(ENUM)=" # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/mdbx.h b/mdbx.h index 7a7b25e0..cb3e2a51 100644 --- a/mdbx.h +++ b/mdbx.h @@ -523,7 +523,7 @@ typedef mode_t mdbx_mode_t; * - the proper implementation of DEFINE_ENUM_FLAG_OPERATORS for C++ required * the constexpr feature which is broken in most old compilers; * - DEFINE_ENUM_FLAG_OPERATORS may be defined broken as in the Windows SDK. */ -#ifndef DEFINE_ENUM_FLAG_OPERATORS +#if !defined(DEFINE_ENUM_FLAG_OPERATORS) && !defined(DOXYGEN) #ifdef __cplusplus #if !defined(__cpp_constexpr) || __cpp_constexpr < 200704L || \ @@ -1635,7 +1635,7 @@ typedef enum MDBX_db_flags { * application could determine the actual flags by \ref mdbx_dbi_flags(). */ MDBX_DB_ACCEDE = MDBX_ACCEDE } MDBX_db_flags_t; -DEFINE_ENUM_FLAG_OPERATORS(MDBX_db_flags_t) +DEFINE_ENUM_FLAG_OPERATORS(MDBX_db_flags) /** \brief Data changing flags * \ingroup c_crud @@ -6379,7 +6379,7 @@ typedef struct MDBX_chk_callbacks { * библиотеку. * * Проверка выполняется в несколько стадий, начиная с инициализации и до - * завершения, более подробно см \ref MDBX_chk_stage. О начале и завершении + * завершения, более подробно см \ref MDBX_chk_stage_t. О начале и завершении * каждой стадии код приложения уведомляется через соответствующие функции * обратного вызова, более подробно см \ref MDBX_chk_callbacks_t. *