Merge pull request #38 from eviltwo/add-summary

Add summary

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/Display/DisplayGlyphTextureGenerator.cs

@@ -13,6 +13,9 @@ public static class DisplayGlyphTextureGenerator
     {
         private static List<Texture2D> _textureBuffer = new List<Texture2D>();
 
+        /// <summary>
+        /// Generates glyph texture for the specified inputLayoutPaths and writes it to the texture. The glyph textures are arranged according to the layout.
+        /// </summary>
         public static bool GenerateGlyphTexture(Texture2D texture, IReadOnlyList<InputDevice> activeDevices, IReadOnlyList<string> inputLayoutPaths, GlyphsLayout layout)
         {
             if (texture == null)

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/IInputGlyphLoader.cs

@@ -7,6 +7,13 @@ namespace InputGlyphs
 {
     public interface IInputGlyphLoader
     {
+        /// <summary>
+        /// Load glyphs for the given device and layout path and writes it to texture.
+        /// </summary>
+        /// <param name="texture">Texture onto which glyphs are written.</param>
+        /// <param name="activeDevices">Active devices</param>
+        /// <param name="inputLayoutPath">example: &lt;gamepad&gt;/dpad/left</param>
+        /// <returns>Return true if the load was success.</returns>
         bool LoadGlyph(Texture2D texture, IReadOnlyList<InputDevice> activeDevices, string inputLayoutPath);
     }
 }

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/InputGlyphManager.cs

@@ -5,6 +5,10 @@
 
 namespace InputGlyphs
 {
+    /// <summary>
+    /// Manages GlyphLoaders and load Glyph images from registered GlyphLoaders.
+    /// Register GlyphLoaders when you start the game.
+    /// </summary>
     public static class InputGlyphManager
     {
         private static List<IInputGlyphLoader> _loaders = new List<IInputGlyphLoader>();

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/Loaders/Gamepad/GamepadGlyphInitializer.cs

@@ -18,8 +18,15 @@ public class GamepadGlyphInitializer : MonoBehaviour
         [SerializeField]
         private InputGlyphTextureMap _switchProControllerTextureMap = null;
 
+        private static bool _initialized;
+
         private void Awake()
         {
+            if (_initialized)
+            {
+                return;
+            }
+
             var gamepadGlyphLoader = new GamepadGlyphLoader(
                 _fallbackTextureMap,
                 _xboxTextureMap,

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/Loaders/Utils/DeviceGlyphLoader.cs

@@ -6,6 +6,10 @@
 
 namespace InputGlyphs.Loaders.Utils
 {
+    /// <summary>
+    /// General implementation of the <see cref="IInputGlyphLoader"/>.
+    /// It is recommended to use the <see cref="DeviceGlyphLoaderInitializer{T}"/> to generate the loader instead of inheriting and implementing this class.
+    /// </summary>
     public class DeviceGlyphLoader<T> : IInputGlyphLoader
         where T : InputDevice
     {

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/Loaders/Utils/DeviceGlyphLoaderInitializer.cs

@@ -4,6 +4,10 @@
 
 namespace InputGlyphs.Loaders.Utils
 {
+    /// <summary>
+    /// A general initialization class that creates glyph loader for various <see cref="InputDevice"/>, handles the transfer of <see cref="InputGlyphTextureMap"/>, and registers loader with the Manager.
+    /// If you want to easily create a glyph loader for custom devices, it is recommended to inherit from this class.
+    /// </summary>
     public class DeviceGlyphLoaderInitializer<T> : MonoBehaviour
         where T : InputDevice
     {

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/Loaders/Utils/InputGlyphTextureMap.cs

@@ -2,6 +2,9 @@
 
 namespace InputGlyphs.Loaders.Utils
 {
+    /// <summary>
+    /// A map that associates control paths of input devices with glyph textures.
+    /// </summary>
     [CreateAssetMenu(fileName = "InputGlyphTextureMap", menuName = "InputGlyphs/InputGlyphTextureMap")]
     public class InputGlyphTextureMap : ScriptableObject
     {

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/Utils/GlyphTextureUtility.cs

@@ -5,6 +5,12 @@ namespace InputGlyphs.Utils
 {
     public static class GlyphTextureUtility
     {
+        /// <summary>
+        /// Combines multiple textures into a single texture arranged in a horizontal row.
+        /// </summary>
+        /// <param name="texture">texture to write the results to.</param>
+        /// <param name="sourceTextures">Original textures. They can be of different sizes.</param>
+        /// <returns>Return true if the load was success.</returns>
         public static bool MergeTexturesHorizontal(Texture2D texture, IReadOnlyList<Texture2D> sourceTextures)
         {
             var width = 0;

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/Utils/InputActionRebindingExtensions.cs

@@ -7,6 +7,10 @@ namespace InputGlyphs.Utils
 {
     public static class InputActionRebindingExtensions
     {
+        /// <summary>
+        /// Gets the indexes of all bindings in the action's bindings that match the specified binding mask.
+        /// This function just changes the number of results of <see cref="InputActionRebindingExtensions.GetBindingIndex()"/> .
+        /// </summary>
         public static void GetBindingIndexes(this InputAction action, InputBinding bindingMask, List<int> results)
         {
             results.Clear();

InputGlyphs/Assets/InputGlyphs/Scripts/Runtime/Utils/InputLayoutPathUtility.cs

@@ -41,6 +41,12 @@ public static string GetLocalPath(string inputLayoutPath)
             return _stringBuilder.ToString();
         }
 
+        /// <summary>
+        /// Searches for bindings within actions that match the control scheme and returns the effective paths.
+        /// </summary>
+        /// <param name="action">Target action</param>
+        /// <param name="controlScheme">Control scheme for masks</param>
+        /// <param name="results">Effective paths of detected bindings</param>
         public static bool TryGetActionBindingPath(InputAction action, string controlScheme, List<string> results)
         {
             results.Clear();