Skip to content
This repository has been archived by the owner on Feb 11, 2024. It is now read-only.

Commit

Permalink
Cleanup and documentation: Scripts/Core/CSG/Edge.cs
Browse files Browse the repository at this point in the history
  • Loading branch information
Henry00IS committed Nov 4, 2018
1 parent b9d77a6 commit 611962b
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions Scripts/Core/CSG/Edge.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public class Edge
/// <summary>
/// The first <see cref="Vertex"/> of the <see cref="Edge"/>.
/// </summary>
/// <value>The first vertex of the edge.</value>
public Vertex Vertex1
{
get
Expand All @@ -40,6 +41,7 @@ public Vertex Vertex1
/// <summary>
/// The last <see cref="Vertex"/> of the <see cref="Edge"/>.
/// </summary>
/// <value>The last vertex of the edge.</value>
public Vertex Vertex2
{
get
Expand All @@ -65,7 +67,7 @@ public Vector3 CenterPoint
/// </summary>
/// <param name="vertex1">The first vertex of the edge.</param>
/// <param name="vertex2">The last vertex of the edge.</param>
/// <exception cref="ArgumentNullException">
/// <exception cref="System.ArgumentNullException">
/// Thrown when <paramref name="vertex1"/> or <paramref name="vertex2"/> is null.
/// </exception>
public Edge(Vertex vertex1, Vertex vertex2)
Expand All @@ -86,7 +88,7 @@ public Edge(Vertex vertex1, Vertex vertex2)
/// </summary>
/// <param name="other">The other edge to compare this edge to.</param>
/// <returns><c>true</c> if this edge matches the other edge; otherwise, <c>false</c>.</returns>
/// <exception cref="ArgumentNullException">
/// <exception cref="System.ArgumentNullException">
/// Thrown when <paramref name="other"/> is null.
/// </exception>
public bool Matches(Edge other)
Expand Down Expand Up @@ -114,7 +116,7 @@ public bool Matches(Edge other)
/// </summary>
/// <param name="other">The other edge to check for parallelity.</param>
/// <returns><c>true</c> if both edges are parallel; otherwise, <c>false</c>.</returns>
/// <exception cref="ArgumentNullException">
/// <exception cref="System.ArgumentNullException">
/// Thrown when <paramref name="other"/> is null.
/// </exception>
public bool Parallel(Edge other)
Expand All @@ -138,7 +140,7 @@ public bool Parallel(Edge other)
/// </summary>
/// <param name="other">The other edge to check for intersection.</param>
/// <returns><c>true</c> if both edges intersect; otherwise, <c>false</c>.</returns>
/// <exception cref="ArgumentNullException">
/// <exception cref="System.ArgumentNullException">
/// Thrown when <paramref name="other"/> is null.
/// </exception>
public bool Intersects(Edge other)
Expand Down Expand Up @@ -201,7 +203,7 @@ public bool Intersects(Edge other)
/// </summary>
/// <param name="other">Other edge that may be collinear.</param>
/// <returns><c>true</c> if both edges are collinear; otherwise, <c>false</c>.</returns>
/// <exception cref="ArgumentNullException">
/// <exception cref="System.ArgumentNullException">
/// Thrown when <paramref name="other"/> is null.
/// </exception>
public bool Collinear(Edge other)
Expand Down

0 comments on commit 611962b

Please sign in to comment.