Add some docs

This commit is contained in:
Wojciech Kozlowski 2018-12-26 02:56:50 +05:30
parent 009c0079da
commit daf7ade015

View File

@ -42,7 +42,10 @@ fn read_file(base: &str, filename: &str) -> io::Result<String> {
Ok(contents) Ok(contents)
} }
/// Path to monitors.
const HWMON_PATH: &'static str = "/sys/devices/virtual/hwmon"; const HWMON_PATH: &'static str = "/sys/devices/virtual/hwmon";
/// Array of monitors to use.
const HWMONS: [&'static str; 3] = ["hwmon0", "hwmon2", "hwmon4"]; const HWMONS: [&'static str; 3] = ["hwmon0", "hwmon2", "hwmon4"];
/// Return temperature reads from all monitors. /// Return temperature reads from all monitors.
@ -83,7 +86,10 @@ fn get_load_avgs() -> String {
format!("{:.2} {:.2} {:.2}", avgs[0], avgs[1], avgs[2]) format!("{:.2} {:.2} {:.2}", avgs[0], avgs[1], avgs[2])
} }
/// Path to power supply information.
const BATT_PATH: &'static str = "/sys/class/power_supply"; const BATT_PATH: &'static str = "/sys/class/power_supply";
/// Batteries to display.
const BATTS: [&'static str; 2] = ["BAT0", "BAT1"]; const BATTS: [&'static str; 2] = ["BAT0", "BAT1"];
/// Return battery status for all batteries. /// Return battery status for all batteries.