Skip to content

Commit d66ff3d

Browse files
committed
Fix rcl_action_goal_info_t documentation
Signed-off-by: Jacob Perron <[email protected]>
1 parent c6788e4 commit d66ff3d

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

rcl_action/include/rcl_action/action_server.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -356,11 +356,11 @@ rcl_action_send_goal_response(
356356
* rcl_ret_t ret = rcl_action_take_goal_request(&action_server, &goal_request);
357357
* // ... error handling
358358
* // If the goal is accepted, then tell the action server
359-
* // First, create and populate a goal info message (rcl type)
359+
* // First, create a goal info message
360360
* rcl_action_goal_info_t goal_info = rcl_action_get_zero_initialized_goal_info();
361-
* ret = rcl_action_goal_info_init(&goal_info, &action_server);
362-
* // ... error handling, and populate with goal ID and timestamp
363-
* ret = rcl_action_accept_new_goal(&action_server, &goal_info, NULL);
361+
* // ... populate goal_info.uuid (unique_identifier_msgs/UUID)
362+
* // ... populate goal_info.stamp (builtin_interfaces/Time)
363+
* rcl_action_goal_handle_t * goal_handle = rcl_action_accept_new_goal(&action_server, &goal_info);
364364
* // ... error_handling
365365
* // ... Populate goal response (client library type)
366366
* ret = rcl_action_send_goal_response(&action_server, &goal_response);

rcl_action/include/rcl_action/types.h

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,7 @@ typedef enum rcl_action_goal_event_t
104104
GOAL_EVENT_NUM_EVENTS
105105
} rcl_action_goal_event_t;
106106

107-
/// Return a rcl_action_goal_info_t with members set to `NULL`.
108-
/**
109-
* Should be called to get a null rcl_action_goal_info_t before passing to
110-
* rcl_action_goal_info_init().
111-
*/
107+
/// Return a rcl_action_goal_info_t with members set to zero values.
112108
RCL_ACTION_PUBLIC
113109
RCL_WARN_UNUSED
114110
rcl_action_goal_info_t

0 commit comments

Comments
 (0)