Skip to content

Commit

Permalink
Fix[BMQA] minor bde -> doxygen docs
Browse files Browse the repository at this point in the history
Signed-off-by: Christopher Beard <[email protected]>
  • Loading branch information
chrisbeard committed Oct 7, 2024
1 parent a9162fe commit 9069182
Show file tree
Hide file tree
Showing 8 changed files with 144 additions and 129 deletions.
21 changes: 11 additions & 10 deletions src/groups/bmq/bmqa/bmqa_closequeuestatus.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,28 +62,29 @@ namespace bmqa {
class CloseQueueStatus {
private:
// DATA

/// queueId associated with the open
/// queue operation
QueueId d_queueId;
// queueId associated with the open
// queue operation

/// Result code of the operation
/// (success, failure)
bmqt::CloseQueueResult::Enum d_result;
// Result code of the operation
// (success, failure)

/// Optional string with a human
/// readable description of the error,
/// if any
bsl::string d_errorDescription;
// Optional string with a human
// readable description of the error,
// if any

public:
// TRAITS
BSLMF_NESTED_TRAIT_DECLARATION(CloseQueueStatus, bslma::UsesBslmaAllocator)

// TYPES

// Use of an `UnspecifiedBool` to prevent implicit conversions to
// integral values, and comparisons between different classes which
// have boolean operators.
/// Use of an `UnspecifiedBool` to prevent implicit conversions to
/// integral values, and comparisons between different classes which
/// have boolean operators.
typedef bsls::UnspecifiedBool<CloseQueueStatus>::BoolType BoolType;

// CREATORS
Expand Down
15 changes: 8 additions & 7 deletions src/groups/bmq/bmqa/bmqa_configurequeuestatus.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,19 @@ namespace bmqa {
class ConfigureQueueStatus {
private:
// DATA

/// queueId associated with the open
/// queue operation
QueueId d_queueId;
// queueId associated with the open
// queue operation

/// Status code of the operation
/// (success, failure)
bmqt::ConfigureQueueResult::Enum d_result;
// Status code of the operation
// (success, failure)

/// Optional string with a human
/// readable description of the error,
/// if any
bsl::string d_errorDescription;
// Optional string with a human
// readable description of the error,
// if any

public:
// TRAITS
Expand Down
26 changes: 14 additions & 12 deletions src/groups/bmq/bmqa/bmqa_message.h
Original file line number Diff line number Diff line change
Expand Up @@ -101,25 +101,26 @@ class MessageProperties;
/// `bmqa::MessageIterator.nextMessage()`.
struct MessageImpl {
// PUBLIC DATA

/// Pointer to the Event this message is
/// associated with
bmqimp::Event* d_event_p;
// Pointer to the Event this message is
// associated with

/// May point to a bmqimp::Event (in case
/// this Message is a clone)
bsl::shared_ptr<bmqimp::Event> d_clonedEvent_sp;
// May point to a bmqimp::Event (in case
// this Message is a clone)

/// QueueId this message is associated
/// with
bmqa::QueueId d_queueId;
// QueueId this message is associated
// with

/// CorrelationId this message is
/// associated with
bmqt::CorrelationId d_correlationId;
// CorrelationId this message is
// associated with

/// SubscriptionHandle this message is
/// associated with
bmqt::SubscriptionHandle d_subscriptionHandle;
// SubscriptionHandle this message is
// associated with

#ifdef BMQ_ENABLE_MSG_GROUPID
bsl::string d_groupId;
Expand All @@ -136,11 +137,12 @@ struct MessageImpl {
class MessageConfirmationCookie {
private:
// DATA

/// QueueID associated to this cookie
bmqa::QueueId d_queueId;
// QueueID associated to this cookie

/// GUID associated to this cookie
bmqt::MessageGUID d_guid;
// GUID associated to this cookie

public:
// CREATORS
Expand Down
4 changes: 2 additions & 2 deletions src/groups/bmq/bmqa/bmqa_messageiterator.h
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ struct MessageIteratorImpl {
// the Message, and so that we only create one
// such object per MessageIterator.

/// Position of 'd_message' in the underlying
/// message event.
int d_messageIndex;
// Position of 'd_message' in the underlying
// message event.
};

// =====================
Expand Down
25 changes: 13 additions & 12 deletions src/groups/bmq/bmqa/bmqa_messageproperties.h
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ class MessageProperties {
private:
// PRIVATE CONSTANTS

// Constant representing the maximum size of a
// `bmqp::MessageProperties` object, so that the below AlignedBuffer
// is big enough.
/// Constant representing the maximum size of a
/// `bmqp::MessageProperties` object, so that the below AlignedBuffer
/// is big enough.
static const int k_MAX_SIZEOF_BMQP_MESSAGEPROPERTIES = 184;

// PRIVATE TYPES
Expand All @@ -107,18 +107,19 @@ class MessageProperties {

private:
// DATA

/// 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.
mutable bmqp::MessageProperties* d_impl_p;
// 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.

/// Buffer containing the implementation
/// object, maximally aligned.
ImplBuffer d_buffer;
// Buffer containing the implementation
// object, maximally aligned.

bslma::Allocator* d_allocator_p;

Expand Down
Loading

0 comments on commit 9069182

Please sign in to comment.