Doc[BMQT] re-wrap data member comments

Signed-off-by: Christopher Beard <[email protected]>
bloomberg · Oct 7, 2024 · 86b12f7 · 86b12f7
1 parent ff41ae6
commit 86b12f7
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 69 deletions.
diff --git a/src/groups/bmq/bmqt/bmqt_correlationid.h b/src/groups/bmq/bmqt/bmqt_correlationid.h
@@ -214,10 +214,9 @@ class CorrelationId {
 
     // DATA
 
-    /// The variant used to hold the value of a
-    /// 'CorrelationId', that may either be unset,
-    /// hold a 64-bit integer, a raw pointer, a
-    /// shared pointer, or an 'AutoValue'.
+    /// The variant used to hold the value of a 'CorrelationId', that may
+    /// either be unset, hold a 64-bit integer, a raw pointer, a shared
+    /// pointer, or an 'AutoValue'.
     bdlb::Variant4<bsls::Types::Int64, void*, bsl::shared_ptr<void>, AutoValue>
         d_variant;
 

diff --git a/src/groups/bmq/bmqt/bmqt_queueoptions.h b/src/groups/bmq/bmqt/bmqt_queueoptions.h
@@ -67,12 +67,10 @@ class QueueOptions {
   public:
     // PUBLIC CONSTANTS
 
-    /// Constant representing the minimum
-    /// valid consumer priority
+    /// Constant representing the minimum valid consumer priority
     static const int k_CONSUMER_PRIORITY_MIN;
 
-    /// Constant representing the maximum
-    /// valid consumer priority
+    /// Constant representing the maximum valid consumer priority
     static const int k_CONSUMER_PRIORITY_MAX;
 
     static const int  k_DEFAULT_MAX_UNCONFIRMED_MESSAGES;
@@ -88,15 +86,13 @@ class QueueOptions {
     // DATA
     Subscription d_info;
 
-    /// Whether the queue suspends operation
-    /// while the host is unhealthy.
+    /// Whether the queue suspends operation while the host is unhealthy.
     bsl::optional<bool> d_suspendsOnBadHostHealth;
 
     Subscriptions d_subscriptions;
 
-    /// 'true' if 'd_subscriptions' had a value, 'false'
-    /// otherwise.  Emulates 'bsl::optional' for
-    /// 'd_subscriptions'.
+    /// 'true' if 'd_subscriptions' had a value, 'false' otherwise.  Emulates
+    /// 'bsl::optional' for 'd_subscriptions'.
     bool d_hadSubscriptions;
 
     /// Allocator

diff --git a/src/groups/bmq/bmqt/bmqt_sessionoptions.h b/src/groups/bmq/bmqt/bmqt_sessionoptions.h
@@ -165,42 +165,35 @@ class SessionOptions {
     /// Default URI of the 'bmqbrkr' to connect to.
     static const char k_BROKER_DEFAULT_URI[];
 
-    /// Default port the 'bmqbrkr' is listening to for client
-    /// to connect.
+    /// Default port the 'bmqbrkr' is listening to for client to connect.
     static const int k_BROKER_DEFAULT_PORT = 30114;
 
-    /// The default, and minimum recommended, value for queue
-    /// operations (open, configure, close).
+    /// The default, and minimum recommended, value for queue operations (open,
+    /// configure, close).
     static const int k_QUEUE_OPERATION_DEFAULT_TIMEOUT =
         5 * bdlt::TimeUnitRatio::k_SECONDS_PER_MINUTE;
 
   private:
     // DATA
 
-    /// URI of the broker to connect to (ex:
-    /// 'tcp://localhost:30114').  Default
+    /// URI of the broker to connect to (ex: 'tcp://localhost:30114'). Default
     /// is to connect to the local broker.
     bsl::string d_brokerUri;
 
-    /// If not empty, use this value for the
-    /// processName in the identity message
-    /// (useful for scripted language
-    /// bindings).
+    /// If not empty, use this value for the processName in the identity
+    /// message (useful for scripted language bindings).
     bsl::string d_processNameOverride;
 
-    /// Number of processing threads.
-    /// Default is 1 thread.
+    /// Number of processing threads. Default is 1 thread.
     int d_numProcessingThreads;
 
     /// Size of the blobs buffer.
     int d_blobBufferSize;
 
-    /// Write cache high watermark to use on
-    /// the channel
+    /// Write cache high watermark to use on the channel
     bsls::Types::Int64 d_channelHighWatermark;
 
-    /// Interval at which to dump stats to
-    /// log file (0 to disable dump)
+    /// Interval at which to dump stats to log file (0 to disable dump)
     bsls::TimeInterval d_statsDumpInterval;
 
     bsls::TimeInterval d_connectTimeout;
@@ -211,19 +204,16 @@ class SessionOptions {
 
     bsls::TimeInterval d_configureQueueTimeout;
 
-    /// Timeout for operations of the
-    /// corresponding type.
+    /// Timeout for operations of the corresponding type.
     bsls::TimeInterval d_closeQueueTimeout;
 
     int d_eventQueueLowWatermark;
 
-    /// Parameters to configure the
-    /// EventQueue.
+    /// Parameters to configure the EventQueue.
     int d_eventQueueHighWatermark;
 
-    /// DEPRECATED: This parameter is no
-    /// longer relevant and will be removed
-    /// in future release of libbmq.
+    /// DEPRECATED: This parameter is no longer relevant and will be removed in
+    /// future release of libbmq.
     int d_eventQueueSize;
 
     bsl::shared_ptr<bmqpi::HostHealthMonitor> d_hostHealthMonitor_sp;

diff --git a/src/groups/bmq/bmqt/bmqt_subscription.h b/src/groups/bmq/bmqt/bmqt_subscription.h
@@ -61,16 +61,16 @@ class SubscriptionHandle {
     friend class bmqa::MessageIterator;
 
   public:
+    /// Initial (invalid) value for 'bmqt::SubscriptionHandle::d_id'
     static const unsigned int k_INVALID_HANDLE_ID = 0;
-    // Initial (invalid) value for 'bmqt::SubscriptionHandle::d_id'
 
   private:
     // PRIVATE DATA
+
+    /// Internal, unique key
     unsigned int d_id;
-    // Internal, unique key
 
-    /// User-specified, not required to be
-    /// unique
+    /// User-specified, not required to be unique
     bmqt::CorrelationId d_correlationId;
 
   private:
@@ -127,16 +127,18 @@ class SubscriptionExpression {
     /// Enum representing criteria format
     enum Enum {
         /// EMPTY
-        e_NONE = 0,
+        e_NONE = 0
+
+        ,
         /// Simple Evaluator
         e_VERSION_1 = 1
     };
 
   private:
     bsl::string d_expression;  // e.g., "firmId == foo"
 
-    Enum d_version;  // Required to support newer style
-                     // of expressions in future
+    // Required to support newer style of expressions in future
+    Enum d_version;
 
   public:
     // CREATORS
@@ -168,12 +170,10 @@ class Subscription {
   public:
     // PUBLIC CONSTANTS
 
-    /// Constant representing the minimum
-    /// valid consumer priority
+    /// Constant representing the minimum valid consumer priority
     static const int k_CONSUMER_PRIORITY_MIN;
 
-    /// Constant representing the maximum
-    /// valid consumer priority
+    /// Constant representing the maximum valid consumer priority
     static const int k_CONSUMER_PRIORITY_MAX;
 
     static const int k_DEFAULT_MAX_UNCONFIRMED_MESSAGES;
@@ -183,19 +183,15 @@ class Subscription {
   private:
     // PRIVATE DATA
 
-    /// Maximum number of outstanding
-    /// messages that can be sent by the
-    /// broker without being confirmed.
+    /// Maximum number of outstanding messages that can be sent by the broker
+    /// without being confirmed.
     bsl::optional<int> d_maxUnconfirmedMessages;
 
-    /// Maximum accumulated bytes of all
-    /// outstanding messages that can be
-    /// sent by the broker without being
-    /// confirmed.
+    /// Maximum accumulated bytes of all outstanding messages that can be sent
+    /// by the broker without being confirmed.
     bsl::optional<int> d_maxUnconfirmedBytes;
 
-    /// Priority of a consumer with respect
-    /// to delivery of messages
+    /// Priority of a consumer with respect to delivery of messages
     bsl::optional<int> d_consumerPriority;
 
     SubscriptionExpression d_expression;

diff --git a/src/groups/bmq/bmqt/bmqt_uri.h b/src/groups/bmq/bmqt/bmqt_uri.h
@@ -174,27 +174,31 @@ class Uri {
 
   private:
     // DATA
-    bsl::string d_uri;  // The full URI
 
-    bslstl::StringRef d_scheme;  // URI scheme (must be "bmq").
+    /// The full URI
+    bsl::string d_uri;
 
-    bslstl::StringRef d_authority;  // URI authority (domain + optional
-                                    // tier)
+    /// URI scheme (must be "bmq").
+    bslstl::StringRef d_scheme;
 
-    bslstl::StringRef d_domain;  // URI domain
+    /// URI authority (domain + optional tier)
+    bslstl::StringRef d_authority;
 
-    bslstl::StringRef d_tier;  // URI tier
+    /// URI domain
+    bslstl::StringRef d_domain;
 
-    bslstl::StringRef d_path;  // URI path (i.e queue name).
+    /// URI tier
+    bslstl::StringRef d_tier;
 
-    bslstl::StringRef d_query_id;  // Optional application id, part of the
-                                   // URI query if present.
+    /// URI path (i.e queue name).
+    bslstl::StringRef d_path;
 
+    /// Optional application id, part of the URI query if present.
+    bslstl::StringRef d_query_id;
+
+    /// Flag indicating whether the URI parser was initialized (and whether
+    /// shutdown should be called on it at destruction)
     bool d_wasParserInitialized;
-    // Flag indicating whether the URI
-    // parser was initialized (and whether
-    // shutdown should be called on it at
-    // destruction)
 
   private:
     // PRIVATE MANIPULATORS