Correct buffer_bytes documentation

ref #1854
This commit is contained in:
Richard Hodges
2020-03-11 18:13:35 +01:00
parent c08e636711
commit 929b15f844
2 changed files with 3 additions and 2 deletions

View File

@ -2,6 +2,7 @@ Version XXX:
* Remove CODE_OF_CONDUCT.md
* Refactor websocket read
* Correct buffer_bytes documentation
--------------------------------------------------------------------------------

View File

@ -140,8 +140,8 @@ using buffers_iterator_type =
argument-dependent lookup. The call `beast::buffer_bytes(b)` is
equivalent to performing:
@code
using namespace net;
buffer_bytes(b);
using net::buffer_size;
return buffer_size(b);
@endcode
In addition this handles types which are convertible to
`net::const_buffer`; these are not handled by `net::buffer_size`.