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

[rcl_action] Correct action server documentation (#519)

Browse source 
rcl_action_process_cancel_request() will never return RCL_RET_ACTION_SERVER_TAKE_FAILED.

Signed-off-by: Jacob Perron <jacob@openrobotics.org>
This commit is contained in:
Jacob Perron 2019-10-11 13:51:29 -07:00 • committed by GitHub
parent d9e4c2e4e9
commit b7610d9392
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
rcl_action/include/rcl_action/action_server.h
View file

@ -718,8 +718,6 @@ rcl_action_take_cancel_request(
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or * \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or
* \return `RCL_RET_ACTION_SERVER_INVALID` if the action server is invalid, or * \return `RCL_RET_ACTION_SERVER_INVALID` if the action server is invalid, or
* \return `RCL_RET_BAD_ALLOC` if allocating memory failed, or * \return `RCL_RET_BAD_ALLOC` if allocating memory failed, or
* \return `RCL_RET_ACTION_SERVER_TAKE_FAILED` if take failed but no error occurred
* in the middleware, or
* \return `RCL_RET_ERROR` if an unspecified error occurs. * \return `RCL_RET_ERROR` if an unspecified error occurs.
*/ */
RCL_ACTION_PUBLIC RCL_ACTION_PUBLIC