Update documentation comments

Author: adamgraham

Runtime/NavigationStack.cs

@@ -6,8 +6,9 @@
 namespace Zigurous.UI
 {
     /// <summary>
-    /// Keeps track of a stack of selected game objects as to allow for easy
-    /// back navigation.
+    /// Manages a stack of game objects for menu navigation purposes. This is
+    /// especially useful to handle backwards navigation by simply popping off
+    /// the last item in the stack.
     /// </summary>
     [RequireComponent(typeof(EventSystem))]
     [AddComponentMenu("Zigurous/UI/Navigation/Navigation Stack")]
@@ -29,10 +30,10 @@ public class NavigationStack : MonoBehaviour
         public GameObject Top => this.items.Count > 0 ? this.items.Peek() : null;
 
         /// <summary>
-        /// The input action to handle navigating backwards in the stack by
-        /// popping items off.
+        /// The input action that handles backwards navigation by popping items
+        /// off the stack.
         /// </summary>
-        [Tooltip("The input action to handle navigating backwards in the stack by popping items off.")]
+        [Tooltip("The input action that handles backwards navigation by popping items off the stack.")]
         public InputAction backNavigationInput = new InputAction("MenuBackNavigation", InputActionType.Button);
 
         /// <summary>
@@ -92,6 +93,11 @@ private void OnDisable()
             this.backNavigationInput.Disable();
         }
 
+        /// <summary>
+        /// Pushes a game object onto the stack, effectively navigating
+        /// forwards.
+        /// </summary>
+        /// <param name="selected">The game object to push onto the stack.</param>
         public void Push(GameObject selected)
         {
             if (selected != null || this.allowNullSelections)
@@ -105,16 +111,23 @@ public void Push(GameObject selected)
             }
         }
 
-        public void Back()
+        /// <summary>
+        /// Pops the last game object off the stack, effectively navigating
+        /// backwards.
+        /// </summary>
+        /// <returns>The game object that was popped off the stack.</returns>
+        public GameObject Pop()
         {
             if (this.items.Count == 0) {
-                return;
+                return null;
             }
 
+            GameObject top = null;
+
             // Pop off the top of the stack
             if (this.items.Count > 1 || this.allowEmptyStack)
             {
-                GameObject top = this.items.Pop();
+                top = this.items.Pop();
 
                 if (this.setActiveState && top != null) {
                     top.SetActive(false);
@@ -134,12 +147,14 @@ public void Back()
 
                 this.eventSystem.SetSelectedGameObject(previous);
             }
+
+            return top;
         }
 
         private void OnBack(InputAction.CallbackContext context)
         {
             if (context.performed) {
-                Back();
+                Pop();
             }
         }
 

Runtime/ScrollToSelection.cs

@@ -14,12 +14,23 @@ namespace Zigurous.UI
     public class ScrollToSelection : MonoBehaviour
     {
         /// <summary>
-        /// A scroll direction type.
+        /// A scroll direction.
         /// </summary>
         public enum ScrollDirection
         {
+            /// <summary>
+            /// Scrolls in the y-axis.
+            /// </summary>
             Vertical,
+
+            /// <summary>
+            /// Scrolls in the x-axis.
+            /// </summary>
             Horizontal,
+
+            /// <summary>
+            /// Scrolls in both the x-axis and the y-axis.
+            /// </summary>
             Both,
         }
 
@@ -36,8 +47,8 @@ public enum ScrollDirection
         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
+        /// Whether the ScrollRect is currently being scrolled manually. This
+        /// allows the user to freely scroll with the mouse even when a child
         /// element is selected.
         /// </summary>
         public bool manualScrolling { get; private set; }