Skip to content

Commit 7611d03

Browse files
committed
xmldoc fixes
1 parent 5497481 commit 7611d03

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ public InputAction action
7171
/// case the reference is reset to its default state which does not reference an action.</param>
7272
/// <exception cref="InvalidOperationException"><paramref name="action"/> is not contained in an
7373
/// <see cref="InputActionMap"/> that is itself contained in an <see cref="InputActionAsset"/>.</exception>
74+
/// <exception cref="InvalidOperationException">If attempting to mutate a reference object
75+
/// that is backed by an .inputactions asset. This is not allowed to prevent side-effects.</exception>
7476
public void Set(InputAction action)
7577
{
7678
if (action == null)
@@ -101,6 +103,8 @@ public void Set(InputAction action)
101103
/// <exception cref="ArgumentNullException"><paramref name="asset"/> is <c>null</c> -or-
102104
/// <paramref name="mapName"/> is <c>null</c> or empty -or- <paramref name="actionName"/>
103105
/// is <c>null</c> or empty.</exception>
106+
/// <exception cref="InvalidOperationException">If attempting to mutate a reference object
107+
/// that is backed by by .inputactions asset. This is not allowed to prevent side-effects.</exception>
104108
/// <exception cref="ArgumentException">No action map called <paramref name="mapName"/> could
105109
/// be found in <paramref name="asset"/> -or- no action called <paramref name="actionName"/>
106110
/// could be found in the action map called <paramref name="mapName"/> in <paramref name="asset"/>.</exception>
@@ -234,6 +238,7 @@ internal void Invalidate()
234238
/// <summary>
235239
/// Equivalent to <see cref="InputActionReference.action"/>.
236240
/// </summary>
241+
/// <returns>The associated action reference if its a valid reference, else <c>null</c>.</returns>
237242
public InputAction ToInputAction()
238243
{
239244
return action;

0 commit comments

Comments
 (0)