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

Doc tidy

Browse Source
This commit is contained in:
Vinnie Falco
2017-06-19 20:03:05 -07:00
parent f4c65a5ba6
commit 0a674b1b52
3 changed files with 17 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/2_examples.qbk
View File

@@ -8,6 +8,10 @@
[section Quick Start] [section Quick Start]
[block'''<?dbhtml stop-chunking?>'''] [block'''<?dbhtml stop-chunking?>''']
These complete programs are intended to quickly impress upon readers
the flavor of the library. Source code and build scripts for them are
located in the example/ directory.
[section HTTP Client] [section HTTP Client]
Use HTTP to make a GET request to a website and print the response: Use HTTP to make a GET request to a website and print the response:
@@ -35,9 +39,8 @@ File: [repo_file example/websocket-client/websocket_client.cpp]
[section Examples] [section Examples]
[block'''<?dbhtml stop-chunking?>'''] [block'''<?dbhtml stop-chunking?>''']
These complete programs are intended to quickly impress upon readers the Source code and build scripts for these programs are located
flavor of the library. Source code and build scripts for them are located in the example/ directory.
in the examples directory.

16
doc/concept/FieldsReader.qbk
View File

@@ -17,7 +17,7 @@ In this table:
* `X` denotes a type that meets the requirements of [*FieldsReader]. * `X` denotes a type that meets the requirements of [*FieldsReader].
* `F` denotes a __Fields__ where * `F` denotes a __Fields__ where
`std::is_same<X, F::reader>::value == `true`. `std::is_same<X, F::reader>::value == true`.
* `a` is a value of type `X`. * `a` is a value of type `X`.
@@ -62,7 +62,7 @@ In this table:
[ [
Called once after construction, this function returns `true` Called once after construction, this function returns `true`
if the [*Transfer-Encoding] field is present, and the last if the [*Transfer-Encoding] field is present, and the last
token in its value is [*"chunked"]. token in its value is "chunked".
] ]
][ ][
[`a.keep_alive()`] [`a.keep_alive()`]
@@ -71,15 +71,15 @@ In this table:
Called once after construction, this function returns `true` Called once after construction, this function returns `true`
if the semantics of the mesage indicate that the connection if the semantics of the mesage indicate that the connection
should remain open after processing the message. When the should remain open after processing the message. When the
HTTP version is below 1.1, `keep_alive` returns `true` when HTTP version is below 1.1, the function returns `true` only
the [*Connection] field is present, and its value contains the if the [*Connection] field is present, and its value contains
"keep-alive" token. Otherwise, `keep_alive` returns `true` the "keep-alive" token. For HTTP versions 1.1 and above, the
when either the [*Connection] field is absent, or if the function returns `true` if the [*Connection] field is absent,
value does not contain the "close" token. or if the field value does not contain the "close" token.
] ]
][ ][
[`a.get()`] [`a.get()`]
[X::const_buffers_type] [`X::const_buffers_type`]
[ [
Called once after construction, this function returns Called once after construction, this function returns
a constant buffer sequence containing the serialized a constant buffer sequence containing the serialized

3
doc/xsl/class_detail.xsl
View File

@@ -27,6 +27,9 @@
<xsl:when test="declname = 'DynamicBuffer' or type = 'class DynamicBuffer'"> <xsl:when test="declname = 'DynamicBuffer' or type = 'class DynamicBuffer'">
<xsl:text>class ``[link beast.concept.DynamicBuffer [*DynamicBuffer]]``</xsl:text> <xsl:text>class ``[link beast.concept.DynamicBuffer [*DynamicBuffer]]``</xsl:text>
</xsl:when> </xsl:when>
<xsl:when test="type = 'class Fields' or substring(type, 1, 13) = 'class Fields '">
<xsl:text>class ``[link beast.concept.Fields [*Fields]]``</xsl:text>
</xsl:when>
<xsl:when test="declname = 'Handler' or type = 'class Handler'"> <xsl:when test="declname = 'Handler' or type = 'class Handler'">
<xsl:text>class __Handler__</xsl:text> <xsl:text>class __Handler__</xsl:text>
</xsl:when> </xsl:when>