small doc touchup (#400)

This commit is contained in:
William Woodall 2017-11-17 16:06:06 -08:00 committed by GitHub
parent e08428c79b
commit eed5999221
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -31,8 +31,9 @@ namespace rclcpp
class TimeSource; class TimeSource;
/* \brief A struct to represent a timejump. /// A struct to represent a timejump.
* It epresents the time jump duration and whether it changed clock type. /**
* It represents the time jump duration and whether it changed clock type.
*/ */
struct TimeJump struct TimeJump
{ {
@ -48,9 +49,10 @@ struct TimeJump
rcl_duration_t delta_; ///< The change in time value. rcl_duration_t delta_; ///< The change in time value.
}; };
/* \brief A class to store a threshold for a TimeJump /// A class to store a threshold for a TimeJump.
/**
* This class can be used to evaluate a time jump's magnitude. * This class can be used to evaluate a time jump's magnitude.
*/ */
class JumpThreshold class JumpThreshold
{ {
public: public: