From d45503839ef8db33395130e0fb27222f43602251 Mon Sep 17 00:00:00 2001 From: Miaofei Mei Date: Thu, 19 Mar 2020 13:15:59 -0700 Subject: [PATCH] update docstring with new possible return code (#600) Signed-off-by: Miaofei --- rcl/include/rcl/event.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rcl/include/rcl/event.h b/rcl/include/rcl/event.h index 51b3055..2d048ac 100644 --- a/rcl/include/rcl/event.h +++ b/rcl/include/rcl/event.h @@ -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