boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-06-25 03:51:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix the issue of paragraph separation in the documentation

Browse Source 
Fixes #2792
This commit is contained in:
Mohammad Nejati
2024-01-10 14:54:39 +00:00
committed by Mohammad Nejati
parent a0a80359fe
commit ea424f1da6
4 changed files with 46 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/xsl/custom-overrides.xsl
View File

@ -15,6 +15,8 @@
<xsl:template mode="convenience-header" match="@file[contains(., 'boost/beast/zlib')]" >zlib.hpp</xsl:template>
<xsl:template mode="convenience-header" match="@file"/>
<xsl:template mode="before" match="para">{$nl}{$nl}</xsl:template>
<xsl:variable name="emphasized-template-parameter-types" select="
'Allocator',
'AsyncStream',

28
include/boost/beast/http/read.hpp
View File

@ -209,10 +209,9 @@ read_some(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
*/
template<
@ -420,10 +419,9 @@ read_header(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
*/
template<
@ -631,10 +629,9 @@ read(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
*/
template<
@ -851,10 +848,9 @@ read(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
*/
template<

35
include/boost/beast/http/write.hpp
View File

@ -169,10 +169,9 @@ write_some(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
@see serializer
*/
@ -312,10 +311,9 @@ write_header(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
@see serializer
*/
@ -446,10 +444,9 @@ write(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
@see serializer
*/
@ -684,10 +681,9 @@ write(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
@see message
*/
@ -759,10 +755,9 @@ async_write(
@li @c net::cancellation_type::terminal
if the `stream` also supports terminal cancellation.
`terminal` cancellation leaves the stream in an undefined state,
so that only closing it is guaranteed to succeed.
if the `stream` also supports terminal cancellation, `terminal`
cancellation leaves the stream in an undefined state, so that only
closing it is guaranteed to succeed.
@see message
*/

18
include/boost/beast/websocket/stream.hpp
View File

@ -1639,7 +1639,8 @@ public:
by dispatching to the immediate executor. If no
immediate executor is specified, this is equivalent
to using `net::post`.
@par Per-Operation Cancellation
@par Per-Operation Cancellation
This asynchronous operation supports cancellation for the following
net::cancellation_type values:
@ -1649,6 +1650,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
@note `terminal` cancellation will may close the underlying socket.
@ -1760,6 +1762,7 @@ public:
by dispatching to the immediate executor. If no
immediate executor is specified, this is equivalent
to using `net::post`.
@par Per-Operation Cancellation
This asynchronous operation supports cancellation for the following
@ -1770,6 +1773,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
`terminal` cancellation leaves the stream in an undefined state,
@ -1885,6 +1889,7 @@ public:
by dispatching to the immediate executor. If no
immediate executor is specified, this is equivalent
to using `net::post`.
@par Per-Operation Cancellation
This asynchronous operation supports cancellation for the following
@ -1895,6 +1900,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
`terminal` cancellation leaves the stream in an undefined state,
@ -2063,6 +2069,7 @@ public:
by dispatching to the immediate executor. If no
immediate executor is specified, this is equivalent
to using `net::post`.
@par Per-Operation Cancellation
This asynchronous operation supports cancellation for the following
@ -2073,6 +2080,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
`terminal` cancellation leaves the stream in an undefined state,
@ -2259,6 +2267,7 @@ public:
by dispatching to the immediate executor. If no
immediate executor is specified, this is equivalent
to using `net::post`.
@par Per-Operation Cancellation
This asynchronous operation supports cancellation for the following
@ -2269,6 +2278,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
`terminal` cancellation leaves the stream in an undefined state,
@ -2388,6 +2398,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
`terminal` cancellation leaves the stream in an undefined state,
@ -2477,6 +2488,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
`terminal` cancellation leaves the stream in an undefined state,
@ -2607,6 +2619,7 @@ public:
by dispatching to the immediate executor. If no
immediate executor is specified, this is equivalent
to using `net::post`.
@par Per-Operation Cancellation
This asynchronous operation supports cancellation for the following
@ -2617,6 +2630,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
`terminal` cancellation leaves the stream in an undefined state,
@ -2756,6 +2770,7 @@ public:
by dispatching to the immediate executor. If no
immediate executor is specified, this is equivalent
to using `net::post`.
@par Per-Operation Cancellation
This asynchronous operation supports cancellation for the following
@ -2766,6 +2781,7 @@ public:
`total` cancellation succeeds if the operation is suspended due to ongoing
control operations such as a ping/pong.
`terminal` cancellation succeeds when supported by the underlying stream.
`terminal` cancellation leaves the stream in an undefined state,