Add documentation comments

Author: adamgraham

Runtime/NavigationStack.cs

@@ -5,42 +5,73 @@
 
 namespace Zigurous.UI
 {
+    /// <summary>
+    /// Keeps track of a stack of selected game objects as to allow for easy
+    /// back navigation.
+    /// </summary>
     [RequireComponent(typeof(EventSystem))]
     [AddComponentMenu("Zigurous/UI/Navigation/Navigation Stack")]
     public class NavigationStack : MonoBehaviour
     {
+        /// <summary>
+        /// The event system being tracked by the navigation stack.
+        /// </summary>
         public EventSystem eventSystem { get; private set; }
+
+        /// <summary>
+        /// The stack of game objects that have been selected.
+        /// </summary>
         public Stack<GameObject> navigationStack { get; private set; }
+
+        /// <summary>
+        /// The current selected game object at the top of the stack.
+        /// </summary>
         public GameObject CurrentSelectedGameObject => this.navigationStack.Peek();
-        public InputAction backInput;
+
+        /// <summary>
+        /// The input action to handle navigating backwards in the stack by
+        /// popping items off.
+        /// </summary>
+        [Tooltip("The input action to handle navigating backwards in the stack by popping items off.")]
+        public InputAction backNavigationInput = new InputAction("MenuBackNavigation", InputActionType.Button);
+
+        /// <summary>
+        /// Allows for all items to be popped off the stack. Often times you
+        /// want to maintain at least the root game object.
+        /// </summary>
+        [Tooltip("Allows for all items to be popped off the stack. Often times you want to maintain at least the root game object.")]
         public bool allowEmptyStack = false;
+
+        /// <summary>
+        /// Allows for null game objects to be pushed onto the stack.
+        /// </summary>
+        [Tooltip("Allows for null game objects to be pushed onto the stack.")]
         public bool allowNullSelections = false;
 
         private void Reset()
         {
-            this.backInput = new InputAction("MenuBackNavigation", InputActionType.Button);
-            this.backInput.AddBinding("<Keyboard>/escape");
-            this.backInput.AddBinding("<Keyboard>/backspace");
-            this.backInput.AddBinding("<Gamepad>/select");
-            this.backInput.AddBinding("<Gamepad>/buttonEast");
+            this.backNavigationInput = new InputAction("MenuBackNavigation", InputActionType.Button);
+            this.backNavigationInput.AddBinding("<Keyboard>/escape");
+            this.backNavigationInput.AddBinding("<Keyboard>/backspace");
+            this.backNavigationInput.AddBinding("<Gamepad>/select");
+            this.backNavigationInput.AddBinding("<Gamepad>/buttonEast");
         }
 
         private void Awake()
         {
             this.eventSystem = GetComponent<EventSystem>();
             this.navigationStack = new Stack<GameObject>(8);
+            this.backNavigationInput.performed += OnBack;
         }
 
         private void OnEnable()
         {
-            this.backInput.Enable();
-            this.backInput.performed += OnBack;
+            this.backNavigationInput.Enable();
         }
 
         private void OnDisable()
         {
-            this.backInput.Disable();
-            this.backInput.performed -= OnBack;
+            this.backNavigationInput.Disable();
         }
 
         private void Update()

Runtime/ScrollToSelection.cs

@@ -5,24 +5,61 @@
 
 namespace Zigurous.UI
 {
+    /// <summary>
+    /// Handles scrolling a ScrollRect component to the selected child element.
+    /// This is especially useful for controller support.
+    /// </summary>
     [RequireComponent(typeof(ScrollRect))]
     [AddComponentMenu("Zigurous/UI/Navigation/Scroll To Selection")]
     public class ScrollToSelection : MonoBehaviour
     {
+        /// <summary>
+        /// A scroll direction type.
+        /// </summary>
         public enum ScrollDirection
         {
             Vertical,
             Horizontal,
             Both,
         }
 
+        /// <summary>
+        /// The direction to scroll the ScrollRect.
+        /// </summary>
+        [Tooltip("The direction to scroll the ScrollRect.")]
         public ScrollDirection scrollDirection;
+
+        /// <summary>
+        /// How quickly the ScrollRect scrolls.
+        /// </summary>
+        [Tooltip("How quickly the ScrollRect scrolls.")]
         public float scrollSpeed = 10.0f;
+
+        /// <summary>
+        /// Whether the ScrollRect is currently being manually scrolled. This
+        /// allows the user to scroll freely with the mouse even when a child
+        /// element is selected.
+        /// </summary>
         public bool manualScrolling { get; private set; }
 
+        /// <summary>
+        /// The ScrollRect component being scrolled.
+        /// </summary>
         public ScrollRect scrollRect { get; private set; }
+
+        /// <summary>
+        /// The RectTransform component of the scroll rect.
+        /// </summary>
         public RectTransform scrollTransform { get; private set; }
+
+        /// <summary>
+        /// The current selected game object.
+        /// </summary>
         public GameObject selectedGameObject { get; private set; }
+
+        /// <summary>
+        /// The RectTransform of the current selected game object.
+        /// </summary>
         public RectTransform selectedTransform { get; private set; }
 
         private void Awake()

Runtime/ScrollWithInput.cs

@@ -5,12 +5,29 @@
 
 namespace Zigurous.UI
 {
+    /// <summary>
+    /// Handles scrolling a ScrollRect component with user input. This is
+    /// especially useful for controller support.
+    /// </summary>
     [RequireComponent(typeof(ScrollRect))]
     [AddComponentMenu("Zigurous/UI/Navigation/Scroll With Input")]
     public class ScrollWithInput : MonoBehaviour
     {
-        private ScrollRect _scrollRect;
-        public InputAction scrollInput;
+        /// <summary>
+        /// The ScrollRect component being scrolled.
+        /// </summary>
+        public ScrollRect scrollRect { get; private set; }
+
+        /// <summary>
+        /// The input action that handles scrolling.
+        /// </summary>
+        [Tooltip("The input action that handles scrolling.")]
+        public InputAction scrollInput = new InputAction("ScrollInput", InputActionType.Value, null, null, null, "Vector2");
+
+        /// <summary>
+        /// The sensitivity multiplier applied to the input.
+        /// </summary>
+        [Tooltip("The sensitivity multiplier applied to the input.")]
         public float sensitivity = 1.0f;
 
         private void Reset()
@@ -23,7 +40,7 @@ private void Reset()
 
         private void Awake()
         {
-            _scrollRect = GetComponent<ScrollRect>();
+            this.scrollRect = GetComponent<ScrollRect>();
         }
 
         private void OnEnable()
@@ -44,11 +61,11 @@ private void Update()
                 return;
             }
 
-            if (eventSystem.currentSelectedGameObject == _scrollRect.gameObject ||
-                eventSystem.currentSelectedGameObject.transform.parent == _scrollRect.content)
+            if (eventSystem.currentSelectedGameObject == this.scrollRect.gameObject ||
+                eventSystem.currentSelectedGameObject.transform.parent == this.scrollRect.content)
             {
                 Vector2 input = this.scrollInput.ReadValue<Vector2>();
-                _scrollRect.normalizedPosition += input * this.sensitivity * Time.unscaledDeltaTime;
+                this.scrollRect.normalizedPosition += input * this.sensitivity * Time.unscaledDeltaTime;
             }
         }