@@ -33,12 +33,11 @@ class Time
3333public:
3434 // / Time constructor
3535 /* *
36- * Initializes the time values for seconds and nanoseconds individually.
37- * Large values for nanoseconds are wrapped automatically with the remainder added to seconds.
38- * Both inputs must be integers.
36+ * Indicates a specific point in time, relative to a clock's 0 point (its epoch).
37+ * The total time since the epoch is given by seconds + nanoseconds.
3938 *
40- * \param seconds part of the time in seconds since time epoch
41- * \param nanoseconds part of the time in nanoseconds since time epoch
39+ * \param seconds the seconds component, valid only if positive
40+ * \param nanoseconds the nanoseconds component, to be added to the seconds component
4241 * \param clock_type clock type
4342 * \throws std::runtime_error if seconds are negative
4443 */
@@ -47,7 +46,7 @@ class Time
4746
4847 // / Time constructor
4948 /* *
50- * \param nanoseconds since time epoch
49+ * \param nanoseconds the total time since the epoch in nanoseconds
5150 * \param clock_type clock type
5251 * \throws std::runtime_error if nanoseconds are negative
5352 */
@@ -190,7 +189,7 @@ class Time
190189
191190 // / Get the nanoseconds since epoch
192191 /* *
193- * \return the nanoseconds since epoch as a rcl_time_point_value_t structure.
192+ * \return the total time since the epoch in nanoseconds, as a rcl_time_point_value_t structure.
194193 */
195194 RCLCPP_PUBLIC
196195 rcl_time_point_value_t
@@ -209,7 +208,7 @@ class Time
209208 * \warning Depending on sizeof(double) there could be significant precision loss.
210209 * When an exact time is required use nanoseconds() instead.
211210 *
212- * \return the seconds since epoch as a floating point number.
211+ * \return the total time since the epoch in seconds, as a floating point number.
213212 */
214213 RCLCPP_PUBLIC
215214 double
0 commit comments