Skip to content

Commit 2a7a882

Browse files
committed
Fixed xml doc errors
1 parent 9b79f98 commit 2a7a882

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

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

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1368,15 +1368,15 @@ public unsafe bool WasPerformedThisFrame()
13681368
/// </summary>
13691369
/// <returns>True if the action completed this frame.</returns>
13701370
/// <remarks>
1371+
/// <para>
13711372
/// Although <see cref="InputActionPhase.Disabled"/> is technically a phase, this method does not consider disabling
13721373
/// the action while the action is in <see cref="InputActionPhase.Performed"/> to be "completed".
1373-
///
1374+
/// </para>
13741375
/// <para>
13751376
/// This method is different from <see cref="WasReleasedThisFrame"/> in that it depends directly on the
13761377
/// interaction(s) driving the action (including the default interaction if no specific interaction
13771378
/// has been added to the action or binding).
13781379
/// </para>
1379-
///
13801380
/// <para>
13811381
/// For example, let's say the action is bound to the space bar and that the binding has a
13821382
/// <see cref="Interactions.HoldInteraction"/> assigned to it. In the frame where the space bar
@@ -1389,7 +1389,6 @@ public unsafe bool WasPerformedThisFrame()
13891389
/// will be true for one frame as it meets the duration threshold. Once released, <c>WasCompletedThisFrame</c> will be true
13901390
/// (because the action is no longer performed) and only in the frame where the hold transitioned away from Performed.
13911391
/// </para>
1392-
///
13931392
/// <para>
13941393
/// For another example where the action could be considered pressed but also completed, let's say the action
13951394
/// is bound to the thumbstick and that the binding has a Sector interaction from the XR Interaction Toolkit assigned
@@ -1408,6 +1407,14 @@ public unsafe bool WasPerformedThisFrame()
14081407
/// state, this property will stay true for the duration of the current frame (that is, until the next
14091408
/// <see cref="InputSystem.Update"/> runs) as long as the action was completed at least once.
14101409
/// </para>
1410+
/// <para>
1411+
/// This method will disregard whether the action is currently enabled or disabled. It will keep returning
1412+
/// true for the duration of the frame even if the action was subsequently disabled in the frame.
1413+
/// </para>
1414+
/// <para>
1415+
/// The meaning of "frame" is either the current "dynamic" update (<c>MonoBehaviour.Update</c>) or the current
1416+
/// fixed update (<c>MonoBehaviour.FixedUpdate</c>) depending on the value of the <see cref="InputSettings.updateMode"/> setting.
1417+
/// </para>
14111418
/// </remarks>
14121419
/// <example>
14131420
/// <code>
@@ -1418,14 +1425,6 @@ public unsafe bool WasPerformedThisFrame()
14181425
/// StopTeleport();
14191426
/// </code>
14201427
/// </example>
1421-
/// <para>
1422-
/// This method will disregard whether the action is currently enabled or disabled. It will keep returning
1423-
/// true for the duration of the frame even if the action was subsequently disabled in the frame.
1424-
/// </para>
1425-
/// <para>
1426-
/// The meaning of "frame" is either the current "dynamic" update (<c>MonoBehaviour.Update</c>) or the current
1427-
/// fixed update (<c>MonoBehaviour.FixedUpdate</c>) depending on the value of the <see cref="InputSettings.updateMode"/> setting.
1428-
/// </para>
14291428
/// <seealso cref="WasPerformedThisFrame"/>
14301429
/// <seealso cref="WasReleasedThisFrame"/>
14311430
/// <seealso cref="phase"/>
@@ -1801,9 +1800,11 @@ internal int BindingIndexOnMapToBindingIndexOnAction(int indexOfBindingOnMap)
18011800
/// Information provided to action callbacks about what triggered an action.
18021801
/// </summary>
18031802
/// <remarks>
1803+
/// <para>
18041804
/// The callback context represents the current state of an <see cref="action"/> associated with the callback
18051805
/// and provides information associated with the bound <see cref="control"/>, its value, and its
18061806
/// <see cref="phase"/>.
1807+
/// </para>
18071808
/// <para>
18081809
/// The callback context provides you with a way to consume events (push-based input) as part of an update when using
18091810
/// input action callback notifications. For example, <see cref="InputAction.started"/>,
@@ -2108,10 +2109,12 @@ public unsafe double startTime
21082109
/// Size of values returned by <see cref="ReadValue(void*,int)"/> in bytes.
21092110
/// </summary>
21102111
/// <remarks>
2112+
/// <para>
21112113
/// All input values passed around by the system are required to be "blittable",
21122114
/// i.e. they cannot contain references, cannot be heap objects themselves, and
21132115
/// must be trivially mem-copyable. This means that any value can be read out
21142116
/// and retained in a raw byte buffer.
2117+
/// </para>
21152118
/// <para>
21162119
/// The value of this property determines how many bytes will be written
21172120
/// by <see cref="ReadValue(void*,int)"/>.

0 commit comments

Comments
 (0)