Skip to content

Commit

Permalink
Corrected RecordStateChange parameter and missing typename explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
lyndon-unity committed Dec 5, 2024
1 parent 62e025a commit 1c08e03
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ public unsafe Record RecordStateChange(InputControl control, InputEventPtr event
/// Record a state change for a specific control.
/// </summary>
/// <param name="control">The control to record the state change for.</param>
/// <param name="eventPtr">The current event data to record.</param>
/// <param name="statePtr">The current state data to record.</param>
/// <param name="time">Time stamp to apply (overriding the event timestamp)</param>
/// <returns>The newly added record.</returns>
/// <remarks>
Expand Down Expand Up @@ -841,7 +841,7 @@ internal Record(InputStateHistory owner, int index, RecordHeader* header)
/// <summary>
/// Returns value from the control in the Record.
/// </summary>
/// <typeparam name="TValue"></typeparam>
/// <typeparam name="TValue">The type of the value being read</typeparam>
/// <returns>Returns value from the Record.</returns>
/// <exception cref="InvalidOperationException">When the record is no longer value or the specified type is not present.</exception>
public TValue ReadValue<TValue>()
Expand Down Expand Up @@ -1025,6 +1025,7 @@ public override string ToString()
/// <summary>
/// Records value changes of a given control over time.
/// </summary>
/// <typeparam name="TValue">The type of the record being stored</typeparam>
/// <remarks>
/// This class makes it easy to track input values over time. It will automatically retain input state up to a given
/// maximum history depth (<see cref="InputStateHistory.historyDepth"/>). When the history is full, it will start overwriting the oldest
Expand All @@ -1033,7 +1034,6 @@ public override string ToString()
/// The class listens to changes on the given controls by adding change monitors (<see cref="IInputStateChangeMonitor"/>)
/// to each control.
/// </remarks>
/// <typeparam name="TValue"></typeparam>
public class InputStateHistory<TValue> : InputStateHistory, IReadOnlyList<InputStateHistory<TValue>.Record>
where TValue : struct
{
Expand Down

0 comments on commit 1c08e03

Please sign in to comment.