GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

Refactor old code documentation

Browse Source
This commit is contained in:
Wojtek Figat
2024-09-24 18:20:12 +02:00
parent f817448839
commit da203352fd
29 changed files with 424 additions and 1124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Source/Engine/Core/Math/Ray.h
View File

@@ -82,7 +82,7 @@ public:
Vector3 GetPoint(Real distance) const;
/// <summary>
/// Determines if there is an intersection between the current object and a point.
/// Determines if there is an intersection between ray and a point.
/// </summary>
/// <param name="point">The point to test.</param>
/// <returns>Whether the two objects intersected.</returns>
@@ -92,7 +92,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="Ray" />.
/// Determines if there is an intersection between two rays.
/// </summary>
/// <param name="ray">The ray to test.</param>
/// <returns>Whether the two objects intersected.</returns>
@@ -103,7 +103,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="Ray" />.
/// Determines if there is an intersection between ray and a <see cref="Ray" />.
/// </summary>
/// <param name="ray">The ray to test.</param>
/// <param name="point">When the method completes, contains the point of intersection, or <see cref="Vector3.Zero" /> if there was no intersection.
@@ -115,7 +115,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="Plane" />.
/// Determines if there is an intersection between ray and a <see cref="Plane" />.
/// </summary>
/// <param name="plane">The plane to test</param>
/// <returns>Whether the two objects intersected.</returns>
@@ -126,7 +126,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="Plane" />.
/// Determines if there is an intersection between ray and a <see cref="Plane" />.
/// </summary>
/// <param name="plane">The plane to test.</param>
/// <param name="distance">When the method completes, contains the distance of the intersection, or 0 if there was no intersection.</param>
@@ -137,7 +137,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="Plane" />.
/// Determines if there is an intersection between ray and a <see cref="Plane" />.
/// </summary>
/// <param name="plane">The plane to test.</param>
/// <param name="point">When the method completes, contains the point of intersection, or <see cref="Vector3.Zero" /> if there was no intersection.</param>
@@ -148,7 +148,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a triangle.
/// Determines if there is an intersection between ray and a triangle.
/// </summary>
/// <param name="vertex1">The first vertex of the triangle to test.</param>
/// <param name="vertex2">The second vertex of the triangle to test.</param>
@@ -161,7 +161,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a triangle.
/// Determines if there is an intersection between ray and a triangle.
/// </summary>
/// <param name="vertex1">The first vertex of the triangle to test.</param>
/// <param name="vertex2">The second vertex of the triangle to test.</param>
@@ -174,7 +174,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a triangle.
/// Determines if there is an intersection between ray and a triangle.
/// </summary>
/// <param name="vertex1">The first vertex of the triangle to test.</param>
/// <param name="vertex2">The second vertex of the triangle to test.</param>
@@ -187,7 +187,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="BoundingBox" />.
/// Determines if there is an intersection between ray and a <see cref="BoundingBox" />.
/// </summary>
/// <param name="box">The box to test.</param>
/// <returns>Whether the two objects intersected.</returns>
@@ -198,7 +198,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="BoundingBox" />.
/// Determines if there is an intersection between ray and a <see cref="BoundingBox" />.
/// </summary>
/// <param name="box">The box to test.</param>
/// <param name="distance">When the method completes, contains the distance of the intersection, or 0 if there was no intersection.</param>
@@ -209,7 +209,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="BoundingBox" />.
/// Determines if there is an intersection between ray and a <see cref="BoundingBox" />.
/// </summary>
/// <param name="box">The box to test.</param>
/// <param name="point">When the method completes, contains the point of intersection, or <see cref="Vector3.Zero" /> if there was no intersection.</param>
@@ -220,7 +220,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="BoundingSphere" />.
/// Determines if there is an intersection between ray and a <see cref="BoundingSphere" />.
/// </summary>
/// <param name="sphere">The sphere to test.</param>
/// <returns>Whether the two objects intersected.</returns>
@@ -231,7 +231,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="BoundingSphere" />.
/// Determines if there is an intersection between ray and a <see cref="BoundingSphere" />.
/// </summary>
/// <param name="sphere">The sphere to test.</param>
/// <param name="distance">When the method completes, contains the distance of the intersection, or 0 if there was no intersection.</param>
@@ -242,7 +242,7 @@ public:
}
/// <summary>
/// Determines if there is an intersection between the current object and a <see cref="BoundingSphere" />.
/// Determines if there is an intersection between ray and a <see cref="BoundingSphere" />.
/// </summary>
/// <param name="sphere">The sphere to test.</param>
/// <param name="point">When the method completes, contains the point of intersection, or <see cref="Vector3.Zero" /> if there was no intersection.</param>