doc string fixes

src/hardware/adc.rs

@@ -197,7 +197,7 @@ impl Adc {
         Ok(adc)
     }
 
-    /// Setup all ADCs to the specifies [config].
+    /// Setup all ADCs to the specifies [AdcConfig].
     fn setup(&mut self, delay: &mut impl DelayUs<u16>, config: AdcConfig) -> Result<(), Error> {
         // deassert all CS first
         for pin in self.cs.iter_mut() {

src/hardware/dac.rs

@@ -7,8 +7,8 @@
 //!
 //! The 4 channel DAC ICs share an SPI bus and are addressed using individual "sync"
 //! signals, similar to a chip select signal.
-//! DAC datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/AD5680.pdf
-//! TEC driver datasheet: https://datasheets.maximintegrated.com/en/ds/MAX1968-MAX1969.pdf
+//! DAC datasheet: `<https://www.analog.com/media/en/technical-documentation/data-sheets/AD5680.pdf>`
+//! TEC driver datasheet: `<https://datasheets.maximintegrated.com/en/ds/MAX1968-MAX1969.pdf>`
 //!
 
 use super::hal::{
@@ -71,8 +71,8 @@ impl From<DacCode> for u32 {
 
 /// DAC gpio pins.
 ///
-/// sync[<n>] - DAC IC adressing signals
-/// * <n> specifies Thermostat output channel
+/// `sync[n]` - DAC IC adressing signals
+///   where `n` specifies Thermostat output channel
 pub struct DacPins {
     pub sync: [gpio::ErasedPin<gpio::Output>; 4],
 }

src/hardware/pwm.rs

@@ -36,10 +36,10 @@ pub enum Error {
 
 /// Pwm pins.
 ///
-/// voltage<n> - voltage limit pin
-/// positive_current<n> - positive current limit pin
-/// negative_current<n> - negative current limit pin
-/// * <n> specifies Thermostat output channel
+/// `voltage.<n>` - voltage limit pin
+/// `positive_current.<n>` - positive current limit pin
+/// `negative_current.<n>` - negative current limit pin
+/// * `<n>` specifies Thermostat output channel
 #[allow(clippy::type_complexity)]
 pub struct PwmPins {
     pub voltage: (

src/main.rs

@@ -48,7 +48,7 @@ pub struct Settings {
     ///
     /// # Path
     /// `output_channel/<n>`
-    /// * <n> specifies which channel to configure. <n> := [0, 1, 2, 3]
+    /// * `<n> := [0, 1, 2, 3]` specifies which channel to configure.
     ///
     /// # Value
     /// See [output_channel::OutputChannel]
@@ -62,7 +62,7 @@ pub struct Settings {
     ///
     /// # Value
     /// See [Alarm]
-    #[tree(depth(5))]
+    #[tree(depth(3))]
     alarm: Alarm,
 }
 
@@ -89,7 +89,7 @@ pub struct Monitor {
     output_current: [f32; 4],
     /// Measurement of the output voltages.
     output_voltage: [f32; 4],
-    /// See [PoEPower]
+    /// See [PoePower]
     poe: PoePower,
     /// Overtemperature status.
     overtemp: bool,
@@ -100,9 +100,9 @@ pub struct Monitor {
 pub struct Telemetry {
     /// see [Monitor]
     monitor: Monitor,
-    /// [<adc>][<channel>] array of [Statistics]. 'None' for disabled channels.
+    /// `[<adc>][<channel>]` array of [Statistics]. `None` for disabled channels.
     statistics: [[Option<Statistics>; 4]; 4],
-    /// Alarm status for each enabled input channel. 'None' for disabled channels.
+    /// Alarm status for each enabled input channel. `None` for disabled channels.
     alarm: [[Option<bool>; 4]; 4],
     /// Output current in Amperes for each Thermostat output channel.
     output_current: [f32; 4],
@@ -117,7 +117,7 @@ mod app {
 
     #[shared]
     struct Shared {
-        network: NetworkUsers<Settings, Telemetry, 6>,
+        network: NetworkUsers<Settings, Telemetry, 5>,
         settings: Settings,
         telemetry: Telemetry,
         gpio: Gpio,

src/net/mod.rs

@@ -205,18 +205,18 @@ pub fn get_device_prefix(app: &str, id: &str) -> String<128> {
 }
 
 /// Miniconf settings for the MQTT alarm.
-/// The alarm simply publishes "false" onto its [target] as long as all the channels are
-/// within their [temperature_limits] (aka logical OR of all channels).
+/// The alarm simply publishes "false" onto its `target` as long as all the channels are
+/// within their `temperature_limits`` (aka logical OR of all channels).
 /// Otherwise it publishes "true" (aka true, there is an alarm).
 ///
-/// The publishing interval is given by [period_ms].
+/// The publishing interval is given by `period_ms`.
 ///
 /// The alarm is non-latching. If alarm was "true" for a while and the temperatures come within
 /// limits again, alarm will be "false" again.
 #[derive(Clone, Debug, Tree)]
 pub struct Alarm {
     /// Set the alarm to armed (true) or disarmed (false).
-    /// If the alarm is armed, the device will publish it's alarm state onto the [target].
+    /// If the alarm is armed, the device will publish it's alarm state onto the `target`.
     ///
     /// # Value
     /// True to arm, false to disarm.
@@ -245,12 +245,12 @@ pub struct Alarm {
     ///
     /// # Path
     /// `temperature_limits/<adc>/<channel>`
-    /// * <adc> specifies which adc to configure. <adc> := [0, 1, 2, 3]
-    /// * <channel> specifies which channel of an ADC to configure. Only the enabled channels for the specific ADC are available.
+    /// * `<adc> := [0, 1, 2, 3]` specifies which adc to configure.
+    /// * `<channel>` specifies which channel of an ADC to configure. Only the enabled channels for the specific ADC are available.
     ///
     /// # Value
-    /// [f32, f32]
-    #[tree(depth(4))]
+    /// `[f32, f32]` or `None`
+    #[tree(depth(2))]
     pub temperature_limits: [[Option<[f32; 2]>; 4]; 4],
 }
 
@@ -260,7 +260,7 @@ impl Default for Alarm {
             armed: false,
             target: Default::default(),
             period: 1.0,
-            temperature_limits: [[Some([f32::NEG_INFINITY, f32::INFINITY]); 4]; 4],
+            temperature_limits: Default::default(),
         }
     }
 }

src/net/telemetry.rs

@@ -85,7 +85,7 @@ impl<T: Serialize> TelemetryClient<T> {
     }
 
     /// A secondary functionality tugged onto the telemetry client that publishes onto another
-    /// [alarm_topic].
+    /// `alarm_topic`.
     pub fn publish_alarm(&mut self, alarm_topic: &String<128>, alarm: &bool) {
         self.mqtt
             .client()

src/output_channel.rs

@@ -31,7 +31,7 @@ pub struct OutputChannel {
     /// The y limits will be clamped to the maximum output current of +-3 A.
     ///
     /// # Value
-    /// See [iir::IIR#tree]
+    /// See [iir::Biquad]
     pub iir: iir::Biquad<f64>,
 
     /// Thermostat input channel weights. Each input temperature of an enabled channel
@@ -40,8 +40,8 @@ pub struct OutputChannel {
     ///
     /// # Path
     /// `weights/<adc>/<channel>`
-    /// * <adc> specifies which adc to configure. <adc> := [0, 1, 2, 3]
-    /// * <channel> specifies which channel of an ADC to configure. Only the enabled channels for the specific ADC are available.
+    /// * `<adc> := [0, 1, 2, 3]` specifies which adc to configure.
+    /// * `<channel>` specifies which channel of an ADC to configure. Only the enabled channels for the specific ADC are available.
     ///
     /// # Value
     /// f32