Skip to content

Commit d58f3e6

Browse files
committed
Fix NOTE admonitions to include code snippets
The single-line NOTE: shorthand only captures one line of text, leaving the code block rendered outside the admonition. Use the block form [NOTE]/==== to wrap the code snippet inside.
1 parent 9f057bd commit d58f3e6

18 files changed

Lines changed: 72 additions & 18 deletions

doc/modules/ROOT/pages/3.tutorials/3a.echo-server.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ This tutorial builds a production-quality echo server using the `tcp_server`
1313
framework. We'll explore worker pools, connection lifecycle, and the launcher
1414
pattern.
1515

16-
NOTE: Code snippets assume:
16+
[NOTE]
17+
====
18+
Code snippets assume:
1719
[source,cpp]
1820
----
1921
#include <boost/corosio/tcp_server.hpp>
@@ -23,6 +25,7 @@ NOTE: Code snippets assume:
2325
namespace corosio = boost::corosio;
2426
namespace capy = boost::capy;
2527
----
28+
====
2629

2730
== Overview
2831

doc/modules/ROOT/pages/3.tutorials/3b.http-client.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ This tutorial builds a simple HTTP client that connects to a server, sends
1313
a GET request, and reads the response. You'll learn socket connection,
1414
composed I/O operations, and the exception-based error handling pattern.
1515

16-
NOTE: Code snippets assume:
16+
[NOTE]
17+
====
18+
Code snippets assume:
1719
[source,cpp]
1820
----
1921
#include <boost/corosio.hpp>
@@ -26,6 +28,7 @@ NOTE: Code snippets assume:
2628
namespace corosio = boost::corosio;
2729
namespace capy = boost::capy;
2830
----
31+
====
2932

3033
== Overview
3134

doc/modules/ROOT/pages/3.tutorials/3c.dns-lookup.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ This tutorial builds a command-line DNS lookup tool similar to `nslookup`.
1313
You'll learn to use the asynchronous resolver to convert hostnames to IP
1414
addresses.
1515

16-
NOTE: Code snippets assume:
16+
[NOTE]
17+
====
18+
Code snippets assume:
1719
[source,cpp]
1820
----
1921
#include <boost/corosio.hpp>
@@ -23,6 +25,7 @@ NOTE: Code snippets assume:
2325
namespace corosio = boost::corosio;
2426
namespace capy = boost::capy;
2527
----
28+
====
2629

2730
== Overview
2831

doc/modules/ROOT/pages/3.tutorials/3d.tls-context.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@ This tutorial covers how to configure TLS contexts for secure connections.
1313
A `tls_context` stores certificates, keys, and settings that define how
1414
TLS connections are established and verified.
1515

16-
NOTE: Code snippets assume:
16+
[NOTE]
17+
====
18+
Code snippets assume:
1719
[source,cpp]
1820
----
1921
#include <boost/corosio/tls_context.hpp>
2022
2123
namespace tls = boost::corosio::tls;
2224
----
25+
====
2326

2427
== Introduction
2528

doc/modules/ROOT/pages/4.guide/4c.io-context.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ The `io_context` class is the heart of Corosio. It's an event loop that
1313
processes asynchronous I/O operations, manages timers, and coordinates
1414
coroutine execution.
1515

16-
NOTE: Code snippets assume:
16+
[NOTE]
17+
====
18+
Code snippets assume:
1719
[source,cpp]
1820
----
1921
#include <boost/corosio/io_context.hpp>
2022
namespace corosio = boost::corosio;
2123
----
24+
====
2225

2326
== Overview
2427

doc/modules/ROOT/pages/4.guide/4d.sockets.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ The `tcp_socket` class provides asynchronous TCP networking. It supports
1313
connecting to servers, reading and writing data, and graceful connection
1414
management.
1515

16-
NOTE: Code snippets assume:
16+
[NOTE]
17+
====
18+
Code snippets assume:
1719
[source,cpp]
1820
----
1921
#include <boost/corosio/tcp_socket.hpp>
@@ -23,6 +25,7 @@ NOTE: Code snippets assume:
2325
namespace corosio = boost::corosio;
2426
namespace capy = boost::capy;
2527
----
28+
====
2629

2730
== Overview
2831

doc/modules/ROOT/pages/4.guide/4e.tcp-acceptor.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
The `tcp_acceptor` class listens for incoming TCP connections and accepts them
1313
into socket objects. It's the foundation for building TCP servers.
1414

15-
NOTE: Code snippets assume:
15+
[NOTE]
16+
====
17+
Code snippets assume:
1618
[source,cpp]
1719
----
1820
#include <boost/corosio/tcp_acceptor.hpp>
@@ -21,6 +23,7 @@ NOTE: Code snippets assume:
2123
2224
namespace corosio = boost::corosio;
2325
----
26+
====
2427

2528
== Overview
2629

doc/modules/ROOT/pages/4.guide/4f.endpoints.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ The `endpoint` class represents a network endpoint: an IP address (IPv4 or
1313
IPv6) combined with a port number. Endpoints are used for connecting sockets
1414
and binding acceptors.
1515

16-
NOTE: Code snippets assume:
16+
[NOTE]
17+
====
18+
Code snippets assume:
1719
[source,cpp]
1820
----
1921
#include <boost/corosio/endpoint.hpp>
@@ -22,6 +24,7 @@ NOTE: Code snippets assume:
2224
2325
namespace corosio = boost::corosio;
2426
----
27+
====
2528

2629
== Overview
2730

doc/modules/ROOT/pages/4.guide/4g.composed-operations.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
Corosio provides composed operations that build on the primitive `read_some()`
1313
and `write_some()` functions to provide higher-level guarantees.
1414

15-
NOTE: Code snippets assume:
15+
[NOTE]
16+
====
17+
Code snippets assume:
1618
[source,cpp]
1719
----
1820
#include <boost/corosio/read.hpp>
@@ -22,6 +24,7 @@ NOTE: Code snippets assume:
2224
namespace corosio = boost::corosio;
2325
namespace capy = boost::capy;
2426
----
27+
====
2528

2629
== The Problem with Primitives
2730

doc/modules/ROOT/pages/4.guide/4h.timers.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ The `timer` class provides asynchronous delays and timeouts. It integrates
1414
with the I/O context to schedule operations at specific times or after
1515
durations.
1616

17-
NOTE: Code snippets assume:
17+
[NOTE]
18+
====
19+
Code snippets assume:
1820
[source,cpp]
1921
----
2022
#include <boost/corosio/timer.hpp>
2123
namespace corosio = boost::corosio;
2224
using namespace std::chrono_literals;
2325
----
26+
====
2427

2528
== Overview
2629

0 commit comments

Comments
 (0)