Skip to content

Commit

Permalink
Fix inline documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aalmada committed Oct 26, 2023
1 parent 0a11121 commit 0e66e8e
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 26 deletions.
12 changes: 6 additions & 6 deletions src/NetFabric.Numerics/Polar/Point.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public readonly struct Point<TAngleUnits, T>
public Angle<TAngleUnits, T> Azimuth { get; }

/// <summary>
/// Creates an instance of the current type from spherical coordinates.
/// Creates an instance of the current type from polar coordinates.
/// </summary>
/// <param name="radius">The radial distance from the origin (usually the radial distance).</param>
/// <param name="azimuth">The horizontal angle in radians with units defined by <typeparamref name="TAngleUnits"/> (often called the azimuth angle).</param>
Expand Down Expand Up @@ -332,18 +332,18 @@ public static Point<Gradians, T> ToGradians<T>(Point<Revolutions, T> point)
=> new(point.Radius, Angle.ToGradians(point.Azimuth));

/// <summary>
/// Reduces a point in spherical coordinates by applying reduction functions to its components.
/// Reduces a point in polar coordinates by applying reduction functions to its components.
/// </summary>
/// <typeparam name="TAngleUnits">The type representing angle units.</typeparam>
/// <typeparam name="T">The type used for the coordinates.</typeparam>
/// <param name="point">The input point in spherical coordinates to be reduced.</param>
/// <param name="point">The input point in polar coordinates to be reduced.</param>
/// <returns>
/// A new <see cref="PointReduced{TAngleUnits, T}"/> object with a reduced
/// azimuthal angle and polar angle, while keeping the original radius.
/// azimuthal angle, while keeping the original radius.
/// </returns>
/// <remarks>
/// The reduction process involves applying reduction functions to the azimuthal and polar angles
/// of the input spherical point. The radius component remains unchanged.
/// The reduction process involves applying reduction functions to the azimuthal angle
/// of the input polar point. The radius component remains unchanged.
/// </remarks>
public static PointReduced<TAngleUnits, T> Reduce<TAngleUnits, T>(Point<TAngleUnits, T> point)
where TAngleUnits : struct, IAngleUnits<TAngleUnits>
Expand Down
10 changes: 5 additions & 5 deletions src/NetFabric.Numerics/Polar/Vector.cs
Original file line number Diff line number Diff line change
Expand Up @@ -502,8 +502,8 @@ public static Vector<TAngleUnits, T> Negate<TAngleUnits, T>(in Vector<TAngleUnit
/// <remarks>
/// This method adds the corresponding coordinates of the two input vectors and returns
/// a new Vector with the resulting sums. The operation is performed component-wise, which
/// means that the Radius, Azimuth, Polar, and W coordinates of the resulting vector are the sums of the
/// Radius, Azimuth, Polar, and W coordinates of the input vectors, respectively. The input vectors remain
/// means that the Radius, Azimuth, and Polar coordinates of the resulting vector are the sums of the
/// Radius, Azimuth, and Polar coordinates of the input vectors, respectively. The input vectors remain
/// unchanged.
/// </remarks>
[SkipLocalsInit]
Expand All @@ -524,8 +524,8 @@ public static Vector<TAngleUnits, T> Add<TAngleUnits, T>(in Vector<TAngleUnits,
/// <remarks>
/// This method subtracts the corresponding coordinates of the second vector from the first vector
/// and returns a new Vector with the resulting differences. The operation is performed component-wise,
/// which means that the Radius, Azimuth, Polar, and W coordinates of the resulting vector are the differences of the
/// Radius, Azimuth, Polar, and W coordinates of the input vectors, respectively. The input vectors remain unchanged.
/// which means that the Radius, Azimuth, and Polar coordinates of the resulting vector are the differences of the
/// Radius, Azimuth, and Polar coordinates of the input vectors, respectively. The input vectors remain unchanged.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static Vector<TAngleUnits, T> Subtract<TAngleUnits, T>(in Vector<TAngleUnits, T> left, in Vector<TAngleUnits, T> right)
Expand All @@ -543,7 +543,7 @@ public static Vector<TAngleUnits, T> Subtract<TAngleUnits, T>(in Vector<TAngleUn
/// <returns>A new Vector that is the result of multiplying each coordinate of the input vector by the scalar value.</returns>
/// <remarks>
/// This method multiplies the specified scalar value with each coordinate of the input Vector and returns a new Vector with the resulting products.
/// The operation is performed independently on each coordinate, meaning that the scalar value is multiplied with the Radius, Azimuth, Polar, and W coordinates of the input vector separately.
/// The operation is performed independently on each coordinate, meaning that the scalar value is multiplied with the Radius, Azimuth, and Polar coordinates of the input vector separately.
/// The input vector remains unchanged after the operation.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down
10 changes: 5 additions & 5 deletions src/NetFabric.Numerics/Rectangular2D/Vector.cs
Original file line number Diff line number Diff line change
Expand Up @@ -515,8 +515,8 @@ public static Vector<T> Negate<T>(in Vector<T> right)
/// <remarks>
/// This method adds the corresponding coordinates of the two input vectors and returns
/// a new Vector with the resulting sums. The operation is performed component-wise, which
/// means that the X, Y, Z, and W coordinates of the resulting vector are the sums of the
/// X, Y, Z, and W coordinates of the input vectors, respectively. The input vectors remain
/// means that the X and Y coordinates of the resulting vector are the sums of the
/// X and Y coordinates of the input vectors, respectively. The input vectors remain
/// unchanged.
/// </remarks>
[SkipLocalsInit]
Expand All @@ -535,8 +535,8 @@ public static Vector<T> Add<T>(in Vector<T> left, in Vector<T> right)
/// <remarks>
/// This method subtracts the corresponding coordinates of the second vector from the first vector
/// and returns a new Vector with the resulting differences. The operation is performed component-wise,
/// which means that the X, Y, Z, and W coordinates of the resulting vector are the differences of the
/// X, Y, Z, and W coordinates of the input vectors, respectively. The input vectors remain unchanged.
/// which means that the X and Y coordinates of the resulting vector are the differences of the
/// X and Y coordinates of the input vectors, respectively. The input vectors remain unchanged.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static Vector<T> Subtract<T>(in Vector<T> left, in Vector<T> right)
Expand All @@ -552,7 +552,7 @@ public static Vector<T> Subtract<T>(in Vector<T> left, in Vector<T> right)
/// <returns>A new Vector that is the result of multiplying each coordinate of the input vector by the scalar value.</returns>
/// <remarks>
/// This method multiplies the specified scalar value with each coordinate of the input Vector and returns a new Vector with the resulting products.
/// The operation is performed independently on each coordinate, meaning that the scalar value is multiplied with the X, Y, Z, and W coordinates of the input vector separately.
/// The operation is performed independently on each coordinate, meaning that the scalar value is multiplied with the X and Y coordinates of the input vector separately.
/// The input vector remains unchanged after the operation.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down
10 changes: 5 additions & 5 deletions src/NetFabric.Numerics/Rectangular3D/Vector.cs
Original file line number Diff line number Diff line change
Expand Up @@ -526,8 +526,8 @@ public static Vector<T> Negate<T>(in Vector<T> right)
/// <remarks>
/// This method adds the corresponding coordinates of the two input vectors and returns
/// a new Vector with the resulting sums. The operation is performed component-wise, which
/// means that the X, Y, Z, and W coordinates of the resulting vector are the sums of the
/// X, Y, Z, and W coordinates of the input vectors, respectively. The input vectors remain
/// means that the X, Y, and Z coordinates of the resulting vector are the sums of the
/// X, Y, and Z coordinates of the input vectors, respectively. The input vectors remain
/// unchanged.
/// </remarks>
[SkipLocalsInit]
Expand All @@ -546,8 +546,8 @@ public static Vector<T> Add<T>(in Vector<T> left, in Vector<T> right)
/// <remarks>
/// This method subtracts the corresponding coordinates of the second vector from the first vector
/// and returns a new Vector with the resulting differences. The operation is performed component-wise,
/// which means that the X, Y, Z, and W coordinates of the resulting vector are the differences of the
/// X, Y, Z, and W coordinates of the input vectors, respectively. The input vectors remain unchanged.
/// which means that the X, Y, and Z coordinates of the resulting vector are the differences of the
/// X, Y, and Z coordinates of the input vectors, respectively. The input vectors remain unchanged.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static Vector<T> Subtract<T>(in Vector<T> left, in Vector<T> right)
Expand All @@ -563,7 +563,7 @@ public static Vector<T> Subtract<T>(in Vector<T> left, in Vector<T> right)
/// <returns>A new Vector that is the result of multiplying each coordinate of the input vector by the scalar value.</returns>
/// <remarks>
/// This method multiplies the specified scalar value with each coordinate of the input Vector and returns a new Vector with the resulting products.
/// The operation is performed independently on each coordinate, meaning that the scalar value is multiplied with the X, Y, Z, and W coordinates of the input vector separately.
/// The operation is performed independently on each coordinate, meaning that the scalar value is multiplied with the X, Y, and Z coordinates of the input vector separately.
/// The input vector remains unchanged after the operation.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down
10 changes: 5 additions & 5 deletions src/NetFabric.Numerics/Spherical/Vector.cs
Original file line number Diff line number Diff line change
Expand Up @@ -509,8 +509,8 @@ public static Vector<TAngleUnits, T> Negate<TAngleUnits, T>(in Vector<TAngleUnit
/// <remarks>
/// This method adds the corresponding coordinates of the two input vectors and returns
/// a new Vector with the resulting sums. The operation is performed component-wise, which
/// means that the Radius, Azimuth, Polar, and W coordinates of the resulting vector are the sums of the
/// Radius, Azimuth, Polar, and W coordinates of the input vectors, respectively. The input vectors remain
/// means that the Radius, Azimuth, and Polar coordinates of the resulting vector are the sums of the
/// Radius, Azimuth, and Polar coordinates of the input vectors, respectively. The input vectors remain
/// unchanged.
/// </remarks>
[SkipLocalsInit]
Expand All @@ -531,8 +531,8 @@ public static Vector<TAngleUnits, T> Add<TAngleUnits, T>(in Vector<TAngleUnits,
/// <remarks>
/// This method subtracts the corresponding coordinates of the second vector from the first vector
/// and returns a new Vector with the resulting differences. The operation is performed component-wise,
/// which means that the Radius, Azimuth, Polar, and W coordinates of the resulting vector are the differences of the
/// Radius, Azimuth, Polar, and W coordinates of the input vectors, respectively. The input vectors remain unchanged.
/// which means that the Radius, Azimuth, and Polar coordinates of the resulting vector are the differences of the
/// Radius, Azimuth, and Polar coordinates of the input vectors, respectively. The input vectors remain unchanged.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static Vector<TAngleUnits, T> Subtract<TAngleUnits, T>(in Vector<TAngleUnits, T> left, in Vector<TAngleUnits, T> right)
Expand All @@ -550,7 +550,7 @@ public static Vector<TAngleUnits, T> Subtract<TAngleUnits, T>(in Vector<TAngleUn
/// <returns>A new Vector that is the result of multiplying each coordinate of the input vector by the scalar value.</returns>
/// <remarks>
/// This method multiplies the specified scalar value with each coordinate of the input Vector and returns a new Vector with the resulting products.
/// The operation is performed independently on each coordinate, meaning that the scalar value is multiplied with the Radius, Azimuth, Polar, and W coordinates of the input vector separately.
/// The operation is performed independently on each coordinate, meaning that the scalar value is multiplied with the Radius, Azimuth, and Polar coordinates of the input vector separately.
/// The input vector remains unchanged after the operation.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down

0 comments on commit 0e66e8e

Please sign in to comment.