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

Fixed doxygen warnings (#677) (#696)

Browse source 
Signed-off-by: ahcorde <ahcorde@gmail.com>
This commit is contained in:
Alejandro Hernández Cordero 2020-06-23 19:55:31 +02:00 • committed by GitHub
parent 1cff651c44
commit c70774659d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 18 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

4
rcl_action/include/rcl_action/action_client.h
View file

@ -548,7 +548,7 @@ rcl_action_send_result_request(
*
* \param[in] action_client handle to the client that will take the result response
* \param[out] response_header pointer to the result response header
* \param[out] ros_result_response preallocated, zero-initialized, struct where the ROS
* \param[out] ros_result preallocated, zero-initialized, struct where the ROS
* result message is copied.
* \return `RCL_RET_OK` if the response was taken successfully, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or
@ -639,7 +639,7 @@ rcl_action_send_cancel_request(
* Lock-Free | Yes
*
* \param[in] action_client handle to the client that will take the cancel response
* \param[out] request_header pointer to the cancel response header
* \param[out] response_header pointer to the cancel response header
* \param[out] ros_cancel_response a zero-initialized ROS cancel response message where
* the cancel response is copied.
* \return `RCL_RET_OK` if the response was taken successfully, or

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

@ -712,7 +712,7 @@ rcl_action_take_cancel_request(
*
* \param[in] action_server handle to the action server that will process the cancel request
* \param[in] cancel_request a C-typed ROS cancel request to process
* \param[out] cancel_reponse a zero-initialized cancel response struct
* \param[out] cancel_response a zero-initialized cancel response struct
* where the goal info of goals which should be cancelled are copied
* \return `RCL_RET_OK` if the response was sent successfully, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid, or

4
rcl_action/include/rcl_action/wait.h
View file

@ -208,10 +208,11 @@ rcl_action_server_wait_set_get_num_entities(
* Uses Atomics | No
* Lock-Free | Yes
*
* \param[in] wait_set struct where action server services are to be stored
* \param[in] action_client an action client to query
* \param[out] is_feedback_ready `true` if there is a feedback message ready to take,
* `false` otherwise
* \param[out] is_status_message `true` if there is a status message ready to take,
* \param[out] is_status_ready `true` if there is a status message ready to take,
* `false` otherwise
* \param[out] is_goal_response_ready `true` if there is a goal response message ready
* to take, `false` otherwise
@ -251,6 +252,7 @@ rcl_action_client_wait_set_get_entities_ready(
* Uses Atomics | No
* Lock-Free | Yes
*
* \param[in] wait_set struct where action server services are to be stored
* \param[in] action_server an action server to query
* \param[out] is_goal_request_ready `true` if there is a goal request message ready
* to take, `false` otherwise