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

update docstring with new possible return code (#600)

Browse source 
Signed-off-by: Miaofei <miaofei@amazon.com>
This commit is contained in:
Miaofei Mei 2020-03-19 13:15:59 -07:00 • committed by GitHub
parent 43a4e65514
commit d45503839e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
rcl/include/rcl/event.h
View file

@ -70,6 +70,7 @@ rcl_get_zero_initialized_event(void);
* \param[in] event_type to listen for
* \return `RCL_RET_OK` if the rcl_event_t is filled, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_UNSUPPORTED` if event_type is not supported, or
* \return `RCL_RET_ERROR` if an unspecified error occurs.
*/
RCL_PUBLIC
@ -89,6 +90,7 @@ rcl_publisher_event_init(
* \param[in] event_type to listen for
* \return `RCL_RET_OK` if the rcl_event_t is filled, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_UNSUPPORTED` if event_type is not supported, or
* \return `RCL_RET_ERROR` if an unspecified error occurs.
*/
RCL_PUBLIC