Skip to content

Commit

Permalink
Fix rcl_action_goal_info_t documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Jacob Perron <jacob@openrobotics.org>
  • Loading branch information
jacobperron committed Feb 4, 2019
1 parent c6788e4 commit d66ff3d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
8 changes: 4 additions & 4 deletions rcl_action/include/rcl_action/action_server.h
Original file line number Diff line number Diff line change
Expand Up @@ -356,11 +356,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);
Expand Down
6 changes: 1 addition & 5 deletions rcl_action/include/rcl_action/types.h
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,7 @@ typedef enum rcl_action_goal_event_t
GOAL_EVENT_NUM_EVENTS
} rcl_action_goal_event_t;

/// Return a rcl_action_goal_info_t with members set to `NULL`.
/**
* Should be called to get a null rcl_action_goal_info_t before passing to
* rcl_action_goal_info_init().
*/
/// Return a rcl_action_goal_info_t with members set to zero values.
RCL_ACTION_PUBLIC
RCL_WARN_UNUSED
rcl_action_goal_info_t
Expand Down

0 comments on commit d66ff3d

Please sign in to comment.