From 33dce76f535aaca62d61cc9cf39efb6b0df6e151 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Bylica?= Date: Wed, 24 Apr 2019 18:02:14 +0200 Subject: [PATCH] docs: Document files, enable files list --- Doxyfile | 4 ++-- docs/custom.dox | 29 +++++++++++++++++++++++++++++ include/evmc/evmc.hpp | 7 +------ include/evmc/helpers.h | 2 +- include/evmc/utils.h | 3 +++ 5 files changed, 36 insertions(+), 9 deletions(-) create mode 100644 docs/custom.dox diff --git a/Doxyfile b/Doxyfile index 153a9f2..37206d2 100644 --- a/Doxyfile +++ b/Doxyfile @@ -100,7 +100,7 @@ WARN_LOGFILE = # Configuration options related to the input files #--------------------------------------------------------------------------- INPUT = \ - include/evmc/evmc.h include/evmc/evmc.hpp include/evmc/helpers.h include/evmc/helpers.hpp include/evmc/loader.h include/evmc/utils.h include/evmc/instructions.h \ + include/evmc/ \ docs/ \ examples/example_vm.c INPUT_ENCODING = UTF-8 @@ -109,7 +109,7 @@ RECURSIVE = NO EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = internal +EXCLUDE_SYMBOLS = internal std EXAMPLE_PATH = EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO diff --git a/docs/custom.dox b/docs/custom.dox new file mode 100644 index 0000000..b02da3e --- /dev/null +++ b/docs/custom.dox @@ -0,0 +1,29 @@ +/** + * @defgroup cpp EVMC C++ + * @copydoc evmc + */ + +/** + * @file evmc.h + * @copydoc EVMC + */ + +/** + * @file evmc.hpp + * @copydoc cpp + */ + +/** + * @file helpers.h + * @copydoc helpers + */ + +/** + * @file instructions.h + * @copydoc instructions + */ + +/** + * @file loader.h + * @copydoc loader + */ diff --git a/include/evmc/evmc.hpp b/include/evmc/evmc.hpp index 0c9ad44..4e820b0 100644 --- a/include/evmc/evmc.hpp +++ b/include/evmc/evmc.hpp @@ -9,11 +9,8 @@ #include #include -/// @defgroup cpp EVMC C++ -/// @copydoc evmc -/// @{ - /// EVMC C++ API - wrappers and bindings for C++ +/// @ingroup cpp namespace evmc { /// @copydoc evmc_result @@ -334,5 +331,3 @@ constexpr evmc_host_interface interface{ inline Host::Host() noexcept : evmc_context{&internal::interface} {} } // namespace evmc - -/// @} diff --git a/include/evmc/helpers.h b/include/evmc/helpers.h index 54ccefd..9273e2b 100644 --- a/include/evmc/helpers.h +++ b/include/evmc/helpers.h @@ -6,7 +6,7 @@ /** * EVMC Helpers * - * A collection of helper functions for invoking a VM instance methods. + * A collection of C helper functions for invoking a VM instance methods. * These are convenient for languages where invoking function pointers * is "ugly" or impossible (such as Go). * diff --git a/include/evmc/utils.h b/include/evmc/utils.h index 0642a36..03715c0 100644 --- a/include/evmc/utils.h +++ b/include/evmc/utils.h @@ -6,6 +6,9 @@ #pragma once /** + * @file + * A collection of helper macros to handle some non-portable features of C/C++ compilers. + * * @addtogroup helpers * @{ */