Skip to content

Commit

Permalink
Added XML remarks to the HashCode<T> type
Browse files Browse the repository at this point in the history
  • Loading branch information
Sergio0694 committed May 7, 2020
1 parent e8a9534 commit c9a5c4c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Microsoft.Toolkit.HighPerformance/Helpers/HashCode{T}.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ namespace Microsoft.Toolkit.HighPerformance.Helpers
/// Combines the hash code of sequences of <typeparamref name="T"/> values into a single hash code.
/// </summary>
/// <typeparam name="T">The type of values to hash.</typeparam>
/// <remarks>
/// The hash codes returned by the <see cref="Combine"/> method are only guaranteed to be repeatable for
/// the current execution session, just like with the available <see cref="HashCode"/> APIs.In other words,
/// hashing the same <see cref="ReadOnlySpan{T}"/> collection multiple times in the same process will always
/// result in the same hash code, while the same collection being hashed again from another process
/// (or another instance of the same process) is not guaranteed to result in the same final value.
/// For more info, see: https://docs.microsoft.com/en-us/dotnet/api/system.object.gethashcode#remarks.
/// </remarks>
public struct HashCode<T>
#if SPAN_RUNTIME_SUPPORT
where T : notnull
Expand Down

0 comments on commit c9a5c4c

Please sign in to comment.