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

Fix rcl_action documentation (#380)

Browse source 
* Fix rcl_action_goal_info_t documentation

* Fix rcl_action_expire_goals documentation

* Fix information about thread safety

Signed-off-by: Jacob Perron <jacob@openrobotics.org>
This commit is contained in:
Jacob Perron 2019-02-12 09:31:19 -08:00 • committed by GitHub
parent 4c9be76b92
commit 5ec52d004b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -354,11 +354,11 @@ rcl_action_send_goal_response(
* rcl_ret_t ret = rcl_action_take_goal_request(&action_server, &goal_request);
* // ... error handling
* // If the goal is accepted, then tell the action server
* // First, create and populate a goal info message (rcl type)
* // First, create a goal info message
* rcl_action_goal_info_t goal_info = rcl_action_get_zero_initialized_goal_info();
* ret = rcl_action_goal_info_init(&goal_info, &action_server);
* // ... error handling, and populate with goal ID and timestamp
* ret = rcl_action_accept_new_goal(&action_server, &goal_info, NULL);
* // ... populate goal_info.uuid (unique_identifier_msgs/UUID)
* // ... populate goal_info.stamp (builtin_interfaces/Time)
* rcl_action_goal_handle_t * goal_handle = rcl_action_accept_new_goal(&action_server, &goal_info);
* // ... error_handling
* // ... Populate goal response (client library type)
* ret = rcl_action_send_goal_response(&action_server, &goal_response);
@ -370,7 +370,7 @@ rcl_action_send_goal_response(
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | Yes
* Thread-Safe | Yes
* Thread-Safe | No
* Uses Atomics | No
* Lock-Free | Yes
*
@ -602,7 +602,6 @@ rcl_action_send_result_response(
*
* \param[in] action_server handle to the action server from which expired goals
* will be cleared.
* \param[in] expired_goals_allocator allocator to use to allocate expired_goals output
* \param[inout] expired_goals the identifiers of goals that expired, or set to `NULL` if unused
* \param[inout] expired_goals_capacity the allocated size of `expired_goals`, or 0 if unused
* \param[out] num_expired the number of expired goals, or set to `NULL` if unused