Documentation bash (#1607)

* FIX: Added missing API documentation to InputAction.cs, InputActionAsset.cs, InputActionMap.cs, InputActionSetupExtensions.cs, InputSystem.cs, InputUpdateType.cs.

Co-authored-by: Håkan Sidenvall <[email protected]>
Co-authored-by: James McGill <[email protected]>
Co-authored-by: James McGill <[email protected]>

Author: 3 people

Packages/com.unity.inputsystem/InputSystem/Actions/InputAction.cs

@@ -917,6 +917,11 @@ public InputAction Clone()
             return clone;
         }
 
+        /// <summary>
+        /// Return an boxed instance of the action.
+        /// </summary>
+        /// <returns>An boxed clone of the action</returns>
+        /// <seealso cref="Clone"/>
         object ICloneable.Clone()
         {
             return Clone();

Packages/com.unity.inputsystem/InputSystem/Actions/InputActionAsset.cs

@@ -833,7 +833,7 @@ public bool Contains(InputAction action)
         /// <summary>
         /// Enumerate all actions in the asset.
         /// </summary>
-        /// <returns>Enumerate over all actions in the asset.</returns>
+        /// <returns>An enumerator going over the actions in the asset.</returns>
         /// <remarks>
         /// Actions will be enumerated one action map in <see cref="actionMaps"/>
         /// after the other. The actions from each map will be yielded in turn.
@@ -855,6 +855,11 @@ public IEnumerator<InputAction> GetEnumerator()
             }
         }
 
+        /// <summary>
+        /// Enumerate all actions in the asset.
+        /// </summary>
+        /// <returns>An enumerator going over the actions in the asset.</returns>
+        /// <seealso cref="GetEnumerator"/>
         IEnumerator IEnumerable.GetEnumerator()
         {
             return GetEnumerator();

Packages/com.unity.inputsystem/InputSystem/Actions/InputActionMap.cs

@@ -313,6 +313,9 @@ public event Action<InputAction.CallbackContext> actionTriggered
             remove => m_ActionCallbacks.RemoveCallback(value);
         }
 
+        /// <summary>
+        /// Construct an action map with default values.
+        /// </summary>
         public InputActionMap()
         {
         }
@@ -431,6 +434,7 @@ private int FindActionIndex(Guid id)
         /// </summary>
         /// <param name="actionNameOrId">Name (as in <see cref="InputAction.name"/>) or ID (as in <see cref="InputAction.id"/>)
         /// of the action. Note that matching of names is case-insensitive.</param>
+        /// <param name="throwIfNotFound">If set to <see langword="true"/> will cause an exception to be thrown when the action was not found.</param>
         /// <returns>The action with the given name or ID or <c>null</c> if no matching action
         /// was found.</returns>
         /// <exception cref="ArgumentNullException"><paramref name="actionNameOrId"/> is <c>null</c>.</exception>
@@ -611,6 +615,11 @@ public InputActionMap Clone()
             return clone;
         }
 
+        /// <summary>
+        /// Return an boxed instance of the action map.
+        /// </summary>
+        /// <returns>An boxed clone of the action map</returns>
+        /// <seealso cref="Clone"/>
         object ICloneable.Clone()
         {
             return Clone();
@@ -658,6 +667,11 @@ public IEnumerator<InputAction> GetEnumerator()
             return actions.GetEnumerator();
         }
 
+        /// <summary>
+        /// Enumerate the actions in the map.
+        /// </summary>
+        /// <returns>An enumerator going over the actions in the map.</returns>
+        /// <seealso cref="GetEnumerator"/>
         IEnumerator IEnumerable.GetEnumerator()
         {
             return GetEnumerator();