@@ -210,7 +210,6 @@ class PublisherBase : public std::enable_shared_from_this<PublisherBase>
210
210
* This function waits until all published message data were acknowledged by all subscribers or
211
211
* timeout.
212
212
*
213
- * timeout must be less than std::chrono::nanoseconds::max().
214
213
* If the timeout is negative then this function will block indefinitely until all published
215
214
* message data were acknowledged.
216
215
* If the timeout is 0 then this function will be non-blocking; checking all published message
@@ -219,14 +218,15 @@ class PublisherBase : public std::enable_shared_from_this<PublisherBase>
219
218
* If the timeout is greater than 0 then this function will return after that period of time has
220
219
* elapsed (return false) or all published message data were acknowledged (return true).
221
220
*
222
- * This function only waits for acknowledgments if the publisher's QOS profile is RELIABLE.
221
+ * This function only waits for acknowledgments if the publisher's QoS profile is RELIABLE.
223
222
* Otherwise this function will immediately return `true`.
224
223
*
225
- * \param[in] timeout the duration to wait for all published message data were acknowledged.
226
- * \return `true` if all published message data were acknowledged before timeout, otherwise
227
- * `false`.
224
+ * \param[in] timeout the duration to wait for all published message data to be acknowledged.
225
+ * \return `true` if all published message data were acknowledged before the given timeout
226
+ * elapsed, otherwise `false`.
228
227
* \throws rclcpp::exceptions::RCLError if middleware doesn't support or internal error occurs
229
- * \throws std::invalid_argument if timeout is greater than nanoseconds::max()
228
+ * \throws std::invalid_argument if timeout is greater than std::chrono::nanoseconds::max() or
229
+ * less than std::chrono::nanoseconds::min()
230
230
*/
231
231
template <typename DurationRepT = int64_t , typename DurationT = std::milli>
232
232
bool
0 commit comments