Skip to content

Commit

Permalink
Addressed more docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ekcoh committed Dec 11, 2024
1 parent e81fdd5 commit aa4b6c0
Showing 1 changed file with 8 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public struct Touch : IEquatable<Touch>
public Finger finger => m_Finger;

/// <summary>
/// Current phase of the touch.
/// The current touch phase of the touch indicating its current state in the phase cycle.
/// </summary>
/// <remarks>
/// Every touch goes through a predefined cycle that starts with <see cref="TouchPhase.Began"/>,
Expand Down Expand Up @@ -308,7 +308,7 @@ public bool isInProgress
ref *(ExtraDataPerTouchState*)m_TouchRecord.GetUnsafeExtraMemoryPtr();

/// <summary>
/// History for this specific touch.
/// History touch readings for this specific touch contact.
/// </summary>
/// <remarks>
/// Unlike <see cref="Finger.touchHistory"/>, this gives the history of this touch only.
Expand Down Expand Up @@ -581,7 +581,12 @@ public override string ToString()
return $"{{id={touchId} finger={finger.index} phase={phase} position={screenPosition} delta={delta} time={time}}}";
}

/// <inheritdoc/>
/// <summary>
/// Compares this touch for equality with another instance <paramref name="other"/>.
/// </summary>
/// <param name="other">The other instance to compare with.</param>
/// <returns><c>true</c> if this touch and <paramref name="other"/> represents the same finger and maps to the
/// same touch record, otherwise <c>false</c></returns>
public bool Equals(Touch other)
{
return Equals(m_Finger, other.m_Finger) && m_TouchRecord.Equals(other.m_TouchRecord);
Expand Down

0 comments on commit aa4b6c0

Please sign in to comment.