Skip to content

Commit

Permalink
Document rcl_take_response() populates the header
Browse files Browse the repository at this point in the history
  • Loading branch information
sloretz committed Jan 5, 2018
1 parent 1612845 commit d052e5e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion rcl/include/rcl/client.h
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,8 @@ rcl_send_request(const rcl_client_t * client, const void * ros_request, int64_t
* cannot be checked by this function and therefore no deliberate error will
* occur.
* The request_header is an rmw struct for meta-information about the request
* sent (e.g. the sequence number).
* sent (e.g. the sequence number). The caller must provide a pointer to an
* allocated struct. This function will populate the struct's fields.
* `ros_response` should point to an already allocated ROS response message
* struct of the correct type, into which the response from the service will be
* copied.
Expand Down

0 comments on commit d052e5e

Please sign in to comment.