-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add missing KeyType documentation #2783
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e9c2848
Start updating method docs
jwood803 e7b649d
Merge branch 'master' into keytype-documentation
jwood803 df5da3e
Add doc comments to KeyType
jwood803 ff3784c
Merge branch 'master' into keytype-documentation
jwood803 24ae1a7
Updating for PR feedback
jwood803 657cadd
Update XML docs for PR feedback
jwood803 File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -59,6 +59,13 @@ public static bool IsValidDataType(Type type) | |
/// </summary> | ||
public ulong Count { get; } | ||
|
||
/// <summary> | ||
/// Determine if this <see cref="KeyType"/> object is equal to another <see cref="DataViewType"/> instance. | ||
/// Checks if the other item is the type of <see cref="KeyType"/>, if the RawType | ||
/// is the same, and if the Count is the same. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Similar notes on |
||
/// </summary> | ||
/// <param name="other">The other object to compare against.</param> | ||
/// <returns><see langword="true" /> if both objects are equal, otherwise <see langword="false"/>.</returns> | ||
public override bool Equals(DataViewType other) | ||
{ | ||
if (other == this) | ||
|
@@ -73,16 +80,31 @@ public override bool Equals(DataViewType other) | |
return true; | ||
} | ||
|
||
/// <summary> | ||
/// Determine if a <see cref="KeyType"/> instance is equal to another <see cref="KeyType"/> instance. | ||
/// Checks if any object is the type of <see cref="KeyType"/>, if the RawType | ||
/// is the same, and if the Count is the same. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you use the |
||
/// </summary> | ||
/// <param name="other">The other object to compare against.</param> | ||
/// <returns><see langword="true" /> if both objects are equal, otherwise <see langword="false"/>.</returns> | ||
public override bool Equals(object other) | ||
{ | ||
return other is DataViewType tmp && Equals(tmp); | ||
} | ||
|
||
/// <summary> | ||
/// Retrieves the hash code. | ||
/// </summary> | ||
/// <returns>An integer representing the hash code.</returns> | ||
public override int GetHashCode() | ||
{ | ||
return Hashing.CombinedHash(RawType.GetHashCode(), Count); | ||
} | ||
|
||
/// <summary> | ||
/// The string representation of the <see cref="KeyType"/>. | ||
/// </summary> | ||
/// <returns>A formatted string.</returns> | ||
public override string ToString() | ||
{ | ||
InternalDataKind rawKind = this.GetRawKind(); | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, could you use the
<see
tag forRawType
?