Skip to content

docs: fix serializer javadocs to use 'writing' instead of 'reading' #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

docs: fix serializer javadocs to use 'writing' instead of 'reading' #177

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
362d140
Initial plan
Copilot Oct 13, 2025
ef5a587
Fix serializer javadocs to use 'writing' instead of 'reading'
Copilot Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions include/boost/http_proto/serializer.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,17 +337,16 @@ class serializer

Initializes the serializer with the HTTP
start-line and headers from `m`, and returns
a @ref stream object for reading the body
from an external source.
a @ref stream object for writing the body
to an external destination.

Once the serializer is destroyed, @ref reset
is called, or @ref is_done returns true, the
only valid operation on the stream is destruction.

The stream allows inverted control flow: the
caller supplies body data via the serializer’s
internal buffer while reading from an external
source.
internal buffer for writing to the remote peer.

Changing the contents of the message
after calling this function and before
Expand Down Expand Up @@ -397,7 +396,7 @@ class serializer
@param m The message to read the HTTP
start-line and headers from.

@return A @ref stream object for reading body
@return A @ref stream object for writing body
content into the serializer's buffer.

@see
Expand Down