From 8dcc6162c1482886f65333c81efecbe2249d3c32 Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Wed, 21 Feb 2018 08:45:08 -0800 Subject: [PATCH] Tidy up end_of_stream javadoc fix #1023 --- CHANGELOG.md | 6 ++++++ include/boost/beast/http/error.hpp | 13 ++++--------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 69f5096a..be69d5ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +Version 158: + +* Tidy up end_of_stream javadoc + +-------------------------------------------------------------------------------- + Version 157: * Fix teardown for TIME_WAIT diff --git a/include/boost/beast/http/error.hpp b/include/boost/beast/http/error.hpp index 841a99de..b3d9fb11 100644 --- a/include/boost/beast/http/error.hpp +++ b/include/boost/beast/http/error.hpp @@ -22,15 +22,10 @@ enum class error { /** The end of the stream was reached. - This error is returned under the following conditions: - - @li When attempting to read HTTP data from a stream and the stream - read returns the error `boost::asio::error::eof` before any new octets - have been received. - - @li When sending a complete HTTP message at once and the semantics of - the message are that the connection should be closed to indicate the - end of the message. + This error is returned when attempting to read HTTP data, + and the stream returns the error `boost::asio::error::eof` + before any octets corresponding to a new HTTP message have + been received. */ end_of_stream = 1,