Phase 2 of DDA

AddDevice.xaml.cs

@@ -2,36 +2,70 @@
 using System.Linq;
 using System.Management;
 using System.Windows;
+
+using TheFlightSims.HyperVDPD.DefaultUI;
 using TheFlightSims.HyperVDPD.WMIProperties;
 
+/*
+ * Primary namespace for HyperV-DPD application
+ *  It contains the main window and all related methods for the core application
+ */
 namespace TheFlightSims.HyperVDPD
 {
+    /*
+     * Add Device Window class
+     * It is used to add device into the selected VM
+     */
     public partial class AddDevice : Window
     {
+        ////////////////////////////////////////////////////////////////
+        /// Global Properties and Constructors Region
+        ///     This region contains global properties and constructors 
+        ///     for the MachineMethods class.
+        ////////////////////////////////////////////////////////////////
+
+        /*
+         *  Global properties
+         *      deviceId: Device ID of the selected device
+         *      machine: WMI namespace of the machine
+         */
+
         protected string deviceId;
         protected MachineMethods machine;
 
+        /*
+         * Constructor of the MainWindow class
+         * Initializes the components and sets up event handlers
+         */
         public AddDevice(MachineMethods machine)
         {
             this.machine = machine;
             machine.Connect("root\\cimv2");
             InitializeComponent();
         }
 
+
+        ////////////////////////////////////////////////////////////////
+        /// User Action Methods Region
+        ///     This region contains methods that handle user actions.
+        ///     For example, button clicks, changes in order.
+        ////////////////////////////////////////////////////////////////
+
         /*
-         * Button and UI methods behaviour....
+         * Actions for button "Add Device"
          */
-
         private void AddDeviceButton_Click(object sender, RoutedEventArgs e)
         {
+            // If the selected item is not null (nothing is selected), proceed
             if (DeviceList.SelectedItem != null)
             {
                 deviceId = DeviceList.SelectedItem.GetType().GetProperty("DeviceId").GetValue(DeviceList.SelectedItem, null).ToString();
                 DialogResult = true;
             }
             else
             {
-                MessageBox.Show(
+                // Notify user if nothing is selected
+                _ = MessageBox.Show(
                     "Please select a device to add.",
                     "Warning",
                     MessageBoxButton.OK,
@@ -40,53 +74,78 @@ private void AddDeviceButton_Click(object sender, RoutedEventArgs e)
             }
         }
 
+        /*
+         * Actions for button "Close"
+         */
         private void AddDeviceCloseButton_Click(object sender, RoutedEventArgs e)
         {
             Close();
         }
 
+        ////////////////////////////////////////////////////////////////
+        /// Non-User Action Methods Region
+        /// 
+        /// This region contains methods that do not handle user actions.
+        /// 
+        /// Think about this is the back-end section.
+        /// It should not be in a seperated class, because it directly interacts with the UI elements.
+        ////////////////////////////////////////////////////////////////
+
         /*
-         * Non-button methods
+         * Start getting the device ID
          */
-
         public string GetDeviceId()
         {
+
             UpdateDevices();
-            ShowDialog();
+            _ = ShowDialog();
 
+            // Return the device ID back to the main windows
             return deviceId;
         }
 
-        private void UpdateDevices()
+        /*
+         * Update device list
+         */
+        private async void UpdateDevices()
         {
+            // Clear the device list
             DeviceList.Items.Clear();
 
             try
             {
-                foreach (ManagementObject device in machine.GetObjects("Win32_PnPEntity", "Status, PNPClass, Name, DeviceID").Cast<ManagementObject>())
+                // Loop for devices in Win32_PnPEntity
+                using (ManagementObjectCollection pnpEntityList = machine.GetObjects("Win32_PnPEntity", "Status, PNPClass, Name, DeviceID"))
                 {
-                    string deviceStatus = device["Status"]?.ToString() ?? "Unknown";
-                    string deviceType = device["PNPClass"]?.ToString() ?? "Unknown";
-                    string deviceName = device["Name"]?.ToString() ?? "Unknown";
-                    string deviceId = device["DeviceID"]?.ToString() ?? "Unknown";
-
-                    if (!deviceId.StartsWith("PCI"))
+                    foreach (ManagementObject device in pnpEntityList.Cast<ManagementObject>())
                     {
-                        continue;
-                    }
+                        string deviceStatus = device["Status"]?.ToString() ?? "Unknown";
+                        string deviceType = device["PNPClass"]?.ToString() ?? "Unknown";
+                        string deviceName = device["Name"]?.ToString() ?? "Unknown";
+                        string deviceId = device["DeviceID"]?.ToString() ?? "Unknown";
 
-                    DeviceList.Items.Add(new
-                    {
-                        DeviceStatus = deviceStatus,
-                        DeviceType = deviceType,
-                        DeviceName = deviceName,
-                        DeviceId = deviceId
-                    });
+                        // If the device is not PCI, skip to the next device
+                        if (!deviceId.StartsWith("PCI"))
+                        {
+                            device.Dispose();
+                            continue;
+                        }
+
+                        _ = DeviceList.Items.Add(new
+                        {
+                            DeviceStatus = deviceStatus,
+                            DeviceType = deviceType,
+                            DeviceName = deviceName,
+                            DeviceId = deviceId
+                        });
+
+                        device.Dispose();
+                    }
                 }
             }
             catch (Exception ex)
             {
-                WMIDefaultValues.HandleException(ex, machine.GetComputerName());
+                (new ExceptionView()).HandleException(ex);
             }
         }
     }

ChangeMemorySpace.xaml.cs

@@ -1,37 +1,60 @@
-using System;
-using System.Windows;
+using System.Windows;
 
+/*
+ * Primary namespace for HyperV-DPD application
+ *  It contains the main window and all related methods for the core application
+ */
 namespace TheFlightSims.HyperVDPD
 {
+    /*
+     * Change Memory Space Window
+     */
     public partial class ChangeMemorySpace : Window
     {
+        ////////////////////////////////////////////////////////////////
+        /// Global Properties and Constructors Region
+        ///     This region contains global properties and constructors 
+        ///     for the MachineMethods class.
+        ////////////////////////////////////////////////////////////////
+
         /*
          * Global properties
+         *  memRange as tuple of low and high memory
          */
-        protected (UInt64 lowMem, UInt64 highMem) memRange;
+        protected (ulong lowMem, ulong highMem) memRange;
 
+        // Constructor of the Change Memory space window
         public ChangeMemorySpace(string vmName)
         {
             Title += $" for {vmName}";
             InitializeComponent();
         }
 
+        ////////////////////////////////////////////////////////////////
+        /// User Action Methods Region
+        ///     This region contains methods that handle user actions.
+        ///     For example, button clicks, changes in order.
+        ////////////////////////////////////////////////////////////////
+
         /*
-         * Button-based methods
+         * Actions for button "Confirm"
          */
         private void Confirm_Button(object sender, RoutedEventArgs e)
         {
-            if (UInt64.TryParse(LowMemory_TextBox.Text, out UInt64 lowMemCompare) && UInt64.TryParse(HighMemory_TextBox.Text, out UInt64 highMemCompare))
+            // Try to parse number in the box
+            if (ulong.TryParse(LowMemory_TextBox.Text, out ulong lowMemCompare) && ulong.TryParse(HighMemory_TextBox.Text, out ulong highMemCompare))
             {
-                if ((lowMemCompare >= 128 && lowMemCompare <= 3584) && (highMemCompare >= 4096 && highMemCompare <= (UInt64.MaxValue - 2)))
+                // Check for low MMIO and high MMIO. If valid, return the value
+                if ((lowMemCompare >= 128 && lowMemCompare <= 3584) && (highMemCompare >= 4096 && highMemCompare <= (ulong.MaxValue - 2)))
                 {
                     memRange.lowMem = lowMemCompare;
                     memRange.highMem = highMemCompare;
                     DialogResult = true;
                 }
                 else
                 {
-                    MessageBox.Show(
+                    // Notify user for invalid valid input
+                    _ = MessageBox.Show(
                         "Make sure the Low MMIO Gap is in range (128, 3584) and High MMIO is larger than 4096",
                         "Warning",
                         MessageBoxButton.OK,
@@ -41,7 +64,7 @@ private void Confirm_Button(object sender, RoutedEventArgs e)
             }
             else
             {
-                MessageBox.Show(
+                _ = MessageBox.Show(
                     "Please enter a positive integer in both box.",
                     "Warning",
                     MessageBoxButton.OK,
@@ -50,17 +73,29 @@ private void Confirm_Button(object sender, RoutedEventArgs e)
             }
         }
 
+        /*
+         * Action for button "Cancel"
+         */
         private void Cancel_Button(object sender, RoutedEventArgs e)
         {
             Close();
         }
 
+        ////////////////////////////////////////////////////////////////
+        /// Non-User Action Methods Region
+        /// 
+        /// This region contains methods that do not handle user actions.
+        /// 
+        /// Think about this is the back-end section.
+        /// It should not be in a seperated class, because it directly interacts with the UI elements.
+        ////////////////////////////////////////////////////////////////
+
         /*
-         * Non-button methods
+         * Return Value
          */
-        public (UInt64, UInt64) ReturnValue()
+        public (ulong, ulong) ReturnValue()
         {
-            ShowDialog();
+            _ = ShowDialog();
 
             return memRange;
         }