oliverbooth/VpSharp
1
0
Fork 0
mirror of https://github.com/oliverbooth/VpSharp synced 2024-11-09 22:55:42 +00:00
Code Issues Wiki

Add xmldoc to operators in Coordinates

Browse Source
This commit is contained in:
Oliver Booth 2022-11-29 18:46:56 +00:00
parent ff088a9870
commit e656436519
No known key found for this signature in database
GPG Key ID: 32A00B35503AF634
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
VpSharp/src/Coordinates.cs
View File

@ -1,4 +1,4 @@
namespace VpSharp;
namespace VpSharp;
/// <summary>
/// Represents a set of coordinates.
@ -79,11 +79,27 @@ public readonly partial struct Coordinates : IEquatable<Coordinates>
/// <value>The Z coordinate.</value>
public double Z { get; init; }
public static bool operator ==(Coordinates left, Coordinates right) =>
left.Equals(right);
/// <summary>
/// Returns a value indicating whether two instances of <see cref="Coordinates" /> are equal.
/// </summary>
/// <param name="left">The first instance.</param>
/// <param name="right">The second instance.</param>
/// <returns><see langword="true" /> if the two instances are equal; otherwise, <see langword="false" />.</returns>
public static bool operator ==(in Coordinates left, in Coordinates right)
{
return left.Equals(right);
}
public static bool operator !=(Coordinates left, Coordinates right) =>
!(left == right);
/// <summary>
/// Returns a value indicating whether two instances of <see cref="Coordinates" /> are not equal.
/// </summary>
/// <param name="left">The first instance.</param>
/// <param name="right">The second instance.</param>
/// <returns><see langword="true" /> if the two instances are not equal; otherwise, <see langword="false" />.</returns>
public static bool operator !=(in Coordinates left, in Coordinates right)
{
return !(left == right);
}
/// <summary>
/// Parses a coordinate string.
@ -110,7 +126,7 @@ public readonly partial struct Coordinates : IEquatable<Coordinates>
Z.Equals(other.Z) &&
Yaw.Equals(other.Yaw) &&
IsRelative.Equals(other.IsRelative) &&
string.Equals(World, other.World);
string.Equals(World, other.World, StringComparison.Ordinal);
}
/// <inheritdoc />