From 46aff07f812cc307ec5ae898fc2387864f19c650 Mon Sep 17 00:00:00 2001 From: Diego Barrios Romero Date: Wed, 31 Oct 2018 11:07:15 +0100 Subject: [PATCH] Improve documentation of default state --- src/ds3232.rs | 2 +- src/ds3234.rs | 2 +- src/ds323x/configuration.rs | 6 +++--- src/lib.rs | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/ds3232.rs b/src/ds3232.rs index f7ea383..c6fce97 100644 --- a/src/ds3232.rs +++ b/src/ds3232.rs @@ -29,7 +29,7 @@ where self.iface.i2c } - /// Enable the 32kHz output when battery-powered. + /// Enable the 32kHz output when battery-powered. (enabled per default) /// /// Additionally, the 32kHz output needs to be enabled. See /// [`enable_32khz_output`](#method.enable_32khz_output). diff --git a/src/ds3234.rs b/src/ds3234.rs index b7fbd6e..393c668 100644 --- a/src/ds3234.rs +++ b/src/ds3234.rs @@ -30,7 +30,7 @@ where (self.iface.spi, self.iface.cs) } - /// Enable the 32kHz output when battery-powered. + /// Enable the 32kHz output when battery-powered. (enabled per default) /// /// Additionally, the 32kHz output needs to be enabled. See /// [`enable_32khz_output`](#method.enable_32khz_output). diff --git a/src/ds323x/configuration.rs b/src/ds323x/configuration.rs index 2a8f1a8..277da6e 100644 --- a/src/ds323x/configuration.rs +++ b/src/ds323x/configuration.rs @@ -8,7 +8,7 @@ impl Ds323x where DI: ReadData + WriteData { - /// Enable the oscillator (set the clock running). + /// Enable the oscillator (set the clock running) (default). pub fn enable(&mut self) -> Result<(), Error> { let control = self.control; self.write_control(control & !BitFlags::EOSC) @@ -32,7 +32,7 @@ where Ok(()) } - /// Enable the 32kHz output. + /// Enable the 32kHz output. (enabled per default) pub fn enable_32khz_output(&mut self) -> Result<(), Error> { let status = self.status | BitFlags::EN32KHZ; self.write_status_without_clearing_alarm(status) @@ -61,7 +61,7 @@ where self.write_control(control | BitFlags::INTCN) } - /// Set the interrupt/square-wave output to be used as square-wave output. + /// Set the interrupt/square-wave output to be used as square-wave output. (default) pub fn use_int_sqw_output_as_square_wave(&mut self) -> Result<(), Error> { let control = self.control; self.write_control(control & !BitFlags::INTCN) diff --git a/src/lib.rs b/src/lib.rs index 6793494..221bd09 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -399,7 +399,7 @@ pub enum Error { /// Square-wave output frequency #[derive(Debug, Clone, PartialEq)] pub enum SqWFreq { - /// 1 Hz + /// 1 Hz (default) _1Hz, /// 1.024 Hz _1_024Hz, @@ -414,7 +414,7 @@ pub enum SqWFreq { /// This is only available on the DS3232 and DS3234 devices. #[derive(Debug, Clone, PartialEq)] pub enum TempConvRate { - /// Once every 64 seconds + /// Once every 64 seconds (default) _64s, /// Once every 128 seconds _128s,