Fix docs

Author: Johannes Draaijer

src/lib.rs

@@ -1,6 +1,6 @@
 //! An abstraction layer for ethernet periperhals embedded in STM32 processors.
 //!
-//! For initialisation, see [`new`], and [`new_with_smi_pins`]
+//! For initialisation, see [`new`], and [`new_with_smi`]
 #![no_std]
 
 use mac::EthernetMACWithSmi;
@@ -135,7 +135,7 @@ where
 /// This method does not initialise the external PHY.
 ///
 /// The SMI for the external PHY can be accessed through the
-/// returned [`EthernetMAC<OwnedSmi>`], which implements [`mac::StationManagement`].
+/// returned [`EthernetMACWithSmi`], which implements [`mac::StationManagement`].
 ///
 /// # Note
 /// - Make sure that the buffers reside in a memory region that is

src/mac/mod.rs

@@ -41,16 +41,16 @@ impl EthernetMAC {
     {
         EthernetMACWithSmi {
             eth_mac: self.eth_mac,
-            mdio: mdio,
-            mdc: mdc,
+            mdio,
+            mdc,
         }
     }
 }
 
-/// Ethernet media access control (MAC)
+/// Ethernet media access control (MAC) with owned SMI
 ///
-/// This version of the struct owns it's Station Management Interface
-/// pins, allowing it to be used [`StationManagement`] directly.
+/// This version of the struct owns it's SMI pins,
+/// allowing it to be used [`StationManagement`] directly.
 pub struct EthernetMACWithSmi<MDIO, MDC>
 where
     MDIO: MdioPin,
@@ -71,11 +71,7 @@ where
     /// To interact with a connected Phy, use this struct's impl of
     /// [`StationManagement`]
     pub fn new(eth_mac: ETHERNET_MAC, mdio: MDIO, mdc: MDC) -> Self {
-        Self {
-            eth_mac,
-            mdio: mdio,
-            mdc: mdc,
-        }
+        Self { eth_mac, mdio, mdc }
     }
 
     /// Release the owned MDIO and MDC pins, and return an EthernetMAC that

src/mac/smi.rs

@@ -5,8 +5,12 @@ pub unsafe trait MdioPin {}
 /// MDC pin types.
 pub unsafe trait MdcPin {}
 
+/// A trait used for implementing access to SMI
+/// peripherals/functionality
 pub trait StationManagement {
+    /// Read an SMI register
     fn read(&self, phy: u8, reg: u8) -> u16;
+    /// Write an SMI register
     fn write(&mut self, phy: u8, reg: u8, data: u16);
 }
 
@@ -52,9 +56,10 @@ pub(crate) fn smi_read(iar: &MACMIIAR, dr: &MACMIIDR, phy: u8, reg: u8) -> u16 {
     dr.read().md().bits()
 }
 
-/// Station Management Interface with pins and registers borrowed from [`EthernetMAC`].
+/// Station Management Interface
 ///
-/// Can also be constructed by borrowing from [`ETHERNET_MAC`] and borrowing the pins manually.
+/// Borrows [`MACMIIAR`] and [`MACMIIDR`] from (ETHERNET_MAC)[`crate::stm32::ETHERNET_MAC`], and holds a mutable borrow
+/// to the SMI pins.
 ///
 /// Provides access to the MIIM implementation exposed by the MCU's MAC API.
 pub struct Smi<'eth, 'pins, Mdio, Mdc> {
@@ -69,12 +74,10 @@ where
     Mdio: MdioPin,
     Mdc: MdcPin,
 {
-    /// Read an SMI register
     fn read(&self, phy: u8, reg: u8) -> u16 {
         smi_read(&self.macmiiar, &self.macmiidr, phy, reg)
     }
 
-    /// Write an SMI register
     fn write(&mut self, phy: u8, reg: u8, data: u16) {
         smi_write(&self.macmiiar, &self.macmiidr, phy, reg, data)
     }
@@ -85,7 +88,7 @@ where
     Mdio: MdioPin,
     Mdc: MdcPin,
 {
-    /// Create the temporary `Smi` instance.
+    /// Create a temporary `Smi` instance.
     ///
     /// Temporarily take exclusive access to the MDIO and MDC pins to ensure they are not used
     /// elsewhere for the duration of SMI communication.
@@ -102,11 +105,6 @@ where
             _mdc,
         }
     }
-
-    /// Read an SMI register
-    pub fn read(&self, phy: u8, reg: u8) -> u16 {
-        smi_read(&self.macmiiar, &self.macmiidr, phy, reg)
-    }
 }
 
 #[cfg(feature = "stm32f4xx-hal")]