Fix[BMQT] minor bde -> doxygen docs

Signed-off-by: Christopher Beard <[email protected]>

src/groups/bmq/bmqt/bmqt_correlationid.h

@@ -213,12 +213,13 @@ class CorrelationId {
     typedef bsls::Types::Uint64 AutoValue;
 
     // 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'.
     bdlb::Variant4<bsls::Types::Int64, void*, bsl::shared_ptr<void>, AutoValue>
         d_variant;
-    // 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'.
 
     // PRIVATE ACCESSORS
 

src/groups/bmq/bmqt/bmqt_messageguid.h

@@ -102,13 +102,15 @@ class MessageGUID {
 
   public:
     // TYPES
+
+    /// Enum representing the size of a buffer needed to represent a GUID
     enum Enum {
-        // Enum representing the size of a buffer needed to represent a GUID
-        e_SIZE_BINARY = 16  // Binary format of the GUID
+        /// Binary format of the GUID
+        e_SIZE_BINARY = 16
 
         ,
+        /// Hexadecimal string representation of the GUID
         e_SIZE_HEX = 2 * e_SIZE_BINARY
-        // Hexadecimal string representation of the GUID
     };
 
     // TRAITS
@@ -118,8 +120,9 @@ class MessageGUID {
 
   private:
     // PRIVATE CONSTANTS
+
+    /// Constant representing an unset GUID
     static const char k_UNSET_GUID[e_SIZE_BINARY];
-    //  Constant representing an unset GUID
 
   private:
     // IMPLEMENTATION NOTE: Some structs in bmqp::Protocol.h blindly

src/groups/bmq/bmqt/bmqt_queueoptions.h

@@ -66,13 +66,14 @@ namespace bmqt {
 class QueueOptions {
   public:
     // PUBLIC CONSTANTS
+
+    /// Constant representing the minimum
+    /// valid consumer priority
     static const int k_CONSUMER_PRIORITY_MIN;
-    // Constant representing the minimum
-    // valid consumer priority
 
+    /// Constant representing the maximum
+    /// valid consumer priority
     static const int k_CONSUMER_PRIORITY_MAX;
-    // Constant representing the maximum
-    // valid consumer priority
 
     static const int  k_DEFAULT_MAX_UNCONFIRMED_MESSAGES;
     static const int  k_DEFAULT_MAX_UNCONFIRMED_BYTES;
@@ -87,19 +88,19 @@ class QueueOptions {
     // DATA
     Subscription d_info;
 
+    /// Whether the queue suspends operation
+    /// while the host is unhealthy.
     bsl::optional<bool> d_suspendsOnBadHostHealth;
-    // Whether the queue suspends operation
-    // while the host is unhealthy.
 
     Subscriptions d_subscriptions;
 
+    /// 'true' if 'd_subscriptions' had a value, 'false'
+    /// otherwise.  Emulates 'bsl::optional' for
+    /// 'd_subscriptions'.
     bool d_hadSubscriptions;
-    // 'true' if 'd_subscriptions' had a value, 'false'
-    // otherwise.  Emulates 'bsl::optional' for
-    // 'd_subscriptions'.
 
+    /// Allocator
     bslma::Allocator* d_allocator_p;
-    // Allocator
 
   public:
     // PUBLIC TYPES

src/groups/bmq/bmqt/bmqt_sessionoptions.h

@@ -161,45 +161,47 @@ namespace bmqt {
 class SessionOptions {
   public:
     // CONSTANTS
+
+    /// Default URI of the 'bmqbrkr' to connect to.
     static const char k_BROKER_DEFAULT_URI[];
-    // Default URI of the 'bmqbrkr' to connect to.
 
+    /// Default port the 'bmqbrkr' is listening to for client
+    /// to connect.
     static const int k_BROKER_DEFAULT_PORT = 30114;
-    // Default port the 'bmqbrkr' is listening to for client
-    // to connect.
 
+    /// 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;
-    // The default, and minimum recommended, value for queue
-    // operations (open, configure, close).
 
   private:
     // DATA
+
+    /// URI of the broker to connect to (ex:
+    /// 'tcp://localhost:30114').  Default
+    /// is to connect to the local broker.
     bsl::string d_brokerUri;
-    // URI of the broker to connect to (ex:
-    // 'tcp://localhost:30114').  Default
-    // is to connect to the local broker.
 
+    /// If not empty, use this value for the
+    /// processName in the identity message
+    /// (useful for scripted language
+    /// bindings).
     bsl::string d_processNameOverride;
-    // If not empty, use this value for the
-    // processName in the identity message
-    // (useful for scripted language
-    // bindings).
 
+    /// Number of processing threads.
+    /// Default is 1 thread.
     int d_numProcessingThreads;
-    // Number of processing threads.
-    // Default is 1 thread.
 
+    /// Size of the blobs buffer.
     int d_blobBufferSize;
-    // Size of the blobs buffer.
 
+    /// Write cache high watermark to use on
+    /// the channel
     bsls::Types::Int64 d_channelHighWatermark;
-    // Write cache high watermark to use on
-    // the channel
 
+    /// Interval at which to dump stats to
+    /// log file (0 to disable dump)
     bsls::TimeInterval d_statsDumpInterval;
-    // Interval at which to dump stats to
-    // log file (0 to disable dump)
 
     bsls::TimeInterval d_connectTimeout;
 
@@ -209,20 +211,20 @@ class SessionOptions {
 
     bsls::TimeInterval d_configureQueueTimeout;
 
+    /// Timeout for operations of the
+    /// corresponding type.
     bsls::TimeInterval d_closeQueueTimeout;
-    // Timeout for operations of the
-    // corresponding type.
 
     int d_eventQueueLowWatermark;
 
+    /// Parameters to configure the
+    /// EventQueue.
     int d_eventQueueHighWatermark;
-    // Parameters to configure the
-    // EventQueue.
 
+    /// DEPRECATED: This parameter is no
+    /// longer relevant and will be removed
+    /// in future release of libbmq.
     int d_eventQueueSize;
-    // DEPRECATED: This parameter is no
-    // longer relevant and will be removed
-    // in future release of libbmq.
 
     bsl::shared_ptr<bmqpi::HostHealthMonitor> d_hostHealthMonitor_sp;
 

src/groups/bmq/bmqt/bmqt_subscription.h

@@ -69,9 +69,10 @@ class SubscriptionHandle {
     unsigned int d_id;
     // Internal, unique key
 
+    /// User-specified, not required to be
+    /// unique
     bmqt::CorrelationId d_correlationId;
-    // User-specified, not required to be
-    // unique
+
   private:
     // PRIVATE CLASS METHODS
     static unsigned int nextId();
@@ -122,11 +123,13 @@ class SubscriptionHandle {
 class SubscriptionExpression {
   public:
     // TYPES
+
+    /// Enum representing criteria format
     enum Enum {
-        // Enum representing criteria format
-        e_NONE = 0  // EMPTY
-        ,
-        e_VERSION_1 = 1  // Simple Evaluator
+        /// EMPTY
+        e_NONE = 0,
+        /// Simple Evaluator
+        e_VERSION_1 = 1
     };
 
   private:
@@ -164,39 +167,42 @@ class SubscriptionExpression {
 class Subscription {
   public:
     // PUBLIC CONSTANTS
+
+    /// Constant representing the minimum
+    /// valid consumer priority
     static const int k_CONSUMER_PRIORITY_MIN;
-    // Constant representing the minimum
-    // valid consumer priority
 
+    /// Constant representing the maximum
+    /// valid consumer priority
     static const int k_CONSUMER_PRIORITY_MAX;
-    // Constant representing the maximum
-    // valid consumer priority
 
     static const int k_DEFAULT_MAX_UNCONFIRMED_MESSAGES;
     static const int k_DEFAULT_MAX_UNCONFIRMED_BYTES;
     static const int k_DEFAULT_CONSUMER_PRIORITY;
 
   private:
     // PRIVATE DATA
+
+    /// Maximum number of outstanding
+    /// messages that can be sent by the
+    /// broker without being confirmed.
     bsl::optional<int> d_maxUnconfirmedMessages;
-    // Maximum number of 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;
-    // Maximum accumulated bytes of all
-    // outstanding messages that can be
-    // sent by the broker without being
-    // confirmed.
 
+    /// Priority of a consumer with respect
+    /// to delivery of messages
     bsl::optional<int> d_consumerPriority;
-    // Priority of a consumer with respect
-    // to delivery of messages
 
     SubscriptionExpression d_expression;
 
   public:
     // CREATORS
+
     /// Create a new Subscription
     Subscription();