Apply suggestions from code review

Co-authored-by: Evgeny Malygin <[email protected]>
Signed-off-by: Chris Beard <[email protected]>

src/groups/bmq/bmqa/bmqa_closequeuestatus.h

@@ -63,7 +63,7 @@ class CloseQueueStatus {
   private:
     // DATA
 
-    /// queueId associated with the open queue operation
+    /// QueueId associated with the open queue operation
     QueueId d_queueId;
 
     /// Result code of the operation (success, failure)

src/groups/bmq/bmqa/bmqa_configurequeuestatus.h

@@ -62,7 +62,7 @@ class ConfigureQueueStatus {
   private:
     // DATA
 
-    /// queueId associated with the open queue operation
+    /// QueueId associated with the open queue operation
     QueueId d_queueId;
 
     /// Status code of the operation (success, failure)

src/groups/bmq/bmqa/bmqa_message.h

@@ -118,7 +118,7 @@ struct MessageImpl {
     bmqt::SubscriptionHandle d_subscriptionHandle;
 
 #ifdef BMQ_ENABLE_MSG_GROUPID
-    /// Optional Group Id this message is associated with
+    /// Optional GroupId this message is associated with
     bsl::string d_groupId;
 #endif
 };

src/groups/bmq/bmqa/bmqa_messageeventbuilder.h

@@ -285,10 +285,10 @@ namespace bmqa {
 struct MessageEventBuilderImpl {
     // PUBLIC DATA
 
-    // This is needed so that 'getMessageEvent()' can return a const ref.
+    /// This is needed so that `getMessageEvent()` can return a const ref.
     MessageEvent d_msgEvent;
 
-    // This is needed so that 'startMessage()' can return a ref.
+    /// This is needed so that `startMessage()` can return a ref.
     Message d_msg;
 
     // GUID generator object.

src/groups/bmq/bmqa/bmqa_messageiterator.h

@@ -68,13 +68,13 @@ struct MessageIteratorImpl {
     /// Raw pointer to the event
     bmqimp::Event* d_event_p;
 
-    /// A 'Message', representing a view to the current message pointing at by
-    /// this iterator.  This is so that 'message' can return a 'const Message&'
+    /// A `Message`, representing a view to the current message pointing at by
+    /// this iterator.  This is so that `message` can return a 'const Message&'
     /// to clearly indicate the lifetime of the Message, and so that we only
     /// create one such object per MessageIterator.
     bmqa::Message d_message;
 
-    /// Position of 'd_message' in the underlying message event.
+    /// Position of `d_message` in the underlying message event.
     int d_messageIndex;
 };
 

src/groups/bmq/bmqa/bmqa_messageproperties.h

@@ -108,7 +108,7 @@ class MessageProperties {
   private:
     // DATA
 
-    /// Pointer to the implementation object in 'd_buffer', providing a
+    /// Pointer to the implementation object in `d_buffer`, providing a
     /// shortcut type safe cast to that object. This variable *must* *be* the
     /// first member of this class, as other components in bmqa package may
     /// reinterpret_cast to that variable.

src/groups/bmq/bmqa/bmqa_mocksession.h

@@ -609,11 +609,11 @@ struct MockSessionUtil {
     // PRIVATE TYPES
 
     /// Event impl shared pointer to access
-    /// the pimpl of 'bmqa::Event'.
+    /// the pimpl of `bmqa::Event`.
     typedef bsl::shared_ptr<bmqimp::Event> EventImplSp;
 
     /// Queue impl shared pointer to access
-    /// the pimpl of 'bmqa::QueueId'.
+    /// the pimpl of `bmqa::QueueId`.
     typedef bsl::shared_ptr<bmqimp::Queue> QueueImplSp;
 
   public:
@@ -626,13 +626,13 @@ struct MockSessionUtil {
         /// Status code
         bmqt::AckResult::Enum d_status;
 
-        /// Correlation id
+        /// CorrelationId
         bmqt::CorrelationId d_correlationId;
 
         /// Message GUID of confirmed message
         bmqt::MessageGUID d_guid;
 
-        /// Queue id for message being referred to
+        /// QueueId for message being referred to
         QueueId d_queueId;
 
         // CREATORS
@@ -654,7 +654,7 @@ struct MockSessionUtil {
         /// Payload of message
         bdlbb::Blob d_payload;
 
-        /// Queue Id for this message
+        /// QueueId for this message
         QueueId d_queueId;
 
         /// GUID for message
@@ -823,7 +823,7 @@ class MockSession : public AbstractSession {
     struct Job {
         // PUBLIC DATA
 
-        /// Signature of a 'void' callback method
+        /// Signature of a `void` callback method
         CallbackFn d_callback;
 
         /// Queue associated with this job
@@ -839,7 +839,7 @@ class MockSession : public AbstractSession {
 
     typedef bdlb::Variant<Event, Job> EventOrJob;
 
-    /// Enumeration for the methods in the 'MockSession' protocol.  Each
+    /// Enumeration for the methods in the `MockSession` protocol.  Each
     /// enum value corresponds to a method.
     enum Method {
         e_START,

src/groups/bmq/bmqa/bmqa_openqueuestatus.h

@@ -63,7 +63,7 @@ class OpenQueueStatus {
   private:
     // DATA
 
-    /// queueId associated with the open queue operation
+    /// QueueId associated with the open queue operation
     QueueId d_queueId;
 
     /// Result code of the operation (success, failure)

src/groups/bmq/bmqt/bmqt_correlationid.h

@@ -214,9 +214,9 @@ class CorrelationId {
 
     // DATA
 
-    /// The variant used to hold the value of a 'CorrelationId', that may
+    /// 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'.
+    /// pointer, or an `AutoValue`.
     bdlb::Variant4<bsls::Types::Int64, void*, bsl::shared_ptr<void>, AutoValue>
         d_variant;
 

src/groups/bmq/bmqt/bmqt_queueoptions.h

@@ -91,8 +91,8 @@ class QueueOptions {
 
     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

src/groups/bmq/bmqt/bmqt_sessionoptions.h

@@ -162,10 +162,10 @@ class SessionOptions {
   public:
     // CONSTANTS
 
-    /// Default URI of the 'bmqbrkr' to connect to.
+    /// 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,
@@ -176,7 +176,7 @@ class SessionOptions {
   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;
 

src/groups/bmq/bmqt/bmqt_subscription.h

@@ -61,7 +61,7 @@ class SubscriptionHandle {
     friend class bmqa::MessageIterator;
 
   public:
-    /// Initial (invalid) value for 'bmqt::SubscriptionHandle::d_id'
+    /// Initial (invalid) value for `bmqt::SubscriptionHandle::d_id`
     static const unsigned int k_INVALID_HANDLE_ID = 0;
 
   private: