Skip to content

Commit e854bb2

Browse files
fujitatomoyaclalancettechristophebedard
authored
a couple of typo fixes in doc section for LoanedMessage. (#2676)
* rephrase doc section of LoanedMessage Class. Signed-off-by: Tomoya Fujita <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> Co-authored-by: Christophe Bedard <[email protected]>
1 parent 88ebea9 commit e854bb2

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

rclcpp/include/rclcpp/loaned_message.hpp

+6-7
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,19 @@ class LoanedMessage
4040
* The constructor of this class allocates memory for a given message type
4141
* and associates this with a given publisher.
4242
*
43-
* Given the publisher instance, a case differentiation is being performaned
44-
* which decides whether the underlying middleware is able to allocate the appropriate
45-
* memory for this message type or not.
46-
* In the case that the middleware can not loan messages, the passed in allocator instance
47-
* is being used to allocate the message within the scope of this class.
48-
* Otherwise, the allocator is being ignored and the allocation is solely performaned
43+
* The underlying middleware is queried to determine whether it is able to allocate the
44+
* appropriate memory for this message type or not.
45+
* In the case that the middleware cannot loan messages, the passed in allocator instance
46+
* is used to allocate the message within the scope of this class.
47+
* Otherwise, the allocator is ignored and the allocation is solely performed
4948
* in the underlying middleware with its appropriate allocation strategy.
5049
* The need for this arises as the user code can be written explicitly targeting a middleware
5150
* capable of loaning messages.
5251
* However, this user code is ought to be usable even when dynamically linked against
5352
* a middleware which doesn't support message loaning in which case the allocator will be used.
5453
*
5554
* \param[in] pub rclcpp::Publisher instance to which the memory belongs
56-
* \param[in] allocator Allocator instance in case middleware can not allocate messages
55+
* \param[in] allocator Allocator instance in case middleware cannot allocate messages
5756
* \throws anything rclcpp::exceptions::throw_from_rcl_error can throw.
5857
*/
5958
LoanedMessage(

0 commit comments

Comments
 (0)