diff --git a/doc/2_examples.qbk b/doc/2_examples.qbk index a5ea23f5..6022954a 100644 --- a/doc/2_examples.qbk +++ b/doc/2_examples.qbk @@ -8,6 +8,10 @@ [section Quick Start] [block''''''] +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] 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] [block''''''] -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 examples directory. +Source code and build scripts for these programs are located +in the example/ directory. diff --git a/doc/concept/FieldsReader.qbk b/doc/concept/FieldsReader.qbk index a95060f6..0435e691 100644 --- a/doc/concept/FieldsReader.qbk +++ b/doc/concept/FieldsReader.qbk @@ -17,7 +17,7 @@ In this table: * `X` denotes a type that meets the requirements of [*FieldsReader]. * `F` denotes a __Fields__ where - `std::is_same::value == `true`. + `std::is_same::value == true`. * `a` is a value of type `X`. @@ -62,7 +62,7 @@ In this table: [ Called once after construction, this function returns `true` 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()`] @@ -71,15 +71,15 @@ In this table: Called once after construction, this function returns `true` if the semantics of the mesage indicate that the connection should remain open after processing the message. When the - HTTP version is below 1.1, `keep_alive` returns `true` when - the [*Connection] field is present, and its value contains the - "keep-alive" token. Otherwise, `keep_alive` returns `true` - when either the [*Connection] field is absent, or if the - value does not contain the "close" token. + HTTP version is below 1.1, the function returns `true` only + if the [*Connection] field is present, and its value contains + the "keep-alive" token. For HTTP versions 1.1 and above, the + function returns `true` if the [*Connection] field is absent, + or if the field value does not contain the "close" token. ] ][ [`a.get()`] - [X::const_buffers_type] + [`X::const_buffers_type`] [ Called once after construction, this function returns a constant buffer sequence containing the serialized diff --git a/doc/xsl/class_detail.xsl b/doc/xsl/class_detail.xsl index 7103a4ff..1120891e 100644 --- a/doc/xsl/class_detail.xsl +++ b/doc/xsl/class_detail.xsl @@ -27,6 +27,9 @@ class ``[link beast.concept.DynamicBuffer [*DynamicBuffer]]`` + + class ``[link beast.concept.Fields [*Fields]]`` + class __Handler__