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

Fix message.hpp javadocs

Browse Source
This commit is contained in:
Vinnie Falco
2017-06-14 07:10:56 -07:00
parent 2845494e77
commit 61a83ba769
2 changed files with 38 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -1,3 +1,9 @@
Version 57:
* Fix message.hpp javadocs
--------------------------------------------------------------------------------
Version 56: Version 56:
* Add provisional IANA header field names * Add provisional IANA header field names

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

@ -51,7 +51,11 @@ struct header<true, Fields> : Fields
#endif #endif
{ {
/// Indicates if the header is a request or response. /// Indicates if the header is a request or response.
#if BEAST_DOXYGEN
using is_request = isRequest;
#else
using is_request = std::true_type; using is_request = std::true_type;
#endif
/// The type representing the fields. /// The type representing the fields.
using fields_type = Fields; using fields_type = Fields;
@ -84,29 +88,6 @@ struct header<true, Fields> : Fields
/// Copy assignment /// Copy assignment
header& operator=(header const&) = default; header& operator=(header const&) = default;
/** Construct the header.
All arguments are forwarded to the constructor
of the `fields` member.
@note This constructor participates in overload resolution
if and only if the first parameter is not convertible to
`header`.
*/
#if BEAST_DOXYGEN
template<class... Args>
explicit
header(Args&&... args);
#else
template<class Arg1, class... ArgN,
class = typename std::enable_if<
(sizeof...(ArgN) > 0) || ! std::is_convertible<
typename std::decay<Arg1>::type,
header>::value>::type>
explicit
header(Arg1&& arg1, ArgN&&... argn);
/** Return the request-method verb. /** Return the request-method verb.
If the request-method is not one of the recognized verbs, If the request-method is not one of the recognized verbs,
@ -172,6 +153,32 @@ struct header<true, Fields> : Fields
void void
target(string_view s); target(string_view s);
// VFALCO Don't move these declarations around,
// otherwise the documentation will be wrong.
/** Construct the header.
All arguments are forwarded to the constructor
of the `fields` member.
@note This constructor participates in overload resolution
if and only if the first parameter is not convertible to
`header`.
*/
#if BEAST_DOXYGEN
template<class... Args>
explicit
header(Args&&... args);
#else
template<class Arg1, class... ArgN,
class = typename std::enable_if<
(sizeof...(ArgN) > 0) || ! std::is_convertible<
typename std::decay<Arg1>::type,
header>::value>::type>
explicit
header(Arg1&& arg1, ArgN&&... argn);
private: private:
template<bool, class, class> template<bool, class, class>
friend struct message; friend struct message;
@ -327,6 +334,7 @@ struct header<false, Fields> : Fields
reason(string_view s); reason(string_view s);
private: private:
#if ! BEAST_DOXYGEN
template<bool, class, class> template<bool, class, class>
friend struct message; friend struct message;
@ -336,6 +344,7 @@ private:
swap(header<false, T>& m1, header<false, T>& m2); swap(header<false, T>& m1, header<false, T>& m2);
status result_; status result_;
#endif
}; };
/** A container for a complete HTTP message. /** A container for a complete HTTP message.