Skip to content

Commit 6c65d97

Browse files
committed
Docs[bmqa]: Doxygenify bmqa_message::setData
This patch converts a remnant BDE documentation comment to Doxygen format. Signed-off-by: Patrick M. Niedzielski <[email protected]>
1 parent 5a739f7 commit 6c65d97

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/groups/bmq/bmqa/bmqa_message.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -209,17 +209,17 @@ class Message {
209209
/// This method is deprecated, please use `setDataRef()` instead.
210210
Message& setData(const bdlbb::Blob* data) BSLS_ANNOTATION_DEPRECATED;
211211

212+
/// Set the payload of this message to the specified `length` bytes
213+
/// starting at the specified `data` address. The behavior is undefined
214+
/// unless `data` is non-null and `length` is greater than zero. Note that
215+
/// payload pointed to by `data` is *not* copied right away, and should not
216+
/// be destroyed or modified until this message has been packed (see
217+
/// `bmqa::MessageEventBuilder` component level documentation for correct
218+
/// usage).
219+
///
220+
/// This method is deprecated, please use `setDataRef()` instead.
212221
Message& setData(const char* data,
213222
size_t length) BSLS_ANNOTATION_DEPRECATED;
214-
// Set the payload of this message to the specified 'length' bytes
215-
// starting at the specified 'data' address. The behavior is undefined
216-
// unless 'data' is non-null and 'length' is greater than zero. Note
217-
// that payload pointed to by 'data' is *not* copied right away, and
218-
// should not be destroyed or modified until this message has been
219-
// packed (see 'bmqa::MessageEventBuilder' component level
220-
// documentation for correct usage).
221-
//
222-
// This method is deprecated, please use 'setDataRef()' instead.
223223

224224
/// Set the payload of this message to the blob pointed to by the
225225
/// specified `data`. Behavior is undefined unless `data` is non-null

0 commit comments

Comments
 (0)