Clarify teardown and async_teardown are customization points

Addresses #2479
boostorg · Jan 26, 2024 · 5f088b7 · 5f088b7
1 parent 3b837c6
commit 5f088b7
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/include/boost/beast/websocket/ssl.hpp b/include/boost/beast/websocket/ssl.hpp
@@ -27,6 +27,11 @@ namespace beast {
     `net::ssl::stream`, callers are responsible for
     providing a suitable overload of this function.
 
+    @note
+
+    This function serves as a customization point and is not intended
+    to be called directly.
+
     @param role The role of the local endpoint
 
     @param stream The stream to tear down.
@@ -50,6 +55,11 @@ teardown(
     callers are responsible for providing a suitable overload
     of this function.
 
+    @note
+
+    This function serves as a customization point and is not intended
+    to be called directly.
+
     @param role The role of the local endpoint
 
     @param stream The stream to tear down.

diff --git a/include/boost/beast/websocket/teardown.hpp b/include/boost/beast/websocket/teardown.hpp
@@ -29,6 +29,11 @@ namespace websocket {
     `net::ssl::stream`, callers are responsible for
     providing a suitable overload of this function.
 
+    @note
+
+    This function serves as a customization point and is not intended
+    to be called directly.
+
     @param role The role of the local endpoint
 
     @param socket The socket to tear down.
@@ -65,6 +70,11 @@ teardown(
     callers are responsible for providing a suitable overload
     of this function.
 
+    @note
+
+    This function serves as a customization point and is not intended
+    to be called directly.
+
     @param role The role of the local endpoint
 
     @param socket The socket to tear down.
@@ -122,6 +132,11 @@ namespace websocket {
     `net::ssl::stream`, callers are responsible for
     providing a suitable overload of this function.
 
+    @note
+
+    This function serves as a customization point and is not intended
+    to be called directly.
+
     @param role The role of the local endpoint
 
     @param socket The socket to tear down.
@@ -146,6 +161,11 @@ teardown(
     callers are responsible for providing a suitable overload
     of this function.
 
+    @note
+
+    This function serves as a customization point and is not intended
+    to be called directly.
+
     @param role The role of the local endpoint
 
     @param socket The socket to tear down.