Skip to content

Commit c998efd

Browse files
committed
serializer javadocs uses 'writing' instead of 'reading'
Closes #176
1 parent 35bd9a9 commit c998efd

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

include/boost/http_proto/serializer.hpp

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -332,15 +332,15 @@ class serializer
332332
333333
Initializes the serializer with the HTTP
334334
start-line and headers from `m`, and returns
335-
a @ref stream object for reading the body
336-
from an external source.
335+
a @ref stream object for writing the body
336+
data into the serializer's internal buffer.
337337
338338
Once the serializer is destroyed, @ref reset
339339
is called, or @ref is_done returns true, the
340340
only valid operation on the stream is destruction.
341341
342342
The stream allows inverted control flow: the
343-
caller supplies body data via the serializer’s
343+
caller supplies body data to the serializer’s
344344
internal buffer while reading from an external
345345
source.
346346
@@ -351,17 +351,17 @@ class serializer
351351
352352
@par Example
353353
@code
354-
serializer::stream strm = serializer.start_stream(response);
354+
serializer::stream st = serializer.start_stream(response);
355355
do
356356
{
357-
if(strm.is_open())
357+
if(st.is_open())
358358
{
359-
std::size_t n = source.read_some(strm.prepare());
359+
std::size_t n = source.read_some(st.prepare());
360360
361361
if(ec == error::eof)
362-
strm.close();
362+
st.close();
363363
else
364-
strm.commit(n);
364+
st.commit(n);
365365
}
366366
367367
write_some(client, serializer);
@@ -392,8 +392,8 @@ class serializer
392392
@param m The message to read the HTTP
393393
start-line and headers from.
394394
395-
@return A @ref stream object for reading body
396-
content into the serializer's buffer.
395+
@return A @ref stream object for writing the body
396+
data into the serializer's internal buffer.
397397
398398
@see
399399
@ref stream,

0 commit comments

Comments
 (0)