diff --git a/CHANGELOG.md b/CHANGELOG.md index 726a4454..71598cef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ Version 161: * Don't copy the handler in write_some_op * Add move-only handler tests +* Fix handler parameter javadocs -------------------------------------------------------------------------------- diff --git a/example/common/detect_ssl.hpp b/example/common/detect_ssl.hpp index 765438ba..6fd1d654 100644 --- a/example/common/detect_ssl.hpp +++ b/example/common/detect_ssl.hpp @@ -210,8 +210,8 @@ detect_ssl( @param buffer The dynamic buffer to use. This type must meet the requirements of @b DynamicBuffer. - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( diff --git a/include/boost/beast/core/buffered_read_stream.hpp b/include/boost/beast/core/buffered_read_stream.hpp index a546d3eb..97406230 100644 --- a/include/boost/beast/core/buffered_read_stream.hpp +++ b/include/boost/beast/core/buffered_read_stream.hpp @@ -273,8 +273,8 @@ public: is retained by the caller, which must guarantee that they remain valid until the handler is called. - @param handler The handler to be called when the operation - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation @@ -345,8 +345,8 @@ public: retained by the caller, which must guarantee that they remain valid until the handler is called. - @param handler The handler to be called when the operation - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation diff --git a/include/boost/beast/http/read.hpp b/include/boost/beast/http/read.hpp index 33698762..a4f0efe4 100644 --- a/include/boost/beast/http/read.hpp +++ b/include/boost/beast/http/read.hpp @@ -175,8 +175,8 @@ read_some( The object must remain valid at least until the handler is called; ownership is not transferred. - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation @@ -361,8 +361,8 @@ read_header( The object must remain valid at least until the handler is called; ownership is not transferred. - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation, @@ -545,8 +545,8 @@ read( The object must remain valid at least until the handler is called; ownership is not transferred. - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation, diff --git a/include/boost/beast/http/write.hpp b/include/boost/beast/http/write.hpp index 755ed0b9..3b916b1d 100644 --- a/include/boost/beast/http/write.hpp +++ b/include/boost/beast/http/write.hpp @@ -148,8 +148,8 @@ write_some( The object must remain valid at least until the handler is called; ownership is not transferred. - @param handler The handler to be called when the operation - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation @@ -269,8 +269,8 @@ write_header( The object must remain valid at least until the handler is called; ownership is not transferred. - @param handler The handler to be called when the operation - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation @@ -387,8 +387,8 @@ write( The object must remain valid at least until the handler is called; ownership is not transferred. - @param handler The handler to be called when the operation - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation @@ -502,8 +502,8 @@ write( The object must remain valid at least until the handler is called; ownership is not transferred. - @param handler The handler to be called when the operation - completes. Copies will be made of the handler as required. + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. The equivalent function signature of the handler must be: @code void handler( error_code const& error, // result of operation diff --git a/include/boost/beast/websocket/ssl.hpp b/include/boost/beast/websocket/ssl.hpp index 44d5dc80..d51921a4 100644 --- a/include/boost/beast/websocket/ssl.hpp +++ b/include/boost/beast/websocket/ssl.hpp @@ -55,9 +55,9 @@ teardown( @param stream The stream to tear down. - @param handler The handler to be called when the request completes. - Copies will be made of the handler as required. The equivalent - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& error // result of operation ); @endcode diff --git a/include/boost/beast/websocket/stream.hpp b/include/boost/beast/websocket/stream.hpp index 9a522cbf..4d6e568d 100644 --- a/include/boost/beast/websocket/stream.hpp +++ b/include/boost/beast/websocket/stream.hpp @@ -1169,9 +1169,9 @@ public: required by the HTTP protocol. Copies of this parameter may be made as needed. - @param handler The handler to be called when the request completes. - Copies will be made of the handler as required. The equivalent - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -1221,9 +1221,9 @@ public: required by the HTTP protocol. Copies of this parameter may be made as needed. - @param handler The handler to be called when the request completes. - Copies will be made of the handler as required. The equivalent - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -1279,9 +1279,9 @@ public: request_type& req ); @endcode - @param handler The handler to be called when the request completes. - Copies will be made of the handler as required. The equivalent - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -1341,9 +1341,9 @@ public: request_type& req ); @endcode - @param handler The handler to be called when the request completes. - Copies will be made of the handler as required. The equivalent - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -1916,9 +1916,9 @@ public: @ref http::read or @ref http::async_read, then call @ref accept or @ref async_accept with the request. - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -1977,9 +1977,9 @@ public: response_type& res ); @endcode - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -2040,9 +2040,9 @@ public: then to received WebSocket frames. The implementation will copy the caller provided data before the function returns. - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -2118,9 +2118,9 @@ public: response_type& res ); @endcode - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -2179,9 +2179,9 @@ public: Ownership is not transferred, the implementation will not access this object from other threads. - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -2242,9 +2242,9 @@ public: response_type& res ); @endcode - @param handler The handler to be called when the request - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec // Result of operation ); @endcode @@ -2359,9 +2359,9 @@ public: @param cr The reason for the close. - @param handler The handler to be called when the close operation - completes. Copies will be made of the handler as required. The - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The function signature of the handler must be: @code void handler( error_code const& ec // Result of operation @@ -2437,9 +2437,9 @@ public: @param payload The payload of the ping message, which may be empty. - @param handler The handler to be called when the read operation - completes. Copies will be made of the handler as required. The - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The function signature of the handler must be: @code void handler( error_code const& ec // Result of operation @@ -2530,9 +2530,9 @@ public: @param payload The payload of the pong message, which may be empty. - @param handler The handler to be called when the read operation - completes. Copies will be made of the handler as required. The - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The function signature of the handler must be: @code void handler( error_code const& ec // Result of operation @@ -2688,9 +2688,9 @@ public: any masking or decompression has been applied. This object must remain valid until the handler is called. - @param handler The handler to be called when the read operation - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec, // Result of operation @@ -2868,9 +2868,9 @@ public: will append into the buffer. If this value is zero, then a reasonable size will be chosen automatically. - @param handler The handler to be called when the read operation - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec, // Result of operation @@ -3041,9 +3041,9 @@ public: locations pointed to by the buffer sequence remains valid until the completion handler is called. - @param handler The handler to be called when the read operation - completes. Copies will be made of the handler as required. The - equivalent function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec, // Result of operation @@ -3179,9 +3179,9 @@ public: the memory locations pointed to by buffers remains valid until the completion handler is called. - @param handler The handler to be called when the write operation - completes. Copies will be made of the handler as required. The - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The function signature of the handler must be: @code void handler( error_code const& ec, // Result of operation @@ -3309,9 +3309,9 @@ public: the caller, which must guarantee that they remain valid until the handler is called. - @param handler The handler to be called when the write completes. - Copies will be made of the handler as required. The equivalent - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& ec, // Result of operation std::size_t bytes_transferred // Number of bytes written from the diff --git a/include/boost/beast/websocket/teardown.hpp b/include/boost/beast/websocket/teardown.hpp index 289b57c8..a255756d 100644 --- a/include/boost/beast/websocket/teardown.hpp +++ b/include/boost/beast/websocket/teardown.hpp @@ -69,9 +69,9 @@ teardown( @param socket The socket to tear down. - @param handler The handler to be called when the request completes. - Copies will be made of the handler as required. The equivalent - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& error // result of operation ); @@ -145,9 +145,9 @@ teardown( @param socket The socket to tear down. - @param handler The handler to be called when the request completes. - Copies will be made of the handler as required. The equivalent - function signature of the handler must be: + @param handler Invoked when the operation completes. + The handler may be moved or copied as needed. + The equivalent function signature of the handler must be: @code void handler( error_code const& error // result of operation );