Fill in documentation

Signed-off-by: Michael X. Grey <[email protected]>

Author: mxgrey

rclrs/src/timer/timer_callback.rs

@@ -17,6 +17,7 @@ pub enum AnyTimerCallback {
 /// callbacks can take the current [`Time`] as an argument, or [`Time`], or take
 /// no argument at all.
 pub trait TimerCallRepeating<Args>: Send + 'static {
+    /// Convert a suitable object into a repeating timer callback
     fn into_repeating_timer_callback(self) -> AnyTimerCallback;
 }
 
@@ -42,6 +43,7 @@ where
 /// callbacks can take the current [`Time`] as an argument, or [`Time`], or take
 /// no argument at all.
 pub trait TimerCallOnce<Args>: Send + 'static {
+    /// Convert a suitable object into a one-shot timer callback
     fn into_oneshot_timer_callback(self) -> AnyTimerCallback;
 }
 

rclrs/src/timer/timer_options.rs

@@ -9,11 +9,15 @@ use crate::{Clock, Node};
 #[derive(Debug, Clone, Copy)]
 #[non_exhaustive]
 pub struct TimerOptions<'a> {
+    /// The period of the timer's interval
     pub period: Duration,
+    /// The clock that the timer will reference for its intervals
     pub clock: TimerClock<'a>,
 }
 
 impl TimerOptions<'_> {
+    /// Make a new timer with a certain interval period, with all other options
+    /// as default.
     pub fn new(period: Duration) -> Self {
         Self {
             period,
@@ -22,7 +26,10 @@ impl TimerOptions<'_> {
     }
 }
 
+/// Trait to implicitly convert a suitable object into [`TimerOptions`].
 pub trait IntoTimerOptions<'a>: Sized {
+    /// Convert a suitable object into [`TimerOptions`]. This can be used on
+    /// [`Duration`] or [`TimerOptions`] itself.
     fn into_timer_options(self) -> TimerOptions<'a>;
 
     /// Use [`std::time::Instant`] for the timer. This the default so you