added documentation AGAIN

Author: Segelente

src/detail.rs

@@ -18,6 +18,12 @@ use rand::Rng;
 use std::fmt::{Display, Formatter};
 use std::vec;
 
+/// Stores all information about a plant that is displayed on the detail page
+///
+/// Arguments:
+/// * `id` - The id of the plant that is displayed
+/// * `data` - The metadata of the plant, containing f.e. the name
+/// * `charts` - The charts of the plant, containing the coordinates and the message
 #[derive(Debug, Clone)]
 pub struct DetailPlant {
     pub id: String,
@@ -45,24 +51,52 @@ impl DetailPlant {
         }
     }
 }
+/// Contains all possible messages that can be sent to the detail page
 #[derive(Debug, Clone, PartialEq)]
 pub enum DetailMessage {
+    /// Closes the modal and sends the changes of the plant or group to the server
     OkButtonPressed,
+    /// Sets the message to pending to display the overview
     SwitchTime(chrono::Duration),
+    /// Opens the modal to edit the plant
     OpenModalPlant,
+    /// Opens the modal to edit the group
     OpenModalGroup,
+    /// Closes the modal
     CloseModal,
+    /// Deletes the plant
     Delete,
+    /// The message is pending, the overview is displayed
     Pending,
+    /// Loads the data of the plant
     Load,
+    /// Gets the data of the plant
     PlantData(String),
+    /// Indicates that the plant data was loaded
     Loaded,
+    /// Switches the graph to the given sensor
     SwitchGraph(Sensortypes),
+    /// Handles the input of the plant id to search for a plant
     Search(String),
+    /// Handles the input of the plant or group metadata
     FieldUpdated(u8, String),
+    /// Indicates that the plant was deleted
     DeleteSuccess,
 }
 
+/// Contains all information about the detail page
+///
+/// Fields:
+/// * `active_sensor` - The sensor that is currently displayed
+/// * `timerange` - The timerange that is currently displayed
+/// * `modal` - Indicates if the modal is open
+/// * `modal_is_plant` - Indicates if the modal is open for a plant or a group
+/// * `additionalCareTips` - The additional care tips of the plant only for this plant
+/// * `careTips` - The care tips of the plant for all plants of this group
+/// * `sensor_border` - The min max values of the sensor
+/// * `id_names` - The id and name of the plant
+/// * `plant` - The plant that is displayed
+/// * `message` - The message that is currently displayed
 pub(crate) struct DetailPage {
     pub active_sensor: Sensortypes,
     pub timerange: (String, String),
@@ -75,14 +109,22 @@ pub(crate) struct DetailPage {
     pub plant: DetailPlant,
     pub message: DetailMessage,
 }
+
+/// Contains all available sensors, their names, and colors
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub enum Sensortypes {
+    /// Soil moisture sensor
     Feuchtigkeit,
+    /// Humidity sensor
     Luftfeuchtigkeit,
+    /// Temperature sensor
     Temperatur,
+    /// Light sensor
     Licht,
 }
+
 impl Display for Sensortypes {
+    /// Returns the sensor name as a string
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
         match self {
             Sensortypes::Feuchtigkeit => write!(f, "Feuchtigkeit"),
@@ -92,7 +134,9 @@ impl Display for Sensortypes {
         }
     }
 }
+
 impl Sensortypes {
+    /// Returns the sensor name as a string in english
     pub fn get_name(&self) -> String {
         match self {
             Sensortypes::Feuchtigkeit => String::from("soil-moisture"),
@@ -101,6 +145,8 @@ impl Sensortypes {
             Sensortypes::Licht => String::from("light"),
         }
     }
+
+    /// Returns the color associated with the sensor
     pub fn get_color(&self) -> RGBColor {
         match self {
             Sensortypes::Feuchtigkeit => RGBColor(0, 0, 255),
@@ -109,6 +155,8 @@ impl Sensortypes {
             Sensortypes::Licht => RGBColor(255, 255, 0),
         }
     }
+
+    /// Returns a random offset color associated with the sensor
     pub fn get_color_with_random_offset(&self) -> RGBColor {
         let mut rng = rand::thread_rng();
         let offset = rng.gen_range(0..=255);
@@ -121,6 +169,8 @@ impl Sensortypes {
             Sensortypes::Licht => RGBColor(255 - offset3, 255 - offset3.clone(), offset),
         }
     }
+
+    /// Returns an iterator over all available sensors
     pub fn iter() -> impl Iterator<Item = Sensortypes> {
         [
             Sensortypes::Feuchtigkeit,
@@ -133,6 +183,7 @@ impl Sensortypes {
     }
 }
 impl DetailPage {
+    /// Creates a new detail page
     pub fn new() -> DetailPage {
         let plant = DetailPlant {
             id: String::new(),
@@ -157,6 +208,7 @@ impl DetailPage {
             message: DetailMessage::Pending,
         }
     }
+    /// If the string is longer than 30 characters, a newline is inserted every 30 characters
     pub fn insert_newline_to_string(&self, string: String) -> String {
         let mut new_string = String::new();
         let mut counter = 0;
@@ -172,6 +224,7 @@ impl DetailPage {
         }
         new_string
     }
+    /// Adds the sensor border graph to the plant charts
     pub fn min_max_graphs(&self, sensor_types: Sensortypes) -> Vec<PlantChart> {
         let mut charts = vec![];
         self.plant
@@ -203,6 +256,7 @@ impl DetailPage {
             });
         charts
     }
+    /// Handles the messages for the detail page
     pub fn update(&mut self, message: DetailMessage) -> Command<DetailMessage> {
         match message {
             DetailMessage::SwitchTime(value) => {
@@ -230,6 +284,7 @@ impl DetailPage {
                     |_| DetailMessage::DeleteSuccess,
                 );
             }
+
             DetailMessage::Load => {
                 info!("Refresh Id List");
                 //if empty self.id_names should be an empty vec

src/graphs.rs

@@ -11,16 +11,25 @@ use plotters::style::{Color, IntoFont, BLACK, BLUE, WHITE};
 use plotters_iced::{Chart, ChartBuilder, ChartWidget, DrawingBackend};
 
 #[derive(Debug, Clone, PartialEq)]
+/// A chart that can be drawn
+///
+/// Fields:
+/// - `name`: The name of the chart
+/// - `x`: The x values of the chart
+/// - `y`: The y values of the chart
+/// - `color`: The color of the chart
 pub struct PlantChart {
     pub name: String,
     pub x: Vec<i32>,
     pub y: Vec<i32>,
     color: RGBColor,
 }
 impl PlantChart {
+    /// Create a new PlantChart
     pub fn new(name: String, x: Vec<i32>, y: Vec<i32>, color: RGBColor) -> PlantChart {
         PlantChart { name, x, y, color }
     }
+    /// Create a test PlantChart
     pub fn test() -> PlantChart {
         PlantChart {
             name: String::from("Test"),
@@ -29,11 +38,13 @@ impl PlantChart {
             color: BLUE,
         }
     }
+    /// Get the color of the chart
     pub fn get_color(&self) -> RGBColor {
         self.color
     }
 }
 impl Default for PlantChart {
+    /// Create a default PlantChart
     fn default() -> Self {
         Self {
             name: String::new(),
@@ -44,21 +55,29 @@ impl Default for PlantChart {
     }
 }
 #[derive(Debug, Clone, PartialEq)]
+/// A collection of PlantCharts
+///
+/// Fields:
+/// - `charts`: The charts
+/// - `message`: The message that is passed to the charts, depending on the page it is used in
 pub struct PlantCharts<M> {
     pub charts: Vec<PlantChart>,
     pub message: M,
 }
 
 impl<M: 'static> PlantCharts<M> {
+    /// Create a new PlantCharts object
     pub fn new(charts: Vec<PlantChart>, message: M) -> PlantCharts<M> {
         PlantCharts { charts, message }
     }
+    /// Create a test PlantCharts object
     pub fn test(message: M) -> PlantCharts<M> {
         PlantCharts {
             charts: vec![PlantChart::test()],
             message,
         }
     }
+    /// Get the largest x and y values of the charts
     pub fn largest_x_y(&self) -> (i32, i32) {
         let mut x = 0;
         let mut y = 0;
@@ -74,6 +93,7 @@ impl<M: 'static> PlantCharts<M> {
         }
         (x, y)
     }
+    /// Create the charts from the data
     pub fn create_charts(
         message: M,
         graph_data: Vec<GraphData>,
@@ -92,6 +112,7 @@ impl<M: 'static> PlantCharts<M> {
         }
         PlantCharts::new(charts, message)
     }
+    /// Update the charts with new data
     pub fn update_charts(
         &self,
         message: M,
@@ -105,6 +126,7 @@ impl<M: 'static> PlantCharts<M> {
 
 impl<M: 'static + Clone> Chart<M> for PlantCharts<M> {
     type State = ();
+    /// Build the chart
     fn build_chart<DB: DrawingBackend>(&self, _state: &Self::State, mut builder: ChartBuilder<DB>) {
         //Change background color
         let mut chart = builder
@@ -153,6 +175,7 @@ impl<M: 'static + Clone> Chart<M> for PlantCharts<M> {
 }
 
 impl<M: 'static + Clone> PlantCharts<M> {
+    /// Shows the chart
     fn view(&self) -> Element<'_, M> {
         ChartWidget::new(self)
             .width(Length::Fill)

src/home.rs

@@ -16,19 +16,50 @@ use plotters_iced::ChartWidget;
 use std::collections::HashMap;
 
 #[derive(Debug, Clone)]
+/// The message of the home page
 pub enum HomeMessage {
+    /// Open the modal to add a new plant
     OpenModalPlant,
+    /// Open the modal to add a new group
     OpenModalGroup,
+    /// Close the modal
     CloseModal,
+    /// The cancel button was pressed
     CancelButtonPressed,
+    /// The ok button was pressed, the data is sent to the server
     OkButtonPressed,
+    /// An empty message to do nothing
     Plant,
+    /// Deletes the selected group
     DeleteGroup,
+    /// Refresh the page
     Refresh,
+    /// Change the graphs to the selected sensor
     SwitchGraph(Sensortypes),
+    /// Updates the variable to match the input
     FieldUpdated(u8, String),
 }
 
+/// The home page
+///
+/// Fields:
+/// - `timerange`: The timerange of the graphs
+/// - `selected_group`: The selected group
+/// - `group_name_id`: The names and ids of the groups
+/// - `show_modal`: If the modal is shown
+/// - `modal_is_plant`: If the modal is for a plant
+/// - `new_plant`: The data of the new plant
+/// - `new_group`: The data of the new group
+/// - `additionalCareTips`: The additional care tips of the new plant only for the plant
+/// - `sensor_border`: The border of the sensor
+/// - `careTips`: The care tips of the new plant for the plant and the group
+/// - `group`: The group of the new plant
+/// - `charts`: The charts of all groups for the selected sensor
+/// - `active_sensor`: The active sensor
+/// - `group_ids`: The ids of the groups
+/// - `id_names`: The ids and names of the plants
+///  - `group_names`: The names of the groups
+/// - `sensor_data`: The graph data of the sensors if the sensor was already selected
 pub(crate) struct HomePage {
     timerange: (String, String),
     selected_group: String,
@@ -50,6 +81,7 @@ pub(crate) struct HomePage {
 }
 
 impl HomePage {
+    /// Creates a new home page
     pub fn new() -> Self {
         let vec_chart = Vec::new();
         let charts = PlantCharts::new(vec_chart, HomeMessage::Plant);
@@ -84,6 +116,7 @@ impl HomePage {
         }
     }
 
+    /// Handles the messages of the home page
     pub fn update(&mut self, message: HomeMessage) -> Command<HomeMessage> {
         match message {
             HomeMessage::DeleteGroup => {
@@ -271,13 +304,16 @@ impl HomePage {
 impl Tab for HomePage {
     type Message = Message;
 
+    /// Sets the title of the page
     fn title(&self) -> String {
         String::from("Dashboard")
     }
 
+    /// Sets the label of the tab
     fn tab_label(&self) -> TabLabel {
         TabLabel::IconText(Icon::Homescreen.into(), self.title())
     }
+    /// Sets the content of the page
     fn content(&self) -> Element<'_, Self::Message> {
         if self.show_modal {
             if self.modal_is_plant {

src/main.rs

@@ -45,6 +45,8 @@ const EXTERNAL_ICON_FONT: Font = iced::Font::External {
     name: "External Icons",
     bytes: include_bytes!("../fonts/MaterialIcons-Regular.ttf"),
 };
+
+/// Default text size for the application.
 const TEXT_SIZE: u16 = 30;
 /// The Icons used in the application.
 enum Icon {