boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-08-02 14:24:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Squashed 'doc/docca/' changes from 1bfc5ede..df9bd956

Browse Source 
df9bd956 Add deduced alias
220ded9a Add see-below alias

git-subtree-dir: doc/docca
git-subtree-split: df9bd956e2480467447c80ffae3b44b3c0b0756a
This commit is contained in:
Vinnie Falco
2018-11-11 21:53:13 -08:00
parent 0f3696f2ec
commit 450964b78f
21 changed files with 55 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/docca/example/include/docca/example.hpp
View File

@@ -67,13 +67,19 @@ using t_type = std::vector<T>;
Description Description
*/ */
using vod = void_or_deduced; using vod = __deduced__;
/** See below
Description
*/
using sb = __see_below__;
/** Implementation-defined /** Implementation-defined
Description Description
*/ */
using impdef = implementation_defined; using impdef = __implementation_defined__;
/** Variable /** Variable

10
doc/docca/include/docca/doxygen.xsl
View File

@@ -178,11 +178,17 @@
</xsl:variable> </xsl:variable>
<xsl:variable name="cleaned"> <xsl:variable name="cleaned">
<xsl:choose> <xsl:choose>
<xsl:when test="$type='implementation_defined'"> <xsl:when test="$type='__implementation_defined__'">
<xsl:text>``['implementation-defined]``</xsl:text> <xsl:text>``['implementation-defined]``</xsl:text>
</xsl:when> </xsl:when>
<xsl:when test="$type='__see_below__'">
<xsl:text>``['see-below]``</xsl:text>
</xsl:when>
<xsl:when test="$type='__deduced__'">
<xsl:text>``__deduced__``</xsl:text>
</xsl:when>
<xsl:when test="$type='void_or_deduced'"> <xsl:when test="$type='void_or_deduced'">
<xsl:text>``__void_or_deduced__``</xsl:text> <xsl:text>``__deduced__``</xsl:text>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:value-of select="$type"/> <xsl:value-of select="$type"/>

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

@@ -54,7 +54,7 @@ namespace beast {
*/ */
template<class Handler, class... Args> template<class Handler, class... Args>
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
implementation_defined __implementation_defined__
#else #else
detail::bound_handler< detail::bound_handler<
typename std::decay<Handler>::type, Args...> typename std::decay<Handler>::type, Args...>

2
include/boost/beast/core/buffered_read_stream.hpp
View File

@@ -174,7 +174,7 @@ public:
`NextLayer` has a member function named `get_executor`. `NextLayer` has a member function named `get_executor`.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
implementation_defined __implementation_defined__
#else #else
template< template<
class T = next_layer_type, class T = next_layer_type,

4
include/boost/beast/core/buffers_adapter.hpp
View File

@@ -77,10 +77,10 @@ public:
#if BOOST_BEAST_DOXYGEN #if BOOST_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__;
/// The type used to represent the output sequence as a list of buffers. /// The type used to represent the output sequence as a list of buffers.
using mutable_buffers_type = implementation_defined; using mutable_buffers_type = __implementation_defined__;
#else #else
class const_buffers_type; class const_buffers_type;

2
include/boost/beast/core/buffers_cat.hpp
View File

@@ -34,7 +34,7 @@ public:
Otherwise, `value_type` will be `boost::asio::const_buffer`. Otherwise, `value_type` will be `boost::asio::const_buffer`.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using value_type = implementation_defined; using value_type = __implementation_defined__;
#else #else
using value_type = typename using value_type = typename
detail::common_buffers_type<Buffers...>::type; detail::common_buffers_type<Buffers...>::type;

2
include/boost/beast/core/buffers_prefix.hpp
View File

@@ -66,7 +66,7 @@ public:
#if BOOST_BEAST_DOXYGEN #if BOOST_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__;
#else #else
class const_iterator; class const_iterator;

4
include/boost/beast/core/buffers_suffix.hpp
View File

@@ -82,7 +82,7 @@ public:
`boost::asio::const_buffer`. `boost::asio::const_buffer`.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using value_type = implementation_defined; using value_type = __implementation_defined__;
#else #else
using value_type = typename std::conditional< using value_type = typename std::conditional<
std::is_convertible<typename std::is_convertible<typename
@@ -94,7 +94,7 @@ public:
#if BOOST_BEAST_DOXYGEN #if BOOST_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__;
#else #else
class const_iterator; class const_iterator;

4
include/boost/beast/core/multi_buffer.hpp
View File

@@ -84,10 +84,10 @@ public:
#if BOOST_BEAST_DOXYGEN #if BOOST_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__;
/// The type used to represent the output sequence as a list of buffers. /// The type used to represent the output sequence as a list of buffers.
using mutable_buffers_type = implementation_defined; using mutable_buffers_type = __implementation_defined__;
#else #else
class const_buffers_type; class const_buffers_type;

4
include/boost/beast/core/ostream.hpp
View File

@@ -43,7 +43,7 @@ namespace beast {
*/ */
template<class ConstBufferSequence> template<class ConstBufferSequence>
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
implementation_defined __implementation_defined__
#else #else
detail::buffers_helper<ConstBufferSequence> detail::buffers_helper<ConstBufferSequence>
#endif #endif
@@ -82,7 +82,7 @@ buffers(ConstBufferSequence const& b)
*/ */
template<class DynamicBuffer> template<class DynamicBuffer>
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
implementation_defined __implementation_defined__
#else #else
detail::ostream_helper< detail::ostream_helper<
DynamicBuffer, char, std::char_traits<char>, DynamicBuffer, char, std::char_traits<char>,

4
include/boost/beast/http/basic_dynamic_body.hpp
View File

@@ -62,7 +62,7 @@ struct basic_dynamic_body
Meets the requirements of @b BodyReader. Meets the requirements of @b BodyReader.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using reader = implementation_defined; using reader = __implementation_defined__;
#else #else
class reader class reader
{ {
@@ -122,7 +122,7 @@ struct basic_dynamic_body
Meets the requirements of @b BodyWriter. Meets the requirements of @b BodyWriter.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using writer = implementation_defined; using writer = __implementation_defined__;
#else #else
class writer class writer
{ {

4
include/boost/beast/http/buffer_body.hpp
View File

@@ -96,7 +96,7 @@ struct buffer_body
Meets the requirements of @b BodyReader. Meets the requirements of @b BodyReader.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using reader = implementation_defined; using reader = __implementation_defined__;
#else #else
class reader class reader
{ {
@@ -154,7 +154,7 @@ struct buffer_body
Meets the requirements of @b BodyWriter. Meets the requirements of @b BodyWriter.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using writer = implementation_defined; using writer = __implementation_defined__;
#else #else
class writer class writer
{ {

14
include/boost/beast/http/chunk_encode.hpp
View File

@@ -46,7 +46,7 @@ struct chunk_crlf
/// Required for @b ConstBufferSequence /// Required for @b ConstBufferSequence
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using value_type = implementation_defined; using value_type = __implementation_defined__;
#else #else
using value_type = detail::chunk_crlf_iter::value_type; using value_type = detail::chunk_crlf_iter::value_type;
#endif #endif
@@ -229,14 +229,14 @@ public:
/// Required for @b ConstBufferSequence /// Required for @b ConstBufferSequence
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using value_type = implementation_defined; using value_type = __implementation_defined__;
#else #else
using value_type = typename view_type::value_type; using value_type = typename view_type::value_type;
#endif #endif
/// Required for @b ConstBufferSequence /// Required for @b ConstBufferSequence
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = __implementation_defined__;
#else #else
using const_iterator = typename view_type::const_iterator; using const_iterator = typename view_type::const_iterator;
#endif #endif
@@ -423,14 +423,14 @@ public:
/// Required for @b ConstBufferSequence /// Required for @b ConstBufferSequence
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using value_type = implementation_defined; using value_type = __implementation_defined__;
#else #else
using value_type = typename view_type::value_type; using value_type = typename view_type::value_type;
#endif #endif
/// Required for @b ConstBufferSequence /// Required for @b ConstBufferSequence
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = __implementation_defined__;
#else #else
using const_iterator = typename view_type::const_iterator; using const_iterator = typename view_type::const_iterator;
#endif #endif
@@ -528,7 +528,7 @@ public:
/// Required for @b ConstBufferSequence /// Required for @b ConstBufferSequence
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using value_type = implementation_defined; using value_type = __implementation_defined__;
#else #else
using value_type = using value_type =
typename view_type::value_type; typename view_type::value_type;
@@ -536,7 +536,7 @@ public:
/// Required for @b ConstBufferSequence /// Required for @b ConstBufferSequence
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = __implementation_defined__;
#else #else
using const_iterator = using const_iterator =
typename view_type::const_iterator; typename view_type::const_iterator;

2
include/boost/beast/http/detail/basic_parsed_list.hpp
View File

@@ -36,7 +36,7 @@ public:
/// A constant iterator to a list element. /// A constant iterator to a list element.
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = __implementation_defined__;
#else #else
class const_iterator; class const_iterator;
#endif #endif

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

@@ -57,7 +57,7 @@ struct empty_body
Meets the requirements of @b BodyReader. Meets the requirements of @b BodyReader.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using reader = implementation_defined; using reader = __implementation_defined__;
#else #else
struct reader struct reader
{ {
@@ -95,7 +95,7 @@ struct empty_body
Meets the requirements of @b BodyWriter. Meets the requirements of @b BodyWriter.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using writer = implementation_defined; using writer = __implementation_defined__;
#else #else
struct writer struct writer
{ {

6
include/boost/beast/http/fields.hpp
View File

@@ -117,7 +117,7 @@ public:
The case-comparison operation is defined only for low-ASCII characters. The case-comparison operation is defined only for low-ASCII characters.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using key_compare = implementation_defined; using key_compare = __implementation_defined__;
#else #else
struct key_compare : beast::iless struct key_compare : beast::iless
#endif #endif
@@ -164,7 +164,7 @@ public:
/// The algorithm used to serialize the header /// The algorithm used to serialize the header
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using writer = implementation_defined; using writer = __implementation_defined__;
#else #else
class writer; class writer;
#endif #endif
@@ -277,7 +277,7 @@ public:
public: public:
/// A constant iterator to the field sequence. /// A constant iterator to the field sequence.
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = __implementation_defined__;
#else #else
using const_iterator = typename list_t::const_iterator; using const_iterator = typename list_t::const_iterator;
#endif #endif

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

@@ -66,7 +66,7 @@ public:
/// A constant iterator to the list /// A constant iterator to the list
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = __implementation_defined__;
#else #else
class const_iterator; class const_iterator;
#endif #endif
@@ -155,7 +155,7 @@ public:
/// A constant iterator to the list /// A constant iterator to the list
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = __implementation_defined__;
#else #else
class const_iterator; class const_iterator;
#endif #endif
@@ -243,7 +243,7 @@ public:
/// A constant iterator to the list /// A constant iterator to the list
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using const_iterator = implementation_defined; using const_iterator = __implementation_defined__;
#else #else
class const_iterator; class const_iterator;
#endif #endif

2
include/boost/beast/http/serializer.hpp
View File

@@ -69,7 +69,7 @@ public:
implementation of the corresponding @b BodyWriter. implementation of the corresponding @b BodyWriter.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using value_type = implementation_defined; using value_type = __implementation_defined__;
#else #else
using value_type = typename std::conditional< using value_type = typename std::conditional<
std::is_constructible<typename Body::writer, std::is_constructible<typename Body::writer,

4
include/boost/beast/http/span_body.hpp
View File

@@ -64,7 +64,7 @@ public:
Meets the requirements of @b BodyReader. Meets the requirements of @b BodyReader.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using reader = implementation_defined; using reader = __implementation_defined__;
#else #else
class reader class reader
{ {
@@ -125,7 +125,7 @@ public:
Meets the requirements of @b BodyWriter. Meets the requirements of @b BodyWriter.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using writer = implementation_defined; using writer = __implementation_defined__;
#else #else
class writer class writer
{ {

4
include/boost/beast/http/string_body.hpp
View File

@@ -72,7 +72,7 @@ public:
Meets the requirements of @b BodyReader. Meets the requirements of @b BodyReader.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using reader = implementation_defined; using reader = __implementation_defined__;
#else #else
class reader class reader
{ {
@@ -153,7 +153,7 @@ public:
Meets the requirements of @b BodyWriter. Meets the requirements of @b BodyWriter.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using writer = implementation_defined; using writer = __implementation_defined__;
#else #else
class writer class writer
{ {

4
include/boost/beast/http/vector_body.hpp
View File

@@ -67,7 +67,7 @@ public:
Meets the requirements of @b BodyReader. Meets the requirements of @b BodyReader.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using reader = implementation_defined; using reader = __implementation_defined__;
#else #else
class reader class reader
{ {
@@ -142,7 +142,7 @@ public:
Meets the requirements of @b BodyWriter. Meets the requirements of @b BodyWriter.
*/ */
#if BOOST_BEAST_DOXYGEN #if BOOST_BEAST_DOXYGEN
using writer = implementation_defined; using writer = __implementation_defined__;
#else #else
class writer class writer
{ {