Skip to content

Commit 4ad66d1

Browse files
committed
fix typos and errors in comments
Signed-off-by: Alberto Soragna <[email protected]>
1 parent d2dab49 commit 4ad66d1

File tree

5 files changed

+10
-23
lines changed

5 files changed

+10
-23
lines changed

rclcpp/include/rclcpp/client.hpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,6 @@ class ClientBase
173173
* If you want more information available in the callback, like the client
174174
* or other information, you may use a lambda with captures or std::bind.
175175
*
176-
* \sa rclcpp::ClientBase::clear_on_new_response_callback
177176
* \sa rmw_client_set_on_new_response_callback
178177
* \sa rcl_client_set_on_new_response_callback
179178
*

rclcpp/include/rclcpp/experimental/subscription_intra_process_base.hpp

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,11 @@ class SubscriptionIntraProcessBase : public rclcpp::Waitable
7979
rmw_qos_profile_t
8080
get_actual_qos() const;
8181

82-
/// Set a callback to be called when each new event instance occurs.
82+
/// Set a callback to be called when each new message arrives.
8383
/**
84-
* The callback receives a size_t which is the number of responses received
84+
* The callback receives a size_t which is the number of messages received
8585
* since the last time this callback was called.
86-
* Normally this is 1, but can be > 1 if responses were received before any
86+
* Normally this is 1, but can be > 1 if messages were received before any
8787
* callback was set.
8888
*
8989
* The callback also receives an int identifier argument.
@@ -92,7 +92,7 @@ class SubscriptionIntraProcessBase : public rclcpp::Waitable
9292
* The application should provide a generic callback function that will be then
9393
* forwarded by the waitable to all of its entities.
9494
* Before forwarding, a different value for the identifier argument will be
95-
* bounded to the function.
95+
* bond to the function.
9696
* This implies that the provided callback can use the identifier to behave
9797
* differently depending on which entity triggered the waitable to become ready.
9898
*
@@ -102,14 +102,9 @@ class SubscriptionIntraProcessBase : public rclcpp::Waitable
102102
*
103103
* This function is thread-safe.
104104
*
105-
* If you want more information available in the callback, like the client
105+
* If you want more information available in the callback, like the subscription
106106
* or other information, you may use a lambda with captures or std::bind.
107107
*
108-
* Note: this function must be overridden with a proper implementation
109-
* by the custom classes who inherit from rclcpp::Waitable if they want to use it.
110-
*
111-
* \sa rclcpp::SubscriptionIntraProcessBase::clear_on_ready_callback
112-
*
113108
* \param[in] callback functor to be called when a new message is received.
114109
*/
115110
void

rclcpp/include/rclcpp/qos_event.hpp

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,9 @@ class QOSEventHandlerBase : public Waitable
113113

114114
/// Set a callback to be called when each new event instance occurs.
115115
/**
116-
* The callback receives a size_t which is the number of responses received
116+
* The callback receives a size_t which is the number of events that occurred
117117
* since the last time this callback was called.
118-
* Normally this is 1, but can be > 1 if responses were received before any
118+
* Normally this is 1, but can be > 1 if events occurred before any
119119
* callback was set.
120120
*
121121
* The callback also receives an int identifier argument.
@@ -124,7 +124,7 @@ class QOSEventHandlerBase : public Waitable
124124
* The application should provide a generic callback function that will be then
125125
* forwarded by the waitable to all of its entities.
126126
* Before forwarding, a different value for the identifier argument will be
127-
* bounded to the function.
127+
* bond to the function.
128128
* This implies that the provided callback can use the identifier to behave
129129
* differently depending on which entity triggered the waitable to become ready.
130130
*
@@ -139,13 +139,9 @@ class QOSEventHandlerBase : public Waitable
139139
*
140140
* This function is thread-safe.
141141
*
142-
* If you want more information available in the callback, like the client
142+
* If you want more information available in the callback, like the qos event
143143
* or other information, you may use a lambda with captures or std::bind.
144144
*
145-
* Note: this function must be overridden with a proper implementation
146-
* by the custom classes who inherit from rclcpp::Waitable if they want to use it.
147-
*
148-
* \sa rclcpp::QOSEventHandlerBase::clear_on_ready_callback
149145
* \sa rmw_event_set_callback
150146
* \sa rcl_event_set_callback
151147
*

rclcpp/include/rclcpp/service.hpp

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,13 +148,11 @@ class ServiceBase
148148
* If you want more information available in the callback, like the service
149149
* or other information, you may use a lambda with captures or std::bind.
150150
*
151-
* \sa rclcpp::ServiceBase::clear_on_new_request_callback
152151
* \sa rmw_service_set_on_new_request_callback
153152
* \sa rcl_service_set_on_new_request_callback
154153
*
155154
* \param[in] callback functor to be called when a new request is received
156155
*/
157-
RCLCPP_PUBLIC
158156
void
159157
set_on_new_request_callback(std::function<void(size_t)> callback)
160158
{
@@ -203,7 +201,6 @@ class ServiceBase
203201
}
204202

205203
/// Unset the callback registered for new requests, if any.
206-
RCLCPP_PUBLIC
207204
void
208205
clear_on_new_request_callback()
209206
{

rclcpp/include/rclcpp/waitable.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ class Waitable
217217
* The application should provide a generic callback function that will be then
218218
* forwarded by the waitable to all of its entities.
219219
* Before forwarding, a different value for the identifier argument will be
220-
* bounded to the function.
220+
* bond to the function.
221221
* This implies that the provided callback can use the identifier to behave
222222
* differently depending on which entity triggered the waitable to become ready.
223223
*

0 commit comments

Comments
 (0)