Skip to content

Commit

Permalink
Add docblock
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
  • Loading branch information
ivanpauno committed Apr 22, 2020
1 parent 28b21cb commit 2e2e9fc
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion rcl/include/rcl/init_options.h
Original file line number Diff line number Diff line change
Expand Up @@ -144,14 +144,34 @@ rcl_init_options_fini(rcl_init_options_t * init_options);
* Lock-Free | Yes
*
* \param[in] init_options object from which the rmw init options should be retrieved
* \return pointer to the the rmw init options, or
* \return pointer to the the rcl init options, or
* \return `NULL` if there was an error
*/
RCL_PUBLIC
RCL_WARN_UNUSED
rmw_init_options_t *
rcl_init_options_get_rmw_init_options(rcl_init_options_t * init_options);

/// Return the allocator stored in the init_options.
/**
* This function can fail and return `NULL` if:
* - init_options is NULL
* - init_options is invalid, e.g. init_options->impl is NULL
*
* If NULL is returned an error message will have been set.
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Thread-Safe | Yes
* Uses Atomics | No
* Lock-Free | Yes
*
* \param[in] init_options object from which the allocator should be retrieved
* \return pointer to the rcl allocator, or
* \return `NULL` if there was an error
*/
RCL_PUBLIC
RCL_WARN_UNUSED
const rcl_allocator_t *
Expand Down

0 comments on commit 2e2e9fc

Please sign in to comment.