Add public function documentation

circuitry-maker · Mar 10, 2023 · ff87cbe · ff87cbe
1 parent 05b74ba
commit ff87cbe
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -81,6 +81,7 @@ where
         Ok(chip)
     }
 
+    /// Initiates hardware with basic setup.
     pub fn init_hardware(&mut self) -> Result<(), Error<E>> {
         // set all inputs to defaults on port A and B
         self.write_register(Register::IODIRA, 0xff)?;