From 58d3d4575cbe5639b845a0b95fbe9e6d3f6b7729 Mon Sep 17 00:00:00 2001 From: Cyril Fougeray Date: Fri, 2 Aug 2024 17:37:27 +0200 Subject: [PATCH] docs for button.rs Co-authored-by: Ryan Butler --- orb-ui/cone/src/button.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/orb-ui/cone/src/button.rs b/orb-ui/cone/src/button.rs index 65a57ebf..c3cdd4e7 100644 --- 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};