feedc0de/boost_beast
1
0
Fork 0
forked from boostorg/beast
Code Pull Requests Activity

Rename to BEAST_DOXYGEN

Browse Source 
fix #316
This commit is contained in:
Vinnie Falco
2017-04-22 14:56:09 -07:00
parent e7319aade1
commit 34830a1780
37 changed files with 98 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -4,6 +4,7 @@
* Tidy up MSVC CMake configuration * Tidy up MSVC CMake configuration
* Make close_code a proper enum * Make close_code a proper enum
* Add flat_streambuf * Add flat_streambuf
* Rename to BEAST_DOXYGEN
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------

3
doc/source.dox
View File

@@ -282,8 +282,7 @@ EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES SEARCH_INCLUDES = YES
INCLUDE_PATH = ../ INCLUDE_PATH = ../
INCLUDE_FILE_PATTERNS = INCLUDE_FILE_PATTERNS =
PREDEFINED = DOXYGEN \ PREDEFINED = BEAST_DOXYGEN
GENERATING_DOCS
EXPAND_AS_DEFINED = EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES SKIP_FUNCTION_MACROS = YES

2
extras/beast/doc_debug.hpp
View File

@@ -10,7 +10,7 @@
namespace beast { namespace beast {
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// doc type (documentation debug helper) /// doc type (documentation debug helper)
using doc_type = int; using doc_type = int;

2
extras/beast/test/yield_to.hpp
View File

@@ -79,7 +79,7 @@ public:
@param args Optional arguments forwarded to the callable object. @param args Optional arguments forwarded to the callable object.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class F, class... Args> template<class F, class... Args>
void void
yield_to(F&& f, Args&&... args); yield_to(F&& f, Args&&... args);

2
include/beast/core/bind_handler.hpp
View File

@@ -50,7 +50,7 @@ namespace beast {
arguments are forwarded into the returned object. arguments are forwarded into the returned object.
*/ */
template<class Handler, class... Args> template<class Handler, class... Args>
#if GENERATING_DOCS #if BEAST_DOXYGEN
implementation_defined implementation_defined
#else #else
detail::bound_handler< detail::bound_handler<

2
include/beast/core/buffer_cat.hpp
View File

@@ -37,7 +37,7 @@ namespace beast {
also a @b MutableBufferSequence, else the returned buffer sequence also a @b MutableBufferSequence, else the returned buffer sequence
will be a @b ConstBufferSequence. will be a @b ConstBufferSequence.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class... BufferSequence> template<class... BufferSequence>
implementation_defined implementation_defined
buffer_cat(BufferSequence const&... buffers) buffer_cat(BufferSequence const&... buffers)

8
include/beast/core/buffer_concepts.hpp
View File

@@ -17,7 +17,7 @@ namespace beast {
/// Determine if `T` meets the requirements of @b `BufferSequence`. /// Determine if `T` meets the requirements of @b `BufferSequence`.
template<class T, class BufferType> template<class T, class BufferType>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_BufferSequence : std::integral_constant<bool, ...> struct is_BufferSequence : std::integral_constant<bool, ...>
#else #else
struct is_BufferSequence : detail::is_BufferSequence<T, BufferType>::type struct is_BufferSequence : detail::is_BufferSequence<T, BufferType>::type
@@ -27,7 +27,7 @@ struct is_BufferSequence : detail::is_BufferSequence<T, BufferType>::type
/// Determine if `T` meets the requirements of @b `ConstBufferSequence`. /// Determine if `T` meets the requirements of @b `ConstBufferSequence`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_ConstBufferSequence : std::integral_constant<bool, ...> struct is_ConstBufferSequence : std::integral_constant<bool, ...>
#else #else
struct is_ConstBufferSequence : struct is_ConstBufferSequence :
@@ -38,7 +38,7 @@ struct is_ConstBufferSequence :
/// Determine if `T` meets the requirements of @b `DynamicBuffer`. /// Determine if `T` meets the requirements of @b `DynamicBuffer`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_DynamicBuffer : std::integral_constant<bool, ...> struct is_DynamicBuffer : std::integral_constant<bool, ...>
#else #else
struct is_DynamicBuffer : detail::is_DynamicBuffer<T>::type struct is_DynamicBuffer : detail::is_DynamicBuffer<T>::type
@@ -48,7 +48,7 @@ struct is_DynamicBuffer : detail::is_DynamicBuffer<T>::type
/// Determine if `T` meets the requirements of @b `MutableBufferSequence`. /// Determine if `T` meets the requirements of @b `MutableBufferSequence`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_MutableBufferSequence : std::integral_constant<bool, ...> struct is_MutableBufferSequence : std::integral_constant<bool, ...>
#else #else
struct is_MutableBufferSequence : struct is_MutableBufferSequence :

2
include/beast/core/buffers_adapter.hpp
View File

@@ -64,7 +64,7 @@ class buffers_adapter
} }
public: public:
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// The type used to represent the input sequence as a list of buffers. /// The type used to represent the input sequence as a list of buffers.
using const_buffers_type = implementation_defined; using const_buffers_type = implementation_defined;

4
include/beast/core/consuming_buffers.hpp
View File

@@ -59,7 +59,7 @@ public:
`boost::asio::mutable_buffer`, else this type will be `boost::asio::mutable_buffer`, else this type will be
`boost::asio::const_buffer`. `boost::asio::const_buffer`.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using value_type = ...; using value_type = ...;
#else #else
using value_type = typename std::conditional< using value_type = typename std::conditional<
@@ -70,7 +70,7 @@ public:
boost::asio::const_buffer>::type; boost::asio::const_buffer>::type;
#endif #endif
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// A bidirectional iterator type that may be used to read elements. /// A bidirectional iterator type that may be used to read elements.
using const_iterator = implementation_defined; using const_iterator = implementation_defined;

2
include/beast/core/detail/prepare_buffers.hpp
View File

@@ -61,7 +61,7 @@ public:
boost::asio::mutable_buffer, boost::asio::mutable_buffer,
boost::asio::const_buffer>::type; boost::asio::const_buffer>::type;
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// A bidirectional iterator type that may be used to read elements. /// A bidirectional iterator type that may be used to read elements.
using const_iterator = implementation_defined; using const_iterator = implementation_defined;

6
include/beast/core/dynabuf_readstream.hpp
View File

@@ -110,7 +110,7 @@ public:
/// The type of the lowest layer. /// The type of the lowest layer.
using lowest_layer_type = using lowest_layer_type =
#if GENERATING_DOCS #if BEAST_DOXYGEN
implementation_defined; implementation_defined;
#else #else
typename detail::get_lowest_layer< typename detail::get_lowest_layer<
@@ -272,7 +272,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class MutableBufferSequence, class ReadHandler> template<class MutableBufferSequence, class ReadHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion<ReadHandler, void(error_code)>::result_type typename async_completion<ReadHandler, void(error_code)>::result_type
@@ -347,7 +347,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class ConstBufferSequence, class WriteHandler> template<class ConstBufferSequence, class WriteHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion<WriteHandler, void(error_code)>::result_type typename async_completion<WriteHandler, void(error_code)>::result_type

4
include/beast/core/error.hpp
View File

@@ -24,7 +24,7 @@ using system_error = boost::system::system_error;
using error_category = boost::system::error_category; using error_category = boost::system::error_category;
/// A function to return the system error category used by the library /// A function to return the system error category used by the library
#if GENERATING_DOCS #if BEAST_DOXYGEN
error_category const& error_category const&
system_category(); system_category();
#else #else
@@ -35,7 +35,7 @@ using boost::system::system_category;
using error_condition = boost::system::error_condition; using error_condition = boost::system::error_condition;
/// The set of constants used for cross-platform error codes /// The set of constants used for cross-platform error codes
#if GENERATING_DOCS #if BEAST_DOXYGEN
enum errc{}; enum errc{};
#else #else
namespace errc = boost::system::errc; namespace errc = boost::system::errc;

4
include/beast/core/flat_streambuf.hpp
View File

@@ -35,14 +35,14 @@ namespace beast {
*/ */
template<class Allocator> template<class Allocator>
class basic_flat_streambuf class basic_flat_streambuf
#if ! GENERATING_DOCS #if ! BEAST_DOXYGEN
: private detail::empty_base_optimization< : private detail::empty_base_optimization<
typename std::allocator_traits<Allocator>:: typename std::allocator_traits<Allocator>::
template rebind_alloc<char>> template rebind_alloc<char>>
#endif #endif
{ {
public: public:
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// The type of allocator used. /// The type of allocator used.
using allocator_type = Allocator; using allocator_type = Allocator;
#else #else

2
include/beast/core/handler_alloc.hpp
View File

@@ -35,7 +35,7 @@ namespace beast {
the handler is invoked or undefined behavior results. This behavior the handler is invoked or undefined behavior results. This behavior
is described as the "deallocate before invocation" Asio guarantee. is described as the "deallocate before invocation" Asio guarantee.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class T, class Handler> template<class T, class Handler>
class handler_alloc; class handler_alloc;
#else #else

2
include/beast/core/handler_concepts.hpp
View File

@@ -16,7 +16,7 @@ namespace beast {
/// Determine if `T` meets the requirements of @b `CompletionHandler`. /// Determine if `T` meets the requirements of @b `CompletionHandler`.
template<class T, class Signature> template<class T, class Signature>
#if GENERATING_DOCS #if BEAST_DOXYGEN
using is_CompletionHandler = std::integral_constant<bool, ...>; using is_CompletionHandler = std::integral_constant<bool, ...>;
#else #else
using is_CompletionHandler = std::integral_constant<bool, using is_CompletionHandler = std::integral_constant<bool,

2
include/beast/core/prepare_buffers.hpp
View File

@@ -37,7 +37,7 @@ namespace beast {
memory is not transferred. memory is not transferred.
*/ */
template<class BufferSequence> template<class BufferSequence>
#if GENERATING_DOCS #if BEAST_DOXYGEN
implementation_defined implementation_defined
#else #else
inline inline

12
include/beast/core/static_streambuf.hpp
View File

@@ -28,7 +28,7 @@ namespace beast {
*/ */
class static_streambuf class static_streambuf
{ {
#if GENERATING_DOCS #if BEAST_DOXYGEN
private: private:
#else #else
protected: protected:
@@ -40,7 +40,7 @@ protected:
std::uint8_t* end_; std::uint8_t* end_;
public: public:
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// The type used to represent the input sequence as a list of buffers. /// The type used to represent the input sequence as a list of buffers.
using const_buffers_type = implementation_defined; using const_buffers_type = implementation_defined;
@@ -116,7 +116,7 @@ public:
in_ += std::min<std::size_t>(n, out_ - in_); in_ += std::min<std::size_t>(n, out_ - in_);
} }
#if GENERATING_DOCS #if BEAST_DOXYGEN
private: private:
#else #else
protected: protected:
@@ -150,7 +150,7 @@ protected:
template<std::size_t N> template<std::size_t N>
class static_streambuf_n class static_streambuf_n
: public static_streambuf : public static_streambuf
#if ! GENERATING_DOCS #if ! BEAST_DOXYGEN
, private boost::base_from_member< , private boost::base_from_member<
std::array<std::uint8_t, N>> std::array<std::uint8_t, N>>
#endif #endif
@@ -158,14 +158,14 @@ class static_streambuf_n
using member_type = boost::base_from_member< using member_type = boost::base_from_member<
std::array<std::uint8_t, N>>; std::array<std::uint8_t, N>>;
public: public:
#if GENERATING_DOCS #if BEAST_DOXYGEN
private: private:
#endif #endif
static_streambuf_n( static_streambuf_n(
static_streambuf_n const&) = delete; static_streambuf_n const&) = delete;
static_streambuf_n& operator=( static_streambuf_n& operator=(
static_streambuf_n const&) = delete; static_streambuf_n const&) = delete;
#if GENERATING_DOCS #if BEAST_DOXYGEN
public: public:
#endif #endif

14
include/beast/core/stream_concepts.hpp
View File

@@ -16,7 +16,7 @@ namespace beast {
/// Determine if `T` has the `get_io_service` member. /// Determine if `T` has the `get_io_service` member.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct has_get_io_service : std::integral_constant<bool, ...>{}; struct has_get_io_service : std::integral_constant<bool, ...>{};
#else #else
using has_get_io_service = typename detail::has_get_io_service<T>::type; using has_get_io_service = typename detail::has_get_io_service<T>::type;
@@ -24,7 +24,7 @@ using has_get_io_service = typename detail::has_get_io_service<T>::type;
/// Determine if `T` meets the requirements of @b `AsyncReadStream`. /// Determine if `T` meets the requirements of @b `AsyncReadStream`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_AsyncReadStream : std::integral_constant<bool, ...>{}; struct is_AsyncReadStream : std::integral_constant<bool, ...>{};
#else #else
using is_AsyncReadStream = typename detail::is_AsyncReadStream<T>::type; using is_AsyncReadStream = typename detail::is_AsyncReadStream<T>::type;
@@ -32,7 +32,7 @@ using is_AsyncReadStream = typename detail::is_AsyncReadStream<T>::type;
/// Determine if `T` meets the requirements of @b `AsyncWriteStream`. /// Determine if `T` meets the requirements of @b `AsyncWriteStream`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_AsyncWriteStream : std::integral_constant<bool, ...>{}; struct is_AsyncWriteStream : std::integral_constant<bool, ...>{};
#else #else
using is_AsyncWriteStream = typename detail::is_AsyncWriteStream<T>::type; using is_AsyncWriteStream = typename detail::is_AsyncWriteStream<T>::type;
@@ -40,7 +40,7 @@ using is_AsyncWriteStream = typename detail::is_AsyncWriteStream<T>::type;
/// Determine if `T` meets the requirements of @b `SyncReadStream`. /// Determine if `T` meets the requirements of @b `SyncReadStream`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_SyncReadStream : std::integral_constant<bool, ...>{}; struct is_SyncReadStream : std::integral_constant<bool, ...>{};
#else #else
using is_SyncReadStream = typename detail::is_SyncReadStream<T>::type; using is_SyncReadStream = typename detail::is_SyncReadStream<T>::type;
@@ -48,7 +48,7 @@ using is_SyncReadStream = typename detail::is_SyncReadStream<T>::type;
/// Determine if `T` meets the requirements of @b `SyncWriterStream`. /// Determine if `T` meets the requirements of @b `SyncWriterStream`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_SyncWriteStream : std::integral_constant<bool, ...>{}; struct is_SyncWriteStream : std::integral_constant<bool, ...>{};
#else #else
using is_SyncWriteStream = typename detail::is_SyncWriteStream<T>::type; using is_SyncWriteStream = typename detail::is_SyncWriteStream<T>::type;
@@ -56,7 +56,7 @@ using is_SyncWriteStream = typename detail::is_SyncWriteStream<T>::type;
/// Determine if `T` meets the requirements of @b `AsyncStream`. /// Determine if `T` meets the requirements of @b `AsyncStream`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_AsyncStream : std::integral_constant<bool, ...>{}; struct is_AsyncStream : std::integral_constant<bool, ...>{};
#else #else
using is_AsyncStream = std::integral_constant<bool, using is_AsyncStream = std::integral_constant<bool,
@@ -65,7 +65,7 @@ using is_AsyncStream = std::integral_constant<bool,
/// Determine if `T` meets the requirements of @b `SyncStream`. /// Determine if `T` meets the requirements of @b `SyncStream`.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_SyncStream : std::integral_constant<bool, ...>{}; struct is_SyncStream : std::integral_constant<bool, ...>{};
#else #else
using is_SyncStream = std::integral_constant<bool, using is_SyncStream = std::integral_constant<bool,

6
include/beast/core/streambuf.hpp
View File

@@ -32,14 +32,14 @@ namespace beast {
*/ */
template<class Allocator> template<class Allocator>
class basic_streambuf class basic_streambuf
#if ! GENERATING_DOCS #if ! BEAST_DOXYGEN
: private detail::empty_base_optimization< : private detail::empty_base_optimization<
typename std::allocator_traits<Allocator>:: typename std::allocator_traits<Allocator>::
template rebind_alloc<char>> template rebind_alloc<char>>
#endif #endif
{ {
public: public:
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// The type of allocator used. /// The type of allocator used.
using allocator_type = Allocator; using allocator_type = Allocator;
#else #else
@@ -81,7 +81,7 @@ private:
size_type out_end_ = 0; // output end offset in list_.back() size_type out_end_ = 0; // output end offset in list_.back()
public: public:
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// The type used to represent the input sequence as a list of buffers. /// The type used to represent the input sequence as a list of buffers.
using const_buffers_type = implementation_defined; using const_buffers_type = implementation_defined;

2
include/beast/core/to_string.hpp
View File

@@ -29,7 +29,7 @@ namespace beast {
the buffers parameter meets the requirements of @b `ConstBufferSequence`. the buffers parameter meets the requirements of @b `ConstBufferSequence`.
*/ */
template<class ConstBufferSequence> template<class ConstBufferSequence>
#if GENERATING_DOCS #if BEAST_DOXYGEN
std::string std::string
#else #else
typename std::enable_if< typename std::enable_if<

2
include/beast/core/write_dynabuf.hpp
View File

@@ -49,7 +49,7 @@ namespace beast {
the `dynabuf` parameter meets the requirements of @b `DynamicBuffer`. the `dynabuf` parameter meets the requirements of @b `DynamicBuffer`.
*/ */
template<class DynamicBuffer, class... Args> template<class DynamicBuffer, class... Args>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void void
#else #else
typename std::enable_if<is_DynamicBuffer<DynamicBuffer>::value>::type typename std::enable_if<is_DynamicBuffer<DynamicBuffer>::value>::type

2
include/beast/http/basic_dynabuf_body.hpp
View File

@@ -27,7 +27,7 @@ struct basic_dynabuf_body
/// The type of the `message::body` member /// The type of the `message::body` member
using value_type = DynamicBuffer; using value_type = DynamicBuffer;
#if GENERATING_DOCS #if BEAST_DOXYGEN
private: private:
#endif #endif

8
include/beast/http/basic_fields.hpp
View File

@@ -39,7 +39,7 @@ namespace http {
*/ */
template<class Allocator> template<class Allocator>
class basic_fields : class basic_fields :
#if ! GENERATING_DOCS #if ! BEAST_DOXYGEN
private beast::detail::empty_base_optimization< private beast::detail::empty_base_optimization<
typename std::allocator_traits<Allocator>:: typename std::allocator_traits<Allocator>::
template rebind_alloc< template rebind_alloc<
@@ -89,17 +89,17 @@ public:
Meets the requirements of @b Field. Meets the requirements of @b Field.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using value_type = implementation_defined; using value_type = implementation_defined;
#endif #endif
/// A const iterator to the field sequence /// A const iterator to the field sequence
#if GENERATING_DOCS #if BEAST_DOXYGEN
using iterator = implementation_defined; using iterator = implementation_defined;
#endif #endif
/// A const iterator to the field sequence /// A const iterator to the field sequence
#if GENERATING_DOCS #if BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = implementation_defined;
#endif #endif

4
include/beast/http/basic_parser_v1.hpp
View File

@@ -308,7 +308,7 @@ public:
@param args One or more parser options to set. @param args One or more parser options to set.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class... Args> template<class... Args>
void void
set_option(Args&&... args) set_option(Args&&... args)
@@ -449,7 +449,7 @@ public:
@return The number of bytes consumed in the input sequence. @return The number of bytes consumed in the input sequence.
*/ */
template<class ConstBufferSequence> template<class ConstBufferSequence>
#if GENERATING_DOCS #if BEAST_DOXYGEN
std::size_t std::size_t
#else #else
typename std::enable_if< typename std::enable_if<

4
include/beast/http/chunk_encode.hpp
View File

@@ -36,7 +36,7 @@ namespace http {
@see <a href=https://tools.ietf.org/html/rfc7230#section-4.1.3>rfc7230 section 4.1.3</a> @see <a href=https://tools.ietf.org/html/rfc7230#section-4.1.3>rfc7230 section 4.1.3</a>
*/ */
template<class ConstBufferSequence> template<class ConstBufferSequence>
#if GENERATING_DOCS #if BEAST_DOXYGEN
implementation_defined implementation_defined
#else #else
beast::detail::buffer_cat_helper< beast::detail::buffer_cat_helper<
@@ -59,7 +59,7 @@ chunk_encode(bool fin, ConstBufferSequence const& buffers)
@see <a href=https://tools.ietf.org/html/rfc7230#section-4.1.3>rfc7230 section 4.1.3</a> @see <a href=https://tools.ietf.org/html/rfc7230#section-4.1.3>rfc7230 section 4.1.3</a>
*/ */
inline inline
#if GENERATING_DOCS #if BEAST_DOXYGEN
implementation_defined implementation_defined
#else #else
boost::asio::const_buffers_1 boost::asio::const_buffers_1

12
include/beast/http/concepts.hpp
View File

@@ -129,7 +129,7 @@ public:
/// Determine if `T` meets the requirements of @b Body. /// Determine if `T` meets the requirements of @b Body.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_Body : std::integral_constant<bool, ...>{}; struct is_Body : std::integral_constant<bool, ...>{};
#else #else
using is_Body = detail::has_value_type<T>; using is_Body = detail::has_value_type<T>;
@@ -140,7 +140,7 @@ using is_Body = detail::has_value_type<T>;
@tparam T The type to check, which must meet the @tparam T The type to check, which must meet the
requirements of @b Body. requirements of @b Body.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class T> template<class T>
struct has_reader : std::integral_constant<bool, ...>{}; struct has_reader : std::integral_constant<bool, ...>{};
#else #else
@@ -158,7 +158,7 @@ struct has_reader<T, beast::detail::void_t<
@tparam T The type to check, which must meet the @tparam T The type to check, which must meet the
requirements of @b Body. requirements of @b Body.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class T> template<class T>
struct has_writer : std::integral_constant<bool, ...>{}; struct has_writer : std::integral_constant<bool, ...>{};
#else #else
@@ -178,7 +178,7 @@ struct has_writer<T, beast::detail::void_t<
@tparam M The message type to test with, which must be of @tparam M The message type to test with, which must be of
type `message`. type `message`.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class T, class M> template<class T, class M>
struct is_Reader : std::integral_constant<bool, ...> {}; struct is_Reader : std::integral_constant<bool, ...> {};
#else #else
@@ -211,7 +211,7 @@ struct is_Reader<T, M, beast::detail::void_t<decltype(
type `message`. type `message`.
*/ */
template<class T, class M> template<class T, class M>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_Writer : std::integral_constant<bool, ...> {}; struct is_Writer : std::integral_constant<bool, ...> {};
#else #else
using is_Writer = typename detail::is_Writer<T, M>::type; using is_Writer = typename detail::is_Writer<T, M>::type;
@@ -219,7 +219,7 @@ using is_Writer = typename detail::is_Writer<T, M>::type;
/// Determine if `T` meets the requirements of @b Parser. /// Determine if `T` meets the requirements of @b Parser.
template<class T> template<class T>
#if GENERATING_DOCS #if BEAST_DOXYGEN
struct is_Parser : std::integral_constant<bool, ...>{}; struct is_Parser : std::integral_constant<bool, ...>{};
#else #else
using is_Parser = typename detail::is_Parser<T>::type; using is_Parser = typename detail::is_Parser<T>::type;

4
include/beast/http/empty_body.hpp
View File

@@ -25,14 +25,14 @@ namespace http {
*/ */
struct empty_body struct empty_body
{ {
#if GENERATING_DOCS #if BEAST_DOXYGEN
/// The type of the `message::body` member /// The type of the `message::body` member
using value_type = void; using value_type = void;
#else #else
struct value_type {}; struct value_type {};
#endif #endif
#if GENERATING_DOCS #if BEAST_DOXYGEN
private: private:
#endif #endif

2
include/beast/http/header_parser_v1.hpp
View File

@@ -84,7 +84,7 @@ public:
@param args Forwarded to the header constructor. @param args Forwarded to the header constructor.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class... Args> template<class... Args>
explicit explicit
header_parser_v1(Args&&... args); header_parser_v1(Args&&... args);

12
include/beast/http/message.hpp
View File

@@ -19,7 +19,7 @@
namespace beast { namespace beast {
namespace http { namespace http {
#if GENERATING_DOCS #if BEAST_DOXYGEN
/** A container for a HTTP request or response header. /** A container for a HTTP request or response header.
A header includes the Start Line and Fields. A header includes the Start Line and Fields.
@@ -44,7 +44,7 @@ struct header<true, Fields>
#endif #endif
{ {
/// Indicates if the header is a request or response. /// Indicates if the header is a request or response.
#if GENERATING_DOCS #if BEAST_DOXYGEN
static bool constexpr is_request = isRequest; static bool constexpr is_request = isRequest;
#else #else
@@ -104,7 +104,7 @@ struct header<true, Fields>
if and only if the first parameter is not convertible to if and only if the first parameter is not convertible to
`header`. `header`.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class... Args> template<class... Args>
explicit explicit
header(Args&&... args); header(Args&&... args);
@@ -293,7 +293,7 @@ struct message : header<isRequest, Fields>
only if `u` is not convertible to `base_type`. only if `u` is not convertible to `base_type`.
*/ */
template<class U template<class U
#if ! GENERATING_DOCS #if ! BEAST_DOXYGEN
, class = typename std::enable_if< , class = typename std::enable_if<
! std::is_convertible<typename ! std::is_convertible<typename
std::decay<U>::type, base_type>::value>::type std::decay<U>::type, base_type>::value>::type
@@ -315,7 +315,7 @@ struct message : header<isRequest, Fields>
only if `u` is not convertible to `base_type`. only if `u` is not convertible to `base_type`.
*/ */
template<class U, class V template<class U, class V
#if ! GENERATING_DOCS #if ! BEAST_DOXYGEN
,class = typename std::enable_if<! std::is_convertible< ,class = typename std::enable_if<! std::is_convertible<
typename std::decay<U>::type, base_type>::value>::type typename std::decay<U>::type, base_type>::value>::type
#endif #endif
@@ -388,7 +388,7 @@ private:
//------------------------------------------------------------------------------ //------------------------------------------------------------------------------
#if GENERATING_DOCS #if BEAST_DOXYGEN
/** Swap two header objects. /** Swap two header objects.
@par Requirements @par Requirements

2
include/beast/http/parse.hpp
View File

@@ -138,7 +138,7 @@ parse(SyncReadStream& stream,
*/ */
template<class AsyncReadStream, template<class AsyncReadStream,
class DynamicBuffer, class Parser, class ReadHandler> class DynamicBuffer, class Parser, class ReadHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<

2
include/beast/http/parser_v1.hpp
View File

@@ -116,7 +116,7 @@ public:
@note This function participates in overload resolution only @note This function participates in overload resolution only
if the first argument is not a parser or fields parser. if the first argument is not a parser or fields parser.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class... Args> template<class... Args>
explicit explicit
parser_v1(Args&&... args); parser_v1(Args&&... args);

4
include/beast/http/read.hpp
View File

@@ -153,7 +153,7 @@ read(SyncReadStream& stream, DynamicBuffer& dynabuf,
template<class AsyncReadStream, class DynamicBuffer, template<class AsyncReadStream, class DynamicBuffer,
bool isRequest, class Body, class Fields, bool isRequest, class Body, class Fields,
class ReadHandler> class ReadHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -285,7 +285,7 @@ read(SyncReadStream& stream, DynamicBuffer& dynabuf,
template<class AsyncReadStream, class DynamicBuffer, template<class AsyncReadStream, class DynamicBuffer,
bool isRequest, class Body, class Fields, bool isRequest, class Body, class Fields,
class ReadHandler> class ReadHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<

6
include/beast/http/rfc7230.hpp
View File

@@ -61,7 +61,7 @@ public:
std::pair<boost::string_ref, boost::string_ref>; std::pair<boost::string_ref, boost::string_ref>;
/// A constant iterator to the list /// A constant iterator to the list
#if GENERATING_DOCS #if BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = implementation_defined;
#else #else
class const_iterator; class const_iterator;
@@ -150,7 +150,7 @@ public:
using value_type = std::pair<boost::string_ref, param_list>; using value_type = std::pair<boost::string_ref, param_list>;
/// A constant iterator to the list /// A constant iterator to the list
#if GENERATING_DOCS #if BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = implementation_defined;
#else #else
class const_iterator; class const_iterator;
@@ -238,7 +238,7 @@ public:
using value_type = boost::string_ref; using value_type = boost::string_ref;
/// A constant iterator to the list /// A constant iterator to the list
#if GENERATING_DOCS #if BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = implementation_defined;
#else #else
class const_iterator; class const_iterator;

2
include/beast/http/string_body.hpp
View File

@@ -28,7 +28,7 @@ struct string_body
/// The type of the `message::body` member /// The type of the `message::body` member
using value_type = std::string; using value_type = std::string;
#if GENERATING_DOCS #if BEAST_DOXYGEN
private: private:
#endif #endif

4
include/beast/http/write.hpp
View File

@@ -121,7 +121,7 @@ write(SyncWriteStream& stream,
template<class AsyncWriteStream, template<class AsyncWriteStream,
bool isRequest, class Fields, bool isRequest, class Fields,
class WriteHandler> class WriteHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -240,7 +240,7 @@ write(SyncWriteStream& stream,
template<class AsyncWriteStream, template<class AsyncWriteStream,
bool isRequest, class Body, class Fields, bool isRequest, class Body, class Fields,
class WriteHandler> class WriteHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<

16
include/beast/websocket/option.hpp
View File

@@ -44,7 +44,7 @@ namespace websocket {
stream.set_option(auto_fragment{true}); stream.set_option(auto_fragment{true});
@endcode @endcode
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using auto_fragment = implementation_defined; using auto_fragment = implementation_defined;
#else #else
struct auto_fragment struct auto_fragment
@@ -103,7 +103,7 @@ struct auto_fragment
ws.set_option(decorate(identity{})); ws.set_option(decorate(identity{}));
@endcode @endcode
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using decorate = implementation_defined; using decorate = implementation_defined;
#else #else
using decorate = detail::decorator_type; using decorate = detail::decorator_type;
@@ -133,7 +133,7 @@ using decorate = detail::decorator_type;
ws.set_option(keep_alive{8192}); ws.set_option(keep_alive{8192});
@endcode @endcode
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using keep_alive = implementation_defined; using keep_alive = implementation_defined;
#else #else
struct keep_alive struct keep_alive
@@ -169,7 +169,7 @@ struct keep_alive
ws.set_option(message_type{opcode::binary}); ws.set_option(message_type{opcode::binary});
@endcode @endcode
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using message_type = implementation_defined; using message_type = implementation_defined;
#else #else
struct message_type struct message_type
@@ -270,7 +270,7 @@ struct permessage_deflate
To remove the ping callback, construct the option with To remove the ping callback, construct the option with
no parameters: `set_option(ping_callback{})` no parameters: `set_option(ping_callback{})`
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using ping_callback = implementation_defined; using ping_callback = implementation_defined;
#else #else
struct ping_callback struct ping_callback
@@ -312,7 +312,7 @@ struct ping_callback
ws.set_option(read_buffer_size{16 * 1024}); ws.set_option(read_buffer_size{16 * 1024});
@endcode @endcode
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using read_buffer_size = implementation_defined; using read_buffer_size = implementation_defined;
#else #else
struct read_buffer_size struct read_buffer_size
@@ -350,7 +350,7 @@ struct read_buffer_size
ws.set_option(read_message_max{65536}); ws.set_option(read_message_max{65536});
@endcode @endcode
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using read_message_max = implementation_defined; using read_message_max = implementation_defined;
#else #else
struct read_message_max struct read_message_max
@@ -393,7 +393,7 @@ struct read_message_max
ws.set_option(write_buffer_size{8192}); ws.set_option(write_buffer_size{8192});
@endcode @endcode
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
using write_buffer_size = implementation_defined; using write_buffer_size = implementation_defined;
#else #else
struct write_buffer_size struct write_buffer_size

28
include/beast/websocket/stream.hpp
View File

@@ -96,7 +96,7 @@ public:
/// The type of the lowest layer. /// The type of the lowest layer.
using lowest_layer_type = using lowest_layer_type =
#if GENERATING_DOCS #if BEAST_DOXYGEN
implementation_defined; implementation_defined;
#else #else
typename beast::detail::get_lowest_layer< typename beast::detail::get_lowest_layer<
@@ -152,7 +152,7 @@ public:
@param args One or more stream options to set. @param args One or more stream options to set.
*/ */
#if GENERATING_DOCS #if BEAST_DOXYGEN
template<class... Args> template<class... Args>
void void
set_option(Args&&... args) set_option(Args&&... args)
@@ -192,7 +192,7 @@ public:
the version number is used. the version number is used.
*/ */
void void
#if GENERATING_DOCS #if BEAST_DOXYGEN
set_option(implementation_defined o) set_option(implementation_defined o)
#else #else
set_option(detail::decorator_type const& o) set_option(detail::decorator_type const& o)
@@ -433,7 +433,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class AcceptHandler> template<class AcceptHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -559,7 +559,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class ConstBufferSequence, class AcceptHandler> template<class ConstBufferSequence, class AcceptHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -676,7 +676,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class Body, class Fields, class AcceptHandler> template<class Body, class Fields, class AcceptHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -813,7 +813,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class HandshakeHandler> template<class HandshakeHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -924,7 +924,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class CloseHandler> template<class CloseHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -1006,7 +1006,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class WriteHandler> template<class WriteHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -1103,7 +1103,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class WriteHandler> template<class WriteHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -1251,7 +1251,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class DynamicBuffer, class ReadHandler> template<class DynamicBuffer, class ReadHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -1409,7 +1409,7 @@ public:
manner equivalent to using boost::asio::io_service::post(). manner equivalent to using boost::asio::io_service::post().
*/ */
template<class DynamicBuffer, class ReadHandler> template<class DynamicBuffer, class ReadHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -1535,7 +1535,7 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class ConstBufferSequence, class WriteHandler> template<class ConstBufferSequence, class WriteHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<
@@ -1651,7 +1651,7 @@ public:
); @endcode ); @endcode
*/ */
template<class ConstBufferSequence, class WriteHandler> template<class ConstBufferSequence, class WriteHandler>
#if GENERATING_DOCS #if BEAST_DOXYGEN
void_or_deduced void_or_deduced
#else #else
typename async_completion< typename async_completion<