Added lots of comments and changed access level for some methods.

Author: DavidF-Dev

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added Color as a supported parameter type.
 - Added command: "colour" - displays the provided colour in the developer console.
 - Changed DevConsole.InvokeCoroutine method to return the Coroutine instance.
+- Changed some method access levels from internal to public.
 - Fixed Unity logs from other threads not showing in the developer console log.
 - Fixed generic or nullable parameter types not having their type displayed nicely.
 - Fixed log scroll view not snapping to bottom intuitively.

Runtime/Command.cs

@@ -149,7 +149,9 @@ internal static Command Create(DevConsoleCommandAttribute commandAttribute, Meth
 
         #region Constructors
 
-        private Command() { }
+        private Command()
+        {
+        }
 
         #endregion
 
@@ -158,17 +160,22 @@ private Command() { }
         /// <summary>
         ///     Name of the command.
         /// </summary>
-        internal string Name { get; private set; }
+        public string Name { get; private set; }
 
         /// <summary>
-        ///     Optional command names.
+        ///     Description of the command.
         /// </summary>
-        internal string[] Aliases { get; private set; }
+        public string HelpText { get; private set; }
 
         /// <summary>
-        ///     Description of the command.
+        ///     Whether the command is a custom command (not a built-in command).
         /// </summary>
-        internal string HelpText { get; private set; }
+        public bool IsCustomCommand { get; private set; }
+
+        /// <summary>
+        ///     Optional command names.
+        /// </summary>
+        internal string[] Aliases { get; private set; }
 
         /// <summary>
         ///     Array of parameters required to execute the command.
@@ -186,11 +193,6 @@ private Command() { }
         /// </summary>
         internal Action DefaultCallback { get; private set; }
 
-        /// <summary>
-        ///     Whether the command is a custom command.
-        /// </summary>
-        internal bool IsCustomCommand { get; private set; }
-
         #endregion
 
         #region Methods
@@ -200,6 +202,62 @@ public override string ToString()
             return Name;
         }
 
+        /// <summary>
+        ///     Get the command syntax as a formatted string.
+        /// </summary>
+        /// <returns></returns>
+        public string ToFormattedString()
+        {
+            string result = GetFormattedName();
+            for (int i = 0; i < Parameters.Length; i++)
+            {
+                if (i < Parameters.Length)
+                {
+                    result += " ";
+                }
+
+                result += GetFormattedParameter(i);
+            }
+            return result;
+        }
+
+        /// <summary>
+        ///     Get the command name as a formatted string.
+        /// </summary>
+        /// <returns></returns>
+        public string GetFormattedName()
+        {
+            return $"<b>{Name}</b>";
+        }
+
+        /// <summary>
+        ///     Get a parameter as a formatted string.
+        /// </summary>
+        /// <param name="parameterIndex"></param>
+        /// <returns></returns>
+        public string GetFormattedParameter(int parameterIndex)
+        {
+            return Parameters[parameterIndex].ToFormattedString();
+        }
+
+        /// <summary>
+        ///     Get the command aliases.
+        /// </summary>
+        /// <returns></returns>
+        public IReadOnlyList<string> GetAliases()
+        {
+            return Aliases;
+        }
+
+        /// <summary>
+        ///     Get the command parameters.
+        /// </summary>
+        /// <returns></returns>
+        public IReadOnlyList<Parameter> GetParameters()
+        {
+            return Parameters;
+        }
+
         /// <summary>
         ///     Ensure the command name is valid.
         /// </summary>
@@ -247,44 +305,6 @@ internal void SetAsCustomCommand()
             IsCustomCommand = true;
         }
 
-        /// <summary>
-        ///     Get the command name as a formatted string.
-        /// </summary>
-        /// <returns></returns>
-        internal string GetFormattedName()
-        {
-            return $"<b>{Name}</b>";
-        }
-
-        /// <summary>
-        ///     Get a parameter as a formatted string.
-        /// </summary>
-        /// <param name="parameterIndex"></param>
-        /// <returns></returns>
-        internal string GetFormattedParameter(int parameterIndex)
-        {
-            return Parameters[parameterIndex].ToFormattedString();
-        }
-
-        /// <summary>
-        ///     Get the command syntax as a formatted string.
-        /// </summary>
-        /// <returns></returns>
-        internal string ToFormattedString()
-        {
-            string result = GetFormattedName();
-            for (int i = 0; i < Parameters.Length; i++)
-            {
-                if (i < Parameters.Length)
-                {
-                    result += " ";
-                }
-
-                result += GetFormattedParameter(i);
-            }
-            return result;
-        }
-
         #endregion
     }
 }

Runtime/DevConsole.cs

@@ -91,7 +91,7 @@ public static bool IsKeyBindingsEnabled
         public static InputKey? ToggleKey
         {
             get => _console.ConsoleToggleKey;
-            set => _console.SetToggleKey(value);
+            set => _console.ConsoleToggleKey = value;
         }
 
         #endregion
@@ -160,6 +160,37 @@ public static bool RunCommand(string input)
             return _console.RunCommand(input);
         }
 
+        /// <summary>
+        ///     Get a command instance by name.
+        /// </summary>
+        /// <param name="name"></param>
+        /// <returns></returns>
+        public static Command GetCommand(string name)
+        {
+            if (string.IsNullOrEmpty(name))
+            {
+                throw new ArgumentNullException(nameof(name));
+            }
+
+            return _console.GetCommand(name);
+        }
+
+        /// <summary>
+        ///     Get a command instance by name.
+        /// </summary>
+        /// <param name="name"></param>
+        /// <param name="command"></param>
+        /// <returns></returns>
+        public static bool GetCommand(string name, out Command command)
+        {
+            if (string.IsNullOrEmpty(name))
+            {
+                throw new ArgumentNullException(nameof(name));
+            }
+
+            return _console.GetCommand(name, out command);
+        }
+
         /// <summary>
         ///     Add a parameter type to the dev console database.
         ///     This will allow the provided type to be used as a parameter in commands.
@@ -289,7 +320,7 @@ public static void LogCommand(string name)
         /// <param name="toggleKey"></param>
         public static void SetToggleKey(InputKey? toggleKey)
         {
-            _console.SetToggleKey(toggleKey);
+            _console.ConsoleToggleKey = toggleKey;
         }
 
         /// <summary>