From 14653be0ccbbcb35b10e63afa720ee6f03b4ed55 Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Mon, 30 Oct 2017 15:31:00 -0700 Subject: [PATCH] Tidy up FieldsReader doc --- CHANGELOG.md | 1 + doc/qbk/07_concepts/FieldsReader.qbk | 4 ++-- test/doc/exemplars.cpp | 10 +++------- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 716d767b..b6c10fab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ Version 132: * Tidy up project folders in CMakeLists.txt * Rename Cmake variables for clarity * Add ref-qualified overloads for message::body +* Tidy up FieldsReader doc -------------------------------------------------------------------------------- diff --git a/doc/qbk/07_concepts/FieldsReader.qbk b/doc/qbk/07_concepts/FieldsReader.qbk index 8f993213..dddb8e31 100644 --- a/doc/qbk/07_concepts/FieldsReader.qbk +++ b/doc/qbk/07_concepts/FieldsReader.qbk @@ -41,7 +41,7 @@ In this table: This is the type of buffer returned by `R::get`. ] ][ - [`R(f,v,m)`] + [`R{f,v,m}`] [] [ The implementation calls this constructor to indicate @@ -50,7 +50,7 @@ In this table: to end no earlier than after the `R` is destroyed. ] ][ - [`R(f,v,c)`] + [`R{f,v,c}`] [] [ The implementation calls this constructor to indicate diff --git a/test/doc/exemplars.cpp b/test/doc/exemplars.cpp index 2099a7f8..e52e023e 100644 --- a/test/doc/exemplars.cpp +++ b/test/doc/exemplars.cpp @@ -272,7 +272,7 @@ static_assert(is_fields::value, //] struct Fields_FieldsReader { - using F = Fields_FieldsReader; + using Fields = Fields_FieldsReader; //[concept_FieldsReader struct FieldsReader @@ -281,14 +281,10 @@ struct FieldsReader struct const_buffers_type; // Constructor for requests - FieldsReader(F const& f, unsigned version, verb method); + FieldsReader(Fields const& f, unsigned version, verb method); // Constructor for responses - FieldsReader(F const& f, unsigned version, unsigned status); - - // Returns `true` if keep-alive is indicated - bool - keep_alive(); + FieldsReader(Fields const& f, unsigned version, unsigned status); // Returns the serialized header buffers const_buffers_type