Skip to content

Commit 1c08e03

Browse files
committed
Corrected RecordStateChange parameter and missing typename explanation
1 parent 62e025a commit 1c08e03

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Packages/com.unity.inputsystem/InputSystem/State/InputStateHistory.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ public unsafe Record RecordStateChange(InputControl control, InputEventPtr event
388388
/// Record a state change for a specific control.
389389
/// </summary>
390390
/// <param name="control">The control to record the state change for.</param>
391-
/// <param name="eventPtr">The current event data to record.</param>
391+
/// <param name="statePtr">The current state data to record.</param>
392392
/// <param name="time">Time stamp to apply (overriding the event timestamp)</param>
393393
/// <returns>The newly added record.</returns>
394394
/// <remarks>
@@ -841,7 +841,7 @@ internal Record(InputStateHistory owner, int index, RecordHeader* header)
841841
/// <summary>
842842
/// Returns value from the control in the Record.
843843
/// </summary>
844-
/// <typeparam name="TValue"></typeparam>
844+
/// <typeparam name="TValue">The type of the value being read</typeparam>
845845
/// <returns>Returns value from the Record.</returns>
846846
/// <exception cref="InvalidOperationException">When the record is no longer value or the specified type is not present.</exception>
847847
public TValue ReadValue<TValue>()
@@ -1025,6 +1025,7 @@ public override string ToString()
10251025
/// <summary>
10261026
/// Records value changes of a given control over time.
10271027
/// </summary>
1028+
/// <typeparam name="TValue">The type of the record being stored</typeparam>
10281029
/// <remarks>
10291030
/// This class makes it easy to track input values over time. It will automatically retain input state up to a given
10301031
/// maximum history depth (<see cref="InputStateHistory.historyDepth"/>). When the history is full, it will start overwriting the oldest
@@ -1033,7 +1034,6 @@ public override string ToString()
10331034
/// The class listens to changes on the given controls by adding change monitors (<see cref="IInputStateChangeMonitor"/>)
10341035
/// to each control.
10351036
/// </remarks>
1036-
/// <typeparam name="TValue"></typeparam>
10371037
public class InputStateHistory<TValue> : InputStateHistory, IReadOnlyList<InputStateHistory<TValue>.Record>
10381038
where TValue : struct
10391039
{

0 commit comments

Comments
 (0)