forked from boostorg/beast
Doc tidy
This commit is contained in:
1 parent
31331bbe4d
commit
8e2620e2b1
41 files changed
+171
-250
No files matched your search
@@ -15,8 +15,8 @@ scheduled to become an official part of C++ no sooner than the year
|
||||
2023. Three implementations exist, with cosmetic differences but
|
||||
otherwise using the same function signatures and type declarations:
|
||||
Boost.Asio, stand-alone Asio, and networking-ts-impl. This table shows
|
||||
how a variable of the each library's `io_context` type is declared by
|
||||
including the appropriate header and using a suitable namespace alias:
|
||||
how a variable of type `io_context` is declared in each implementation
|
||||
by including the appropriate header and using a suitable namespace alias:
|
||||
|
||||
[table Networking Implementations
|
||||
[[Name][Namespace and Header Example ]]
|
||||
|
||||
@@ -87,6 +87,7 @@
|
||||
[def __Body__ [link beast.concepts.Body ['Body]]]
|
||||
[def __BodyReader__ [link beast.concepts.BodyReader ['BodyReader]]]
|
||||
[def __BodyWriter__ [link beast.concepts.BodyWriter ['BodyWriter]]]
|
||||
[def __BufferSequence__ [link beast.concepts.BufferSequence ['BufferSequence]]]
|
||||
[def __DynamicBuffer__ [link beast.concepts.DynamicBuffer ['DynamicBuffer]]]
|
||||
[def __Fields__ [link beast.concepts.Fields ['Fields]]]
|
||||
[def __FieldsWriter__ [link beast.concepts.FieldsWriter ['FieldsWriter]]]
|
||||
|
||||
+54
-52
@@ -1,3 +1,57 @@
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the input files
|
||||
#---------------------------------------------------------------------------
|
||||
INPUT = \
|
||||
$(LIB_DIR)/include/boost/beast/ \
|
||||
$(LIB_DIR)/include/boost/beast/_experimental/http \
|
||||
$(LIB_DIR)/include/boost/beast/_experimental/test \
|
||||
$(LIB_DIR)/include/boost/beast/core \
|
||||
$(LIB_DIR)/include/boost/beast/http \
|
||||
$(LIB_DIR)/include/boost/beast/ssl \
|
||||
$(LIB_DIR)/include/boost/beast/websocket \
|
||||
$(LIB_DIR)/include/boost/beast/zlib
|
||||
|
||||
|
||||
INPUT_ENCODING = UTF-8
|
||||
FILE_PATTERNS =
|
||||
RECURSIVE = NO
|
||||
EXCLUDE =
|
||||
EXCLUDE_SYMLINKS = NO
|
||||
EXCLUDE_PATTERNS =
|
||||
EXCLUDE_SYMBOLS =
|
||||
EXAMPLE_PATH =
|
||||
EXAMPLE_PATTERNS =
|
||||
EXAMPLE_RECURSIVE = NO
|
||||
IMAGE_PATH =
|
||||
INPUT_FILTER =
|
||||
FILTER_PATTERNS =
|
||||
FILTER_SOURCE_FILES = NO
|
||||
FILTER_SOURCE_PATTERNS =
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the preprocessor
|
||||
#---------------------------------------------------------------------------
|
||||
ENABLE_PREPROCESSING = YES
|
||||
MACRO_EXPANSION = YES
|
||||
EXPAND_ONLY_PREDEF = YES
|
||||
SEARCH_INCLUDES = YES
|
||||
INCLUDE_PATH = ../
|
||||
INCLUDE_FILE_PATTERNS =
|
||||
|
||||
PREDEFINED = \
|
||||
BOOST_BEAST_DOXYGEN \
|
||||
BOOST_BEAST_USE_POSIX_FILE=1 \
|
||||
BOOST_BEAST_USE_WIN32_FILE=1 \
|
||||
BOOST_BEAST_SPLIT_COMPILATION=1 \
|
||||
BOOST_BEAST_ASYNC_RESULT1(t)=__deduced__ \
|
||||
BOOST_BEAST_ASYNC_RESULT1(t)=__deduced__ \
|
||||
BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=__deduced__ \
|
||||
GENERATING_DOCUMENTATION \
|
||||
BOOST_BEAST_DECL
|
||||
EXPAND_AS_DEFINED =
|
||||
SKIP_FUNCTION_MACROS = YES
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Project related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -99,37 +153,6 @@ WARN_NO_PARAMDOC = NO
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
WARN_LOGFILE =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the input files
|
||||
#---------------------------------------------------------------------------
|
||||
INPUT = \
|
||||
$(LIB_DIR)/include/boost/beast/ \
|
||||
$(LIB_DIR)/include/boost/beast/_experimental/http \
|
||||
$(LIB_DIR)/include/boost/beast/_experimental/test \
|
||||
$(LIB_DIR)/include/boost/beast/core \
|
||||
$(LIB_DIR)/include/boost/beast/http \
|
||||
$(LIB_DIR)/include/boost/beast/ssl \
|
||||
$(LIB_DIR)/include/boost/beast/websocket \
|
||||
$(LIB_DIR)/include/boost/beast/zlib
|
||||
|
||||
|
||||
INPUT_ENCODING = UTF-8
|
||||
FILE_PATTERNS =
|
||||
RECURSIVE = NO
|
||||
EXCLUDE =
|
||||
EXCLUDE_SYMLINKS = NO
|
||||
EXCLUDE_PATTERNS =
|
||||
EXCLUDE_SYMBOLS =
|
||||
EXAMPLE_PATH =
|
||||
EXAMPLE_PATTERNS =
|
||||
EXAMPLE_RECURSIVE = NO
|
||||
IMAGE_PATH =
|
||||
INPUT_FILTER =
|
||||
FILTER_PATTERNS =
|
||||
FILTER_SOURCE_FILES = NO
|
||||
FILTER_SOURCE_PATTERNS =
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to source browsing
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -227,27 +250,6 @@ GENERATE_XML = YES
|
||||
XML_OUTPUT = $(XML_OUTPUT)
|
||||
XML_PROGRAMLISTING = YES
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the preprocessor
|
||||
#---------------------------------------------------------------------------
|
||||
ENABLE_PREPROCESSING = YES
|
||||
MACRO_EXPANSION = YES
|
||||
EXPAND_ONLY_PREDEF = YES
|
||||
SEARCH_INCLUDES = YES
|
||||
INCLUDE_PATH = ../
|
||||
INCLUDE_FILE_PATTERNS =
|
||||
|
||||
PREDEFINED = \
|
||||
BOOST_BEAST_DOXYGEN \
|
||||
BOOST_BEAST_USE_POSIX_FILE=1 \
|
||||
BOOST_BEAST_USE_WIN32_FILE=1 \
|
||||
BOOST_BEAST_SPLIT_COMPILATION=1 \
|
||||
BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=__deduced__ \
|
||||
GENERATING_DOCUMENTATION \
|
||||
BOOST_BEAST_DECL
|
||||
EXPAND_AS_DEFINED =
|
||||
SKIP_FUNCTION_MACROS = YES
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to external references
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
Reference in new issue
Block a user