docs: add rustdoc comments to all module options

This part of an upcoming effort to generate documentation from code.

Pushing this out before that stage so that the JSON schema is fully documented.

src/modules/sysinfo.rs

@@ -15,33 +15,76 @@ use tokio::time::sleep;
 
 #[derive(Debug, Deserialize, Clone)]
 pub struct SysInfoModule {
-    /// List of formatting strings.
+    /// List of strings including formatting tokens.
+    /// For available tokens, see [below](#formatting-tokens).
+    ///
+    /// **Required**
     format: Vec<String>,
-    /// Number of seconds between refresh
+
+    /// Number of seconds between refresh.
+    ///
+    /// This can be set as a global interval,
+    /// or passed as an object to customize the interval per-system.
+    ///
+    /// **Default**: `5`
     #[serde(default = "Interval::default")]
     interval: Interval,
 
+    /// The orientation of text for the labels.
+    ///
+    /// **Valid options**: `horizontal`, `vertical, `h`, `v`
+    /// <br>
+    /// **Default** : `horizontal`
     #[serde(default)]
     orientation: ModuleOrientation,
 
+    /// The orientation by which the labels are laid out.
+    ///
+    /// **Valid options**: `horizontal`, `vertical, `h`, `v`
+    /// <br>
+    /// **Default** : `horizontal`
     direction: Option<ModuleOrientation>,
 
+    /// See [common options](module-level-options#common-options).
     #[serde(flatten)]
     pub common: Option<CommonConfig>,
 }
 
 #[derive(Debug, Deserialize, Copy, Clone)]
 pub struct Intervals {
+    /// The number of seconds between refreshing memory data.
+    ///
+    /// **Default**: `5`
     #[serde(default = "default_interval")]
     memory: u64,
+
+    /// The number of seconds between refreshing CPU data.
+    ///
+    /// **Default**: `5`
     #[serde(default = "default_interval")]
     cpu: u64,
+
+    /// The number of seconds between refreshing temperature data.
+    ///
+    /// **Default**: `5`
     #[serde(default = "default_interval")]
     temps: u64,
+
+    /// The number of seconds between refreshing disk data.
+    ///
+    /// **Default**: `5`
     #[serde(default = "default_interval")]
     disks: u64,
+
+    /// The number of seconds between refreshing network data.
+    ///
+    /// **Default**: `5`
     #[serde(default = "default_interval")]
     networks: u64,
+
+    /// The number of seconds between refreshing system data.
+    ///
+    /// **Default**: `5`
     #[serde(default = "default_interval")]
     system: u64,
 }