From 2c7807265ccacdba4479d46499348e8e6b88c849 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Gro=C3=9F?= Date: Mon, 23 Jul 2018 10:41:28 +0200 Subject: [PATCH] -fixed a doc test error in the interface file even though it's unknown why that was even recognized as a doc test - fixed a few documentation links and warnings --- src/epd4in2/command.rs | 2 +- src/epd4in2/mod.rs | 3 ++- src/interface/connection_interface.rs | 5 +++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/epd4in2/command.rs b/src/epd4in2/command.rs index a73e43e..e22787c 100644 --- a/src/epd4in2/command.rs +++ b/src/epd4in2/command.rs @@ -97,7 +97,7 @@ pub enum Command { LOW_POWER_DETECTION = 0x51, /// This command defines non-overlap period of Gate and Source. TCON_SETTING = 0x60, - /// This command defines alternative resolution and this setting is of higher priority than the RES[1:0] in R00H (PSR). + /// This command defines alternative resolution and this setting is of higher priority than the RES\[1:0\] in R00H (PSR). RESOLUTION_SETTING = 0x61, /// This command defines the Fist Active Gate and First Active Source of active channels. GSST_SETTING = 0x65, diff --git a/src/epd4in2/mod.rs b/src/epd4in2/mod.rs index 5bd1d5e..94f6e49 100644 --- a/src/epd4in2/mod.rs +++ b/src/epd4in2/mod.rs @@ -105,7 +105,7 @@ where /// Creates a new driver from a SPI peripheral, CS Pin, Busy InputPin, DC /// - /// This already initialises the device. That means [EPD4in2::init()](EPD4in2::init()) isn't needed directly afterwards + /// This already initialises the device. That means [init()](init()) isn't needed directly afterwards /// /// # Example /// @@ -136,6 +136,7 @@ where Ok(epd) } + /// blablabla fn init(&mut self) -> Result<(), E> { // reset the device self.reset(); diff --git a/src/interface/connection_interface.rs b/src/interface/connection_interface.rs index 7781685..8d47708 100644 --- a/src/interface/connection_interface.rs +++ b/src/interface/connection_interface.rs @@ -128,9 +128,10 @@ where /// if the device is still busy /// /// is_busy_low - /// - TRUE for epd4in2, epd1in54, epd2in13, epd2in7, epd5in83, epd7in5 /// - /// - FALSE for epd2in9 + /// - TRUE for epd4in2, epd1in54, epd2in13, epd2in7, epd5in83, epd7in5 + /// - FALSE for epd2in9 + /// /// Most likely there was a mistake with the 2in9 busy connection pub(crate) fn wait_until_idle(&mut self, is_busy_low: bool) { self.delay_ms(1);