!24 Driver function annotation

Merge pull request !24 from Juster Zhu/dev
GeneralLibrary · Nov 19, 2023 · c867a93 · c867a93
2 parents 2fd18bb + ee2ea7f
commit c867a93
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/src/c#/GeneralUpdate.Core/Driver/BackupDriverCommand.cs b/src/c#/GeneralUpdate.Core/Driver/BackupDriverCommand.cs
@@ -18,6 +18,9 @@ public BackupDriverCommand(DriverInformation information)
 
         public void Execute()
         {
+            /*
+             * Back up the specified list of drives.
+             */
             foreach (var driverName in _information.DriverNames)
             {
                 var command = new StringBuilder("/c dism /online /export-driver /destination:\"")

diff --git a/src/c#/GeneralUpdate.Core/Driver/DriverProcessor.cs b/src/c#/GeneralUpdate.Core/Driver/DriverProcessor.cs
@@ -2,6 +2,9 @@
 
 namespace GeneralUpdate.Core.Driver
 {
+    /// <summary>
+    /// Handle all drive-related.
+    /// </summary>
     public class DriverProcessor
     {
         private List<IDriverCommand> _commands = new List<IDriverCommand>();
@@ -11,6 +14,9 @@ public void AddCommand(IDriverCommand command)
             _commands.Add(command);
         }
 
+        /// <summary>
+        /// Execute all driver-related commands.
+        /// </summary>
         public void ProcessCommands()
         {
             foreach (var command in _commands)

diff --git a/src/c#/GeneralUpdate.Core/Driver/InstallDriverCommand.cs b/src/c#/GeneralUpdate.Core/Driver/InstallDriverCommand.cs
@@ -16,6 +16,7 @@ public void Execute()
         {
             try
             {
+                //Install all drivers in the specified directory, and if the installation fails, restore all the drivers in the backup directory.
                 var command = new StringBuilder("/c pnputil /add-driver \"")
                     .Append(_information.InstallDirectory)
                     .Append("\"")

diff --git a/src/c#/GeneralUpdate.Core/Driver/RestoreDriverCommand.cs b/src/c#/GeneralUpdate.Core/Driver/RestoreDriverCommand.cs
@@ -13,6 +13,7 @@ public RestoreDriverCommand(DriverInformation information)
 
         public void Execute()
         {
+            //Restore all drives in the backup directory.
             var command = new StringBuilder("/c pnputil /add-driver \"")
                 .Append(_information.OutPutDirectory)
                 .Append("\"")