niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

pass allocator to rcl_init and clean up docs

Browse source
This commit is contained in:
William Woodall 2015-11-24 03:44:21 -08:00
parent 9631cba157
commit d9e493a387
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
rcl/include/rcl/rcl.h
View file

@ -43,14 +43,17 @@ extern "C"
* program. * program.
* rcl specific arguments will be parsed and removed, but other arguments will * rcl specific arguments will be parsed and removed, but other arguments will
* be ignored. * be ignored.
* If argc is 0 and argv is NULL no parameters will be parsed.
* *
* \param[in] argc number of strings in argv * \param[in] argc number of strings in argv
* \param[in] argv command line arguments; rcl specific arguments are removed * \param[in] argv command line arguments; rcl specific arguments are removed
* \return RCL_RET_OK if initialization is successful, otherwise RCL_RET_ERROR * \param[in] allocator allocator to be used during rcl_init and rcl_fini
* or RCL_RET_ALREADY_INIT if rcl_init has already been called * \return RCL_RET_OK if initialization is successful, or
* RCL_RET_ALREADY_INIT if rcl_init has already been called, or
* RCL_RET_ERROR if an unspecified error occurs.
*/ */
rcl_ret_t rcl_ret_t
rcl_init(int argc, char ** argv); rcl_init(int argc, char ** argv, rcl_allocator_t allocator);
/// Signal global shutdown of rcl. /// Signal global shutdown of rcl.
/* This function does not have to be called on exit, but does have to be called /* This function does not have to be called on exit, but does have to be called