Skip to content

Commit

Permalink
Change xml doc comments to normal comments
Browse files Browse the repository at this point in the history
  • Loading branch information
yongyan-gh committed Feb 20, 2022
1 parent 966b7f8 commit f07f4af
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions src/Sarif/Comparers/ComparerHelpers.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,13 @@ namespace Microsoft.CodeAnalysis.Sarif.Comparers
{
internal static class ComparerExtensions
{
/// <summary>
/// Compare 2 object references. Return value 'false' presents the need to
/// compare objects values to get the final result.
/// </summary>
/// <param name="left">The first object to compare.</param>
/// <param name="right">The second object to compare.</param>
/// <param name="result">
/// Compare 2 object by references.
/// Return value 'true' presents you can get a definite compare result.
/// The out parameter 'result' presents compare result:
/// 0 if both objects are the same or both are null.
/// -1 if the first object is null and the second object is not null.
/// 1 if the first object is not null and the second object is null.
/// </param>
/// <returns>Return true if you can get a definite compare result, otherwise return false.</returns>
/// Return value 'false' presents the need to compare objects other properties to get the final result.
public static bool TryReferenceCompares(this object left, object right, out int result)
{
result = 0;
Expand Down

0 comments on commit f07f4af

Please sign in to comment.