Updated crate for documentation

- Added missing function comment headers in main.rs
- Added <> brackets around hyperlinks
- Cleaned up some imports (removed super::xxx style also)
- Moved subprocess functions into a module
- Fixed weird "process()" header in property class

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

Author: Deren Vural

src/formatter/imp.rs

@@ -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(),

src/main.rs

@@ -3,10 +3,10 @@
 
 /**
  * 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();
 
     /*

src/mainwindow/imp.rs

@@ -658,7 +658,7 @@ impl ObjectImpl for MainWindow {
      * 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(),

src/processor/imp.rs

@@ -15,9 +15,9 @@
  * Deren Vural
  *
  * Notes:
- * https://github.com/gtk-rs/gtk4-rs/blob/master/book/src/g_object_properties.md
- * https://github.com/gtk-rs/gtk4-rs/blob/master/book/listings/g_object_properties/4/custom_button/imp.rs
- * https://github.com/gtk-rs/gtk4-rs/blob/master/book/listings/g_object_properties/4/custom_button/mod.rs
+ * <https://github.com/gtk-rs/gtk4-rs/blob/master/book/src/g_object_properties.md>
+ * <https://github.com/gtk-rs/gtk4-rs/blob/master/book/listings/g_object_properties/4/custom_button/imp.rs>
+ * <https://github.com/gtk-rs/gtk4-rs/blob/master/book/listings/g_object_properties/4/custom_button/mod.rs>
  */
 
 // Imports
@@ -77,7 +77,7 @@ impl ObjectImpl for Processor {
      * 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(),

src/processor/mod.rs

@@ -23,11 +23,13 @@
 mod imp;
 
 // Imports
-use super::subprocess;
 use glib::Object;
 use gtk::{gio, glib, prelude::ObjectExt};
 use std::ffi::OsStr;
 
+// Crates
+use crate::{subprocess::subprocess::exec_communicate};
+
 // GObject wrapper for Processor
 glib::wrapper! {
     pub struct Processor(ObjectSubclass<imp::Processor>)
@@ -151,7 +153,7 @@ impl Processor {
                 ];
 
                 // Run process, get output
-                match subprocess::exec_communicate(&argv, None::<&gio::Cancellable>) {
+                match exec_communicate(&argv, None::<&gio::Cancellable>) {
                     Ok(return_val) => match return_val {
                         // ACTUAL
                         (None, None) => return Ok(None),
@@ -189,7 +191,7 @@ impl Processor {
                 ];
 
                 // Run process, get output
-                match subprocess::exec_communicate(&argv, None::<&gio::Cancellable>) {
+                match exec_communicate(&argv, None::<&gio::Cancellable>) {
                     Ok(return_val) => match return_val {
                         // ACTUAL
                         (None, None) => return Ok(None),
@@ -226,7 +228,7 @@ impl Processor {
                 ];
 
                 // Run process, get output
-                match subprocess::exec_communicate(&argv, None::<&gio::Cancellable>) {
+                match exec_communicate(&argv, None::<&gio::Cancellable>) {
                     Ok(return_val) => match return_val {
                         // ACTUAL
                         (None, None) => return Ok(None),
@@ -258,7 +260,7 @@ impl Processor {
                 let argv: [&OsStr; 2] = [call_stack_items[0], call_stack_items[1]];
 
                 // Run process, get output
-                match subprocess::exec_communicate(&argv, None::<&gio::Cancellable>) {
+                match exec_communicate(&argv, None::<&gio::Cancellable>) {
                     Ok(return_val) => match return_val {
                         // ACTUAL
                         (None, None) => return Ok(None),

src/property/imp.rs

@@ -79,7 +79,7 @@ impl ObjectImpl for Property {
      * 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>)
      */
     fn properties() -> &'static [ParamSpec] {
         static PROPERTIES: Lazy<Vec<ParamSpec>> = Lazy::new(|| {

src/property/mod.rs

@@ -106,12 +106,10 @@ impl Property {
      * Deren Vural
      *
      * Notes:
-     *
+     * <https://doc.rust-lang.org/std/primitive.array.html>
+     * <https://www.tutorialspoint.com/rust/rust_array.htm>
+     * <https://doc.rust-lang.org/std/vec/struct.Vec.html>
      */
-    // Parsing
-    //https://doc.rust-lang.org/std/primitive.array.html
-    //https://www.tutorialspoint.com/rust/rust_array.htm
-    //https://doc.rust-lang.org/std/vec/struct.Vec.html
     pub fn parse(
         self,
         values: Vec<Vec<String>>,

src/provider/imp.rs

@@ -79,7 +79,7 @@ impl ObjectImpl for Provider {
      * 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(),

src/provider/mod.rs

@@ -28,7 +28,7 @@ use gtk::prelude::*;
 use std::ffi::OsStr;
 
 // Crates
-use crate::{processor::Processor, property::Property, subprocess};
+use crate::{processor::Processor, property::Property, subprocess::subprocess::exec_check};
 
 // GObject wrapper for Provider
 glib::wrapper! {
@@ -277,7 +277,7 @@ impl Provider {
         match self.property::<i32>("provider-type") {
             // Open Nvidia Settings
             0 => {
-                match subprocess::exec_check(
+                match exec_check(
                     &[OsStr::new("nvidia-settings")],
                     None::<&gio::Cancellable>,
                 ) {
@@ -286,7 +286,7 @@ impl Provider {
                 };
             }
             1 => {
-                match subprocess::exec_check(
+                match exec_check(
                     &[OsStr::new("nvidia-settings")],
                     None::<&gio::Cancellable>,
                 ) {