Merge pull request #12 from derenv/docs

Docs

Author: derenv

build.rs

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2022 Deren Vural
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-/*
+/**
  * Name:
  * build.rs
  *
@@ -25,7 +25,7 @@
 // Imports
 use adwaita::gio::compile_resources;
 
-/*
+/**
  * Name:
  * main
  *

src/custom_button/imp.rs

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2022 Deren Vural
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-/*
+/**
  * Name:
  * 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/custom_button/mod.rs

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2022 Deren Vural
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-/*
+/**
  * Name:
  * mod.rs
  *

src/formatter/imp.rs

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2022 Deren Vural
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-/*
+/**
  * Name:
  * 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
@@ -40,7 +40,7 @@ impl ObjectSubclass for Formatter {
     type ParentType = gtk::Widget;
 }
 
-/*
+/**
  * Trait Name:
  * ObjectImpl
  *
@@ -57,7 +57,7 @@ impl ObjectSubclass for Formatter {
  *
  */
 impl ObjectImpl for Formatter {
-    /*
+    /**
      * Name:
      * properties
      *
@@ -71,7 +71,7 @@ impl ObjectImpl for Formatter {
      * Deren Vural
      *
      * Notes:
-     * beware that you need to use kebab-case (https://en.wikipedia.org/wiki/Letter_case#Kebab_case)
+     * beware that you need to use kebab-case (<https://en.wikipedia.org/wiki/Letter_case#Kebab_case>)
      *
      * ParamSpec Examples:
      * glib::ParamSpecString::builder("icon").build(),
@@ -94,7 +94,7 @@ impl ObjectImpl for Formatter {
         PROPERTIES.as_ref()
     }
 
-    /*
+    /**
      * Name:
      * set_property
      *
@@ -119,7 +119,7 @@ impl ObjectImpl for Formatter {
         }
     }
 
-    /*
+    /**
      * Name:
      * property
      *
@@ -145,7 +145,7 @@ impl ObjectImpl for Formatter {
     }
 }
 
-/*
+/**
  * Trait Name:
  * WidgetImpl
  *

src/formatter/mod.rs

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2022 Deren Vural
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-/*
+/**
  * Name:
  * mod.rs
  *
@@ -35,7 +35,7 @@ glib::wrapper! {
     @implements gtk::Accessible, gtk::Actionable, gtk::Buildable, gtk::ConstraintTarget;
 }
 
-/*
+/**
  * Trait Name:
  * Formatter
  *
@@ -52,7 +52,7 @@ glib::wrapper! {
  *
  */
 impl Formatter {
-    /*
+    /**
      * Name:
      * new
      *
@@ -118,7 +118,7 @@ impl Formatter {
     }
 }
 
-/*
+/**
  * Trait Name:
  * Default
  *

src/main.rs

@@ -1,12 +1,12 @@
 // SPDX-FileCopyrightText: 2022 Deren Vural
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-/*
+/**
  * Name:
- * main.rs
+ * gtk4-nvidia-monitor-rust
  *
  * Description:
- * Rust Implementation of Nvidia Gnome Extension
+ * GTK-rs app for monitoring Nvidia GPU statistics
  *
  * Made:
  * 12/09/2022
@@ -17,7 +17,6 @@
  * Notes:
  *
  */
-
 // Modules
 mod formatter;
 mod mainwindow;
@@ -30,16 +29,30 @@ mod custom_button;
 mod settingswindow;
 
 // Imports
-use adwaita::prelude::*;
-use adwaita::{gio, Application};
+use adwaita::{gio, prelude::*, Application};
 use gdk::Display;
 use gio::resources_register_include;
 use gtk::{CssProvider, StyleContext};
 
 // Constants
 const APP_ID: &str = "com.gtk_d.NvidiaMonitorRust";
 
-// Main Function
+/**
+ * Name:
+ * main
+ *
+ * Description:
+ * Load resources, initialise GTK, create application and connect signals
+ *
+ * Made:
+ * 13/09/2022
+ *
+ * Made by:
+ * Deren Vural
+ *
+ * Notes:
+ *
+ */
 fn main() {
     // Resources
     resources_register_include!("nvidiamonitorrust.gresource")
@@ -60,17 +73,48 @@ fn main() {
     println!("{}", app.run());
 }
 
+/**
+ * Name:
+ * setup_shortcuts
+ *
+ * Description:
+ * Add keyboard shortcuts to the program
+ *
+ * Made:
+ * 09/10/2022
+ *
+ * Made by:
+ * Deren Vural
+ *
+ * Notes:
+ * <https://github.com/gtk-rs/gtk4-rs/blob/master/book/listings/todo/5/main.rs>
+ * <https://gtk-rs.org/gtk4-rs/stable/latest/book/todo_3.html>
+ *
+ */
 /*
-//https://github.com/gtk-rs/gtk4-rs/blob/master/book/listings/todo/5/main.rs
-//https://gtk-rs.org/gtk4-rs/stable/latest/book/todo_3.html
 fn setup_shortcuts(app: &Application) {
     app.set_accels_for_action("win.filter('All')", &["<Ctrl>a"]);
     app.set_accels_for_action("win.filter('Open')", &["<Ctrl>o"]);
     app.set_accels_for_action("win.filter('Done')", &["<Ctrl>d"]);
 }
 */
 
-// Load CSS styles
+/**
+ * Name:
+ * load_css
+ *
+ * Description:
+ * Load css from file and add as style provider
+ *
+ * Made:
+ * 23/10/2022
+ *
+ * Made by:
+ * Deren Vural
+ *
+ * Notes:
+ *
+ */
 fn load_css() {
     // Load the CSS file and add it to the provider
     let provider = CssProvider::new();
@@ -84,10 +128,27 @@ fn load_css() {
     );
 }
 
-// Build Function
+/**
+ * Name:
+ * build_ui
+ *
+ * Description:
+ * Build the main window (given the application object) and run
+ *
+ * Made:
+ * 13/09/2022
+ *
+ * Made by:
+ * Deren Vural
+ *
+ * Notes:
+ *
+ */
 fn build_ui(app: &Application) {
     // Create a new custom window and show it
     let window: MainWindow = MainWindow::new(app);
+
+    // Present window
     window.show();
 
     /*