PROTON-2860: Remove the unsettled API marker from the C++ reconnect API

apache · Oct 29, 2024 · 6b95b8b · 6b95b8b
1 parent 60ab050
commit 6b95b8b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/cpp/include/proton/connection_options.hpp b/cpp/include/proton/connection_options.hpp
@@ -171,13 +171,13 @@ class connection_options {
     /// **Unsettled API** - Set the SASL configuration path.
     PN_CPP_EXTERN connection_options& sasl_config_path(const std::string&);
 
-    /// **Unsettled API** - Set reconnect timing options.
+    /// Set reconnect timing options.
     ///
     /// If reconnect timing options are set, but no specific reconnect or failover urls are set
     /// then the original url used for the connection will be used as the reconnect url.
     PN_CPP_EXTERN connection_options& reconnect(const reconnect_options&);
 
-    /// **Unsettled API** - Set reconnect URL.
+    /// Set reconnect URL.
     ///
     /// If the connection to the primary connection url fails then try to reconnect using
     /// the reconnect url.
@@ -192,7 +192,7 @@ class connection_options {
     /// If both the failover_urls and reconnect_url options are set then the behavior is not defined.
     PN_CPP_EXTERN connection_options& reconnect_url(const std::string&);
 
-    /// **Unsettled API** - Set Fail-over URLs.
+    /// Set Fail-over URLs.
     ///
     /// If the connection to the primary connection url fails then try each of the fail-over
     /// connection urls in turn.

diff --git a/cpp/include/proton/reconnect_options.hpp b/cpp/include/proton/reconnect_options.hpp
@@ -35,8 +35,7 @@
 
 namespace proton {
 
-/// **Unsettled API** - Options for reconnect and failover after
-/// connection loss.
+/// Options for reconnect and failover after connection loss.
 ///
 /// These options determine a series of delays to coordinate
 /// reconnection attempts.  They may be open-ended or limited in time.