Skip to content

Commit

Permalink
Update docs per reviewers
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Carroll <michael@openrobotics.org>
  • Loading branch information
mjcarroll committed Apr 23, 2020
1 parent 70c6417 commit 8a3739f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions rmw/include/rmw/message_sequence.h
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,33 @@ RMW_PUBLIC
rmw_ret_t
rmw_message_sequence_fini(rmw_message_sequence_t * sequence);

/// Return an rmw_message_info_sequence_t struct with members initialized to `NULL`
RMW_PUBLIC
rmw_message_info_sequence_t
rmw_get_zero_initialized_message_info_sequence(void);

/// Initialize an rmw_message_info_sequence_t object.
/**
* \param[inout] sequence sequence object to be initialized.
* \param[in] size capacity of the sequence to be allocated.
* \param[in] allocator the allcator used to allocate memory.
*/
RMW_PUBLIC
rmw_ret_t
rmw_message_info_sequence_init(
rmw_message_info_sequence_t * sequence,
size_t size,
rcutils_allocator_t * allocator);

/// Finalize an rmw_message_sequence_t object.
/**
* The rmw_message_sequence_t struct has members which require memory to be allocated to them
* before setting values.
* This function reclaims any allocated resources within the object and zeroes out all other
* members.
*
* \param[inout] sequence sequence object to be finalized.
*/
RMW_PUBLIC
rmw_ret_t
rmw_message_info_sequence_fini(rmw_message_info_sequence_t * sequence);
Expand Down

0 comments on commit 8a3739f

Please sign in to comment.