docs for button.rs

Co-authored-by: Ryan Butler <[email protected]>
worldcoin · Aug 2, 2024 · 58d3d45 · 58d3d45
1 parent e48994c
commit 58d3d45
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/orb-ui/cone/src/button.rs b/orb-ui/cone/src/button.rs
@@ -1,3 +1,9 @@
+//! Controls the button of the cone.
+//!
+//! For more information about libftd2xx, see the [programmers guide][guide].
+//!
+//! [guide]: https://ftdichip.com/wp-content/uploads/2023/09/D2XX_Programmers_Guide.pdf
+
 use crate::{ConeEvents, Status};
 use color_eyre::eyre;
 use ftdi_embedded_hal::libftd2xx::{BitMode, Ft4232h, Ftdi, FtdiCommon};