Added documentation text for the structs holding the custom gobject data

Signed-off-by: Deren Vural <[email protected]>

Author: Deren Vural

src/custom_button/imp.rs

@@ -21,11 +21,11 @@
 // Imports
 use gtk::{glib, subclass::prelude::*};
 
-// Object holding the state
+/// Object holding the State and any Template Children
 #[derive(Default)]
 pub struct CustomButton;
 
-// The central trait for subclassing a GObject
+/// The central trait for subclassing a GObject
 #[glib::object_subclass]
 impl ObjectSubclass for CustomButton {
     //Crate+Obj to avoid collisions

src/formatter/imp.rs

@@ -25,11 +25,11 @@ use gtk::{glib, subclass::prelude::*};
 // Modules
 //
 
-// Object holding the state
+/// Object holding the State and any Template Children
 #[derive(Default)]
 pub struct Formatter;
 
-// The central trait for subclassing a GObject
+/// The central trait for subclassing a GObject
 #[glib::object_subclass]
 impl ObjectSubclass for Formatter {
     //Crate+Obj to avoid collisions

src/mainwindow/imp.rs

@@ -28,14 +28,14 @@ use std::{cell::Cell, cell::RefCell, rc::Rc};
 // Modules
 use crate::{custom_button::CustomButton, settingswindow::SettingsWindow, formatter::Formatter, processor::Processor, property::Property, provider::Provider};
 
-// Structure for storing SettingsWindow and info
+/// Structure for storing a SettingsWindow object and any related information
 #[derive(Default)]
 pub struct SettingsWindowContainer {
     pub window: Option<SettingsWindow>,
     pub open: bool,
 }
 
-// Object holding the State
+/// Object holding the State and any Template Children
 #[derive(CompositeTemplate, Default)]
 #[template(resource = "/main-window.ui")]
 pub struct MainWindow {
@@ -52,7 +52,7 @@ pub struct MainWindow {
     pub refresh_button: TemplateChild<CustomButton>,
 }
 
-// The central trait for subclassing a GObject
+/// The central trait for subclassing a GObject
 #[glib::object_subclass]
 impl ObjectSubclass for MainWindow {
     // `NAME` needs to match `class` attribute of template
@@ -599,6 +599,7 @@ impl MainWindow {
         }
     }
 }
+
 /**
  * Trait Name:
  * ObjectImpl

src/processor/imp.rs

@@ -27,15 +27,15 @@ use gtk::prelude::*;
 use gtk::subclass::prelude::*;
 use std::cell::Cell;
 
-// Object holding the State
+/// Object holding the State and any Template Children
 #[derive(Default)]
 pub struct Processor {
     base_call: Cell<String>,
     call: Cell<String>,
     tail_call: Cell<String>,
 }
 
-// The central trait for subclassing a GObject
+/// The central trait for subclassing a GObject
 #[glib::object_subclass]
 impl ObjectSubclass for Processor {
     //Crate+Obj to avoid collisions

src/property/imp.rs

@@ -27,7 +27,7 @@ use std::cell::Cell;
 use crate::formatter::Formatter;
 use crate::processor::Processor;
 
-// Object holding the state
+/// Object holding the State and any Template Children
 #[derive(Default)]
 pub struct Property {
     processor: Cell<Processor>,
@@ -37,7 +37,7 @@ pub struct Property {
     gpu_count: Cell<i32>,
 }
 
-// The central trait for subclassing a GObject
+/// The central trait for subclassing a GObject
 #[glib::object_subclass]
 impl ObjectSubclass for Property {
     //Crate+Obj to avoid collisions

src/provider/imp.rs

@@ -26,7 +26,7 @@ use std::cell::Cell;
 // Modules
 use crate::property::Property;
 
-// Object holding the State
+/// Object holding the State and any Template Children
 #[derive(Default)]
 pub struct Provider {
     utilization: Cell<Property>,
@@ -37,7 +37,7 @@ pub struct Provider {
     provider_type: Cell<i32>,
 }
 
-// The central trait for subclassing a GObject
+/// The central trait for subclassing a GObject
 #[glib::object_subclass]
 impl ObjectSubclass for Provider {
     //Crate+Obj to avoid collisions

src/settingswindow/imp.rs

@@ -27,7 +27,7 @@ use gtk::{subclass::prelude::*, CheckButton, CompositeTemplate, SpinButton, Temp
 // Modules
 //use crate::utils::data_path;
 
-// Object holding the State
+/// Object holding the State and any Template Children
 #[derive(CompositeTemplate, Default)]
 #[template(resource = "/settings-window.ui")]
 pub struct SettingsWindow {
@@ -42,7 +42,7 @@ pub struct SettingsWindow {
     pub provider_input: TemplateChild<ComboRow>,
 }
 
-// The central trait for subclassing a GObject
+/// The central trait for subclassing a GObject
 #[glib::object_subclass]
 impl ObjectSubclass for SettingsWindow {
     // `NAME` needs to match `class` attribute of template