From 9d27a67a46d4049021e5d7d2351b4c94e0212f6e Mon Sep 17 00:00:00 2001 From: luzpaz Date: Sun, 2 Nov 2025 08:25:26 -0500 Subject: [PATCH] Documentation - Fix whitespace and typos (#794) - Fixed capitalization of comment opening words to follow standard documentation conventions - Reformatted multi-line comments to improve readability by reducing excessive line breaks - Corrected a typo in parameter description --- src/FoundationClasses/TKMath/gp/gp_Dir.hxx | 26 ++++++------ src/FoundationClasses/TKMath/gp/gp_Hypr.hxx | 6 +-- src/FoundationClasses/TKMath/gp/gp_Pln.hxx | 43 ++++++++++---------- src/FoundationClasses/TKMath/gp/gp_Pnt2d.hxx | 2 +- 4 files changed, 38 insertions(+), 39 deletions(-) diff --git a/src/FoundationClasses/TKMath/gp/gp_Dir.hxx b/src/FoundationClasses/TKMath/gp/gp_Dir.hxx index 3807a12526..671e894019 100644 --- a/src/FoundationClasses/TKMath/gp/gp_Dir.hxx +++ b/src/FoundationClasses/TKMath/gp/gp_Dir.hxx @@ -77,18 +77,18 @@ public: //! that were not directly modified. void SetCoord(const Standard_Integer theIndex, const Standard_Real theXi); - //! For this unit vector, assigns the values theXv, theYv and theZv to its three coordinates. + //! For this unit vector, assigns the values theXv, theYv and theZv to its three coordinates. //! Remember that all the coordinates of a unit vector are //! implicitly modified when any single one is changed directly. void SetCoord(const Standard_Real theXv, const Standard_Real theYv, const Standard_Real theZv); - //! Assigns the given value to the X coordinate of this unit vector. + //! Assigns the given value to the X coordinate of this unit vector. void SetX(const Standard_Real theX); - //! Assigns the given value to the Y coordinate of this unit vector. + //! Assigns the given value to the Y coordinate of this unit vector. void SetY(const Standard_Real theY); - //! Assigns the given value to the Z coordinate of this unit vector. + //! Assigns the given value to the Z coordinate of this unit vector. void SetZ(const Standard_Real theZ); //! Assigns the three coordinates of theCoord to this unit vector. @@ -102,7 +102,7 @@ public: //! Standard_OutOfRange if theIndex is not 1, 2, or 3. Standard_Real Coord(const Standard_Integer theIndex) const { return coord.Coord(theIndex); } - //! Returns for the unit vector its three coordinates theXv, theYv, and theZv. + //! Returns for the unit vector its three coordinates theXv, theYv, and theZv. constexpr void Coord(Standard_Real& theXv, Standard_Real& theYv, Standard_Real& theZv) const noexcept @@ -110,16 +110,16 @@ public: coord.Coord(theXv, theYv, theZv); } - //! Returns the X coordinate for a unit vector. + //! Returns the X coordinate for a unit vector. constexpr Standard_Real X() const noexcept { return coord.X(); } - //! Returns the Y coordinate for a unit vector. + //! Returns the Y coordinate for a unit vector. constexpr Standard_Real Y() const noexcept { return coord.Y(); } - //! Returns the Z coordinate for a unit vector. + //! Returns the Z coordinate for a unit vector. constexpr Standard_Real Z() const noexcept { return coord.Z(); } - //! for this unit vector, returns its three coordinates as a number triplea. + //! for this unit vector, returns its three coordinates as a number triple. constexpr const gp_XYZ& XYZ() const noexcept { return coord; } //! Returns True if the angle between the two directions is @@ -129,7 +129,7 @@ public: return Angle(theOther) <= theAngularTolerance; } - //! Returns True if the angle between this unit vector and the unit vector theOther is equal to + //! Returns True if the angle between this unit vector and the unit vector theOther is equal to //! Pi/2 (normal). Standard_Boolean IsNormal(const gp_Dir& theOther, const Standard_Real theAngularTolerance) const { @@ -141,7 +141,7 @@ public: return anAng <= theAngularTolerance; } - //! Returns True if the angle between this unit vector and the unit vector theOther is equal to + //! Returns True if the angle between this unit vector and the unit vector theOther is equal to //! Pi (opposite). Standard_Boolean IsOpposite(const gp_Dir& theOther, const Standard_Real theAngularTolerance) const { @@ -238,8 +238,8 @@ public: Standard_EXPORT void Mirror(const gp_Dir& theV); //! Performs the symmetrical transformation of a direction - //! with respect to the direction theV which is the center of - //! the symmetry. + //! with respect to the direction theV which is the center + //! of the symmetry. Standard_NODISCARD Standard_EXPORT gp_Dir Mirrored(const gp_Dir& theV) const; Standard_EXPORT void Mirror(const gp_Ax1& theA1); diff --git a/src/FoundationClasses/TKMath/gp/gp_Hypr.hxx b/src/FoundationClasses/TKMath/gp/gp_Hypr.hxx index ad4ba6cfb0..5931dd698b 100644 --- a/src/FoundationClasses/TKMath/gp/gp_Hypr.hxx +++ b/src/FoundationClasses/TKMath/gp/gp_Hypr.hxx @@ -133,7 +133,7 @@ public: majorRadius = theMajorRadius; } - //! Modifies the minor radius of this hyperbola. + //! Modifies the minor radius of this hyperbola. //! Exceptions //! Standard_ConstructionError if theMinorRadius is negative. void SetMinorRadius(const Standard_Real theMinorRadius) @@ -224,7 +224,7 @@ public: //! negative side of the "XAxis" of the hyperbola. gp_Pnt Focus2() const; - //! Returns the location point of the hyperbola. It is the + //! Returns the location point of the hyperbola. It is the //! intersection point between the "XAxis" and the "YAxis". const gp_Pnt& Location() const { return pos.Location(); } @@ -277,7 +277,7 @@ public: Standard_EXPORT void Mirror(const gp_Pnt& theP); //! Performs the symmetrical transformation of an hyperbola with - //! respect to the point theP which is the center of the symmetry. + //! respect to the point theP which is the center of the symmetry. Standard_NODISCARD Standard_EXPORT gp_Hypr Mirrored(const gp_Pnt& theP) const; Standard_EXPORT void Mirror(const gp_Ax1& theA1); diff --git a/src/FoundationClasses/TKMath/gp/gp_Pln.hxx b/src/FoundationClasses/TKMath/gp/gp_Pln.hxx index 19b4571c09..2d164d38fc 100644 --- a/src/FoundationClasses/TKMath/gp/gp_Pln.hxx +++ b/src/FoundationClasses/TKMath/gp/gp_Pln.hxx @@ -98,15 +98,15 @@ public: //! Changes the local coordinate system of the plane. void SetPosition(const gp_Ax3& theA3) { pos = theA3; } - //! Reverses the U parametrization of the plane + //! Reverses the U parametrization of the plane //! reversing the XAxis. void UReverse() { pos.XReverse(); } - //! Reverses the V parametrization of the plane + //! Reverses the V parametrization of the plane //! reversing the YAxis. void VReverse() { pos.YReverse(); } - //! returns true if the Ax3 is right handed. + //! Returns true if the Ax3 is right handed. Standard_Boolean Direct() const { return pos.Direct(); } //! Returns the plane's normal Axis. @@ -115,7 +115,7 @@ public: //! Returns the plane's location (origin). const gp_Pnt& Location() const { return pos.Location(); } - //! Returns the local coordinate system of the plane . + //! Returns the local coordinate system of the plane. const gp_Ax3& Position() const { return pos; } //! Computes the distance between and the point . @@ -151,7 +151,7 @@ public: //! Returns the X axis of the plane. gp_Ax1 XAxis() const { return gp_Ax1(pos.Location(), pos.XDirection()); } - //! Returns the Y axis of the plane. + //! Returns the Y axis of the plane. gp_Ax1 YAxis() const { return gp_Ax1(pos.Location(), pos.YDirection()); } //! Returns true if this plane contains the point theP. This means that @@ -194,31 +194,30 @@ public: Standard_EXPORT void Mirror(const gp_Ax1& theA1); - //! Performs the symmetrical transformation of a - //! plane with respect to an axis placement which is the axis - //! of the symmetry. The transformation is performed on the - //! "Location" point, on the "XAxis" and the "YAxis". The - //! resulting normal direction is the cross product between - //! the "XDirection" and the "YDirection" after transformation - //! if the initial plane was right handed, else it is the - //! opposite. + //! Performs the symmetrical transformation of a plane with + //! respect to an axis placement which is the axis of the + //! symmetry. The transformation is performed on the "Location" + //! point, on the "XAxis" and the "YAxis". The resulting normal + //! direction is the cross product between the "XDirection" and + //! the "YDirection" after transformation if the initial plane + //! was right handed, else it is the opposite. Standard_NODISCARD Standard_EXPORT gp_Pln Mirrored(const gp_Ax1& theA1) const; Standard_EXPORT void Mirror(const gp_Ax2& theA2); - //! Performs the symmetrical transformation of a - //! plane with respect to an axis placement. The axis - //! placement locates the plane of the symmetry. The - //! transformation is performed on the "Location" point, on - //! the "XAxis" and the "YAxis". The resulting normal - //! direction is the cross product between the "XDirection" - //! and the "YDirection" after transformation if the initial - //! plane was right handed, else it is the opposite. + //! Performs the symmetrical transformation of a plane with + //! respect to an axis placement. The axis placement + //! locates the plane of the symmetry. The transformation is + //! performed on the "Location" point, on the "XAxis" and the + //! "YAxis". The resulting normal direction is the cross product + //! between the "XDirection" and the "YDirection" after + //! transformation if the initial plane was right handed, + //! else it is the opposite. Standard_NODISCARD Standard_EXPORT gp_Pln Mirrored(const gp_Ax2& theA2) const; void Rotate(const gp_Ax1& theA1, const Standard_Real theAng) { pos.Rotate(theA1, theAng); } - //! rotates a plane. theA1 is the axis of the rotation. + //! Rotates a plane. theA1 is the axis of the rotation. //! theAng is the angular value of the rotation in radians. Standard_NODISCARD gp_Pln Rotated(const gp_Ax1& theA1, const Standard_Real theAng) const { diff --git a/src/FoundationClasses/TKMath/gp/gp_Pnt2d.hxx b/src/FoundationClasses/TKMath/gp/gp_Pnt2d.hxx index 3bb01b0272..8defa50dc5 100644 --- a/src/FoundationClasses/TKMath/gp/gp_Pnt2d.hxx +++ b/src/FoundationClasses/TKMath/gp/gp_Pnt2d.hxx @@ -119,7 +119,7 @@ public: //! Performs the symmetrical transformation of a point //! with respect to the point theP which is the center of - //! the symmetry. + //! the symmetry. Standard_EXPORT void Mirror(const gp_Pnt2d& theP); //! Performs the symmetrical transformation of a point -- 2.39.5