Skip to content

Commit

Permalink
documentation fixups
Browse files Browse the repository at this point in the history
  • Loading branch information
wjwwood authored and Karsten1987 committed Jun 13, 2018
1 parent 19bf36c commit 619a3de
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions rcl/include/rcl/subscription.h
Original file line number Diff line number Diff line change
Expand Up @@ -256,20 +256,20 @@ rcl_take(
void * ros_message,
rmw_message_info_t * message_info);

/// Take a serialized raw message from a topic using a rcl subscription.
/// Take a serialized raw message from a topic using a rcl subscription.
/**
* In contrast to `rcl_take`, this function return the incoming message in
* its binary raw representation.
* It is the job of the caller to ensure that the type associate with the subscription,
* match and can optionally be deserialized into its ROS message via the correct
* In contrast to `rcl_take`, this function stores the taken message in
* its raw binary representation.
* It is the job of the caller to ensure that the type associate with the subscription
* matches, and can optionally be deserialized into its ROS message via, the correct
* type support.
* If the `raw_message` parameter contains enough preallocated memory, the incoming
* message can be taken without any additional memory allocation.
* If not, the function will dynamically allocate enough memory for the message.
* Passing a different type to rcl_take produces undefined behavior and cannot
* be checked by this function and therefore no deliberate error will occur.
*
* Apart from the contrast above, this function behaves like `rcl_take`.
* Apart from the differences above, this function behaves like `rcl_take`.
*
* <hr>
* Attribute | Adherence
Expand All @@ -278,7 +278,7 @@ rcl_take(
* Thread-Safe | No
* Uses Atomics | No
* Lock-Free | Yes
* <i>[1] only if required when filling the message, avoided for fixed sizes</i>
* <i>[1] only if storage in the raw_message is insufficient</i>
*
* \param[in] subscription the handle to the subscription from which to take
* \param[inout] raw_message pointer to a (pre-allocated) raw message.
Expand Down

0 comments on commit 619a3de

Please sign in to comment.