add - Added missing documentation

--- We've added missing documentation to several public classes and functions. --- Type: add Breaking: False Doc Required: False Part: 1/1
Aptivi-Archives · Oct 23, 2023 · 0dba7b9 · 0dba7b9
1 parent 6a1f2a6
commit 0dba7b9
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 15 deletions.
diff --git a/GRILO.Bootloader/BootApps/BootLoadContext.cs b/GRILO.Bootloader/BootApps/BootLoadContext.cs
@@ -30,7 +30,7 @@
 
 namespace GRILO.Bootloader.BootApps
 {
-    public class BootLoadContext : AssemblyLoadContext
+    internal class BootLoadContext : AssemblyLoadContext
     {
         internal AssemblyDependencyResolver resolver;
         internal string bootPath = "";

diff --git a/GRILO.Bootloader/BootApps/BootLoader.cs b/GRILO.Bootloader/BootApps/BootLoader.cs
@@ -31,13 +31,13 @@
 
 namespace GRILO.Bootloader.BootApps
 {
-    public class BootLoader : MarshalByRefObject
+    internal class BootLoader : MarshalByRefObject
     {
-        public byte[] bytes = Array.Empty<byte>();
         public string lookupPath = "";
         public bool shutting = false;
+        internal byte[] bytes = Array.Empty<byte>();
 
-        public void ProxyExecuteBootable(params string[] args)
+        internal void ProxyExecuteBootable(params string[] args)
         {
             AppDomain.CurrentDomain.AssemblyResolve += this.ResolveDependency;
             var asm = Assembly.Load(bytes);
@@ -55,7 +55,7 @@ public void ProxyExecuteBootable(params string[] args)
             shutting = proxy.ShutdownRequested;
         }
 
-        public bool VerifyBoot(byte[] bootBytes)
+        internal bool VerifyBoot(byte[] bootBytes)
         {
             AppDomain.CurrentDomain.AssemblyResolve += this.ResolveDependency;
             var asm = Assembly.Load(bootBytes);

diff --git a/GRILO.Bootloader/BootApps/BootProxy.cs b/GRILO.Bootloader/BootApps/BootProxy.cs
@@ -28,7 +28,7 @@
 
 namespace GRILO.Bootloader.BootApps
 {
-    public class BootProxy : IBootable
+    internal class BootProxy : IBootable
     {
         internal BootLoader loader = null;
 

diff --git a/GRILO.Bootloader/BootStyle/BaseBootStyle.cs b/GRILO.Bootloader/BootStyle/BaseBootStyle.cs
@@ -28,15 +28,33 @@
 
 namespace GRILO.Bootloader.BootStyle
 {
+    /// <summary>
+    /// Base boot style
+    /// </summary>
     public abstract class BaseBootStyle : IBootStyle
     {
+        /// <inheritdoc/>
         public abstract Dictionary<ConsoleKeyInfo, Action<BootAppInfo>> CustomKeys { get; }
+
+        /// <inheritdoc/>
         public abstract void Render();
+
+        /// <inheritdoc/>
         public abstract void RenderHighlight(int chosenBootEntry);
+
+        /// <inheritdoc/>
         public abstract void RenderModalDialog(string content);
+
+        /// <inheritdoc/>
         public abstract void RenderBootingMessage(string chosenBootName);
+
+        /// <inheritdoc/>
         public abstract void RenderBootFailedMessage(string content);
+
+        /// <inheritdoc/>
         public abstract void RenderSelectTimeout(int timeout);
+
+        /// <inheritdoc/>
         public abstract void ClearSelectTimeout();
     }
 }
diff --git a/GRILO.Bootloader/BootStyle/BootStyleManager.cs b/GRILO.Bootloader/BootStyle/BootStyleManager.cs
@@ -205,6 +205,10 @@ public static void RenderBootFailedMessage(string content)
             Input.DetectKeypress();
         }
 
+        /// <summary>
+        /// Renders the selection timeout
+        /// </summary>
+        /// <param name="timeout">Timeout interval in seconds</param>
         public static void RenderSelectTimeout(int timeout)
         {
             if (!timeoutThread.IsAlive && timeout > 0 && GRILO.waitingForFirstBootKey)

diff --git a/GRILO.Bootloader/Configuration/Config.cs b/GRILO.Bootloader/Configuration/Config.cs
@@ -35,6 +35,9 @@ public static class Config
     {
         internal static ConfigInstance instance = new();
 
+        /// <summary>
+        /// Configuration instance
+        /// </summary>
         public static ConfigInstance Instance =>
             instance;
 

diff --git a/GRILO.Bootloader/Configuration/Instance/ConfigInstance.cs b/GRILO.Bootloader/Configuration/Instance/ConfigInstance.cs
@@ -27,23 +27,44 @@
 
 namespace GRILO.Bootloader.Configuration.Instance
 {
+    /// <summary>
+    /// Configuration instance
+    /// </summary>
     public class ConfigInstance
     {
+        /// <summary>
+        /// The boot style name
+        /// </summary>
         [JsonProperty("Boot style", Required = Required.Always)]
         public string BootStyleName { get; set; } = "Default";
 
+        /// <summary>
+        /// Whether to create a file containing diagnostic messages
+        /// </summary>
         [JsonProperty("Diagnostic messages", Required = Required.Always)]
         public bool DiagnosticMessages { get; set; }
 
+        /// <summary>
+        /// Whether to also print diagnostic messages to the console
+        /// </summary>
         [JsonProperty("Print diagnostic messages to console", Required = Required.Always)]
         public bool PrintDiagnosticMessages { get; set; }
 
+        /// <summary>
+        /// Additional bootable folders to scan for bootable applications
+        /// </summary>
         [JsonProperty("Additional bootable folders", Required = Required.Always)]
         public string[] AdditionalScanFolders { get; set; } = Array.Empty<string>();
 
+        /// <summary>
+        /// Timeout to boot to the default selection
+        /// </summary>
         [JsonProperty("Timeout to boot to selection", Required = Required.Always)]
         public int BootSelectTimeoutSeconds { get; set; } = 10;
 
+        /// <summary>
+        /// The default boot entry selection. This number is zero-based, so the first element is index 0, and so on.
+        /// </summary>
         [JsonProperty("Default boot entry selection", Required = Required.Always)]
         public int BootSelect { get; set; } = 0;
     }

diff --git a/GRILO.Bootloader/GRILOException.cs b/GRILO.Bootloader/GRILOException.cs
@@ -31,16 +31,28 @@ namespace GRILO.Bootloader
     /// </summary>
     public class GRILOException : Exception
     {
-        public GRILOException() : base("Unknown bootloader error!")
-        {
-        }
+        /// <summary>
+        /// Makes a new instance of GRILO exception
+        /// </summary>
+        public GRILOException() :
+            base("Unknown bootloader error!")
+        { }
 
-        public GRILOException(string message) : base("Internal bootloader error: " + message)
-        {
-        }
+        /// <summary>
+        /// Makes a new instance of GRILO exception
+        /// </summary>
+        /// <param name="message">Error message to use while creating a new instance of the exception</param>
+        public GRILOException(string message) :
+            base("Internal bootloader error: " + message)
+        { }
 
-        public GRILOException(string message, Exception innerException) : base("Internal bootloader error: " + message, innerException)
-        {
-        }
+        /// <summary>
+        /// Makes a new instance of GRILO exception
+        /// </summary>
+        /// <param name="message">Error message to use while creating a new instance of the exception</param>
+        /// <param name="innerException">Inner exception to use</param>
+        public GRILOException(string message, Exception innerException) :
+            base("Internal bootloader error: " + message, innerException)
+        { }
     }
 }
diff --git a/GRILO.Bootloader/GRILOPlatform.cs b/GRILO.Bootloader/GRILOPlatform.cs
@@ -26,6 +26,9 @@
 
 namespace GRILO.Bootloader
 {
+    /// <summary>
+    /// Platform helpers
+    /// </summary>
     public static class GRILOPlatform
     {
 		/// <summary>