proxmox-rrd: improve dev docs

diff --git a/proxmox-rrd/src/cache.rs b/proxmox-rrd/src/cache.rs
index 0c26ede8b3a940601c3884d5154f2f842a1bedb7..6cac584916c859c1468009e286d4441f59551efe 100644 (file)
--- a/proxmox-rrd/src/cache.rs
+++ b/proxmox-rrd/src/cache.rs
@@ -54,7 +54,7 @@ impl RRDCache {
     ///
     /// `apply_interval`: Commit journal after `apply_interval` seconds.
     ///
-    /// `load_rrd_cb`; The callback function is use to load RRD files,
+    /// `load_rrd_cb`; The callback function is used to load RRD files,
     /// and should return a newly generated RRD if the file does not
     /// exists (or is unreadable). This may generate RRDs with
     /// different configurations (dependent on `rel_path`).
@@ -171,6 +171,7 @@ impl RRDCache {
         Ok(())
     }
 
+    /// Apply journal. Should be used at server startup.
     pub fn apply_journal(&self) -> Result<(), Error> {
         let mut state = self.state.write().unwrap(); // block writers
         self.apply_journal_locked(&mut state)
@@ -296,6 +297,7 @@ impl RRDCache {
     /// Extract data from cached RRD
     ///
     /// `start`: Start time. If not sepecified, we simply extract 10 data points.
+    ///
     /// `end`: End time. Default is to use the current time.
     pub fn extract_cached_data(
         &self,

diff --git a/proxmox-rrd/src/rrd.rs b/proxmox-rrd/src/rrd.rs
index 5382ba9d05ab32d9991a1152c52291b709900a8b..60dfad7cbc3ce26f090fd5345d17118fe066d275 100644 (file)
--- a/proxmox-rrd/src/rrd.rs
+++ b/proxmox-rrd/src/rrd.rs
@@ -56,6 +56,7 @@ pub enum CF {
 }
 
 #[derive(Serialize, Deserialize)]
+/// Data source specification
 pub struct DataSource {
     /// Data source type
     pub dst: DST,
@@ -120,12 +121,15 @@ impl DataSource {
 }
 
 #[derive(Serialize, Deserialize)]
+/// Round Robin Archive
 pub struct RRA {
+    /// Number of seconds spaned by a single data entry.
     pub resolution: u64,
+    /// Consolitation function.
     pub cf: CF,
-    /// Count values computed inside this update interval
+    /// Count values computed inside this update interval.
     pub last_count: u64,
-    /// The actual data
+    /// The actual data entries.
     pub data: Vec<f64>,
 }
 
@@ -277,8 +281,11 @@ impl RRA {
 }
 
 #[derive(Serialize, Deserialize)]
+/// Round Robin Database
 pub struct RRD {
+    /// The data source definition
     pub source: DataSource,
+    /// List of round robin archives
     pub rra_list: Vec<RRA>,
 }