Clean up comments

Author: ryankurte

src/digital/v1_compat.rs

@@ -6,7 +6,7 @@
 use super::v1;
 use super::v2;
 
-/// Wrapper to allow v2 fallible OutputPin traits to be converted to v1 traits
+/// Wrapper to allow fallible `v2::OutputPin` traits to be converted to `v1::OutputPin` traits
 pub struct OldOutputPin<T> {
     pin: T,
 }
@@ -16,12 +16,12 @@ where
     T: v2::OutputPin<Error=E>,
     E: core::fmt::Debug,
 {
-    /// Create a new OldOutputPin wrapper around a v2::OutputPin
+    /// Create a new OldOutputPin wrapper around a `v2::OutputPin`
     pub fn new(pin: T) -> Self {
         Self{pin}
     }
 
-    /// Fetch a reference to the inner v2::OutputPin impl
+    /// Fetch a reference to the inner `v2::OutputPin` impl
     pub fn inner(&self) -> &T {
         &self.pin
     }
@@ -37,7 +37,7 @@ where
     }
 }
 
-/// Implementation of v1 OutputPin trait for v2 fallible output pins
+/// Implementation of `v1::OutputPin` trait for fallible `v2::OutputPin` output pins
 #[allow(deprecated)]
 impl <T, E> v1::OutputPin for OldOutputPin<T>
 where
@@ -71,7 +71,7 @@ where
     }
 }
 
-/// Wrapper to allow v2 fallible InputPin traits to be converted to v1 traits
+/// Wrapper to allow fallible `v2::InputPin` traits to be converted to `v1::InputPin` traits
 #[cfg(feature = "unproven")]
 pub struct OldInputPin<T> {
     pin: T,
@@ -88,7 +88,7 @@ where
         Self{pin}
     }
 
-    /// Fetch a reference to the inner v2::InputPin impl
+    /// Fetch a reference to the inner `v2::InputPin` impl
     pub fn inner(&self) -> &T {
         &self.pin
     }

src/digital/v2_compat.rs

@@ -5,7 +5,7 @@
 use super::v1;
 use super::v2;
 
-/// Implementation of v2 fallible OutputPin for v1 traits
+/// Implementation of fallible `v2::OutputPin` for `v1::OutputPin` traits
 #[allow(deprecated)]
 impl <T> v2::OutputPin for T 
 where
@@ -14,24 +14,22 @@ where
     // TODO: update to ! when never_type is stabilized
     type Error = ();
 
-    /// Toggle pin output
     fn set_low(&mut self) -> Result<(), Self::Error> {
         Ok(self.set_low())
     }
 
-     fn set_high(&mut self) -> Result<(), Self::Error> {
+    fn set_high(&mut self) -> Result<(), Self::Error> {
          Ok(self.set_high())
      }
 }
 
-/// Implementation of v2 fallible StatefulOutputPin for v1 digital traits
+/// Implementation of fallible `v2::StatefulOutputPin` for `v1::StatefulOutputPin` digital traits
 #[cfg(feature = "unproven")]
 #[allow(deprecated)]
 impl <T> v2::StatefulOutputPin for T
 where
     T: v1::StatefulOutputPin + v1::OutputPin,
 {
-    /// Toggle pin output
     fn is_set_low(&self) -> Result<bool, Self::Error> {
         Ok(self.is_set_low())
     }
@@ -41,6 +39,8 @@ where
      }
 }
 
+
+/// Implementation of fallible `v2::InputPin` for `v1::InputPin` digital traits
 #[cfg(feature = "unproven")]
 #[allow(deprecated)]
 impl <T> v2::InputPin for T
@@ -50,7 +50,6 @@ where
     // TODO: update to ! when never_type is stabilized
     type Error = ();
 
-    /// Toggle pin output
     fn is_low(&self) -> Result<bool, Self::Error> {
         Ok(self.is_low())
     }