docs: Document files, enable files list

This commit is contained in:
Paweł Bylica 2019-04-24 18:02:14 +02:00
parent c2369f9d91
commit 33dce76f53
No known key found for this signature in database
GPG Key ID: 7A0C037434FE77EF
5 changed files with 36 additions and 9 deletions

View File

@ -100,7 +100,7 @@ WARN_LOGFILE =
# Configuration options related to the input files # Configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = \ 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/ \ docs/ \
examples/example_vm.c examples/example_vm.c
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
@ -109,7 +109,7 @@ RECURSIVE = NO
EXCLUDE = EXCLUDE =
EXCLUDE_SYMLINKS = NO EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS = internal EXCLUDE_SYMBOLS = internal std
EXAMPLE_PATH = EXAMPLE_PATH =
EXAMPLE_PATTERNS = EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO EXAMPLE_RECURSIVE = NO

29
docs/custom.dox Normal file
View File

@ -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
*/

View File

@ -9,11 +9,8 @@
#include <initializer_list> #include <initializer_list>
#include <utility> #include <utility>
/// @defgroup cpp EVMC C++
/// @copydoc evmc
/// @{
/// EVMC C++ API - wrappers and bindings for C++ /// EVMC C++ API - wrappers and bindings for C++
/// @ingroup cpp
namespace evmc namespace evmc
{ {
/// @copydoc evmc_result /// @copydoc evmc_result
@ -334,5 +331,3 @@ constexpr evmc_host_interface interface{
inline Host::Host() noexcept : evmc_context{&internal::interface} {} inline Host::Host() noexcept : evmc_context{&internal::interface} {}
} // namespace evmc } // namespace evmc
/// @}

View File

@ -6,7 +6,7 @@
/** /**
* EVMC Helpers * 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 * These are convenient for languages where invoking function pointers
* is "ugly" or impossible (such as Go). * is "ugly" or impossible (such as Go).
* *

View File

@ -6,6 +6,9 @@
#pragma once #pragma once
/** /**
* @file
* A collection of helper macros to handle some non-portable features of C/C++ compilers.
*
* @addtogroup helpers * @addtogroup helpers
* @{ * @{
*/ */