Documentation - Fix whitespaces and typos (#824)

- Fixed excessive whitespace in multi-line comments - Corrected spelling errors (e.g., "selectionnable" → "selectable", "begenning" → "beginning") - Improved comment formatting and readability
2026-09-09 22:28:13 +08:00 · 2025-11-13 15:31:57 -05:00
parent 570b34b666
commit 79289339d8
161 changed files with 879 additions and 883 deletions
@@ -65,10 +65,10 @@ public:
  //! intervals.
  Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const;

-  //! Stores in <T> the  parameters bounding the intervals
+  //! Stores in <T> the parameters bounding the intervals
  //! of continuity <S>.
  //!
-  //! The array must provide  enough room to  accommodate
+  //! The array must provide enough room to accommodate
  //! for the parameters. i.e. T.Length() > NbIntervals()
  Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const;

@@ -124,7 +124,7 @@ public:
  //! Raised if N < 1.
  Standard_EXPORT virtual gp_Vec2d DN(const Standard_Real U, const Standard_Integer N) const;

-  //! Returns the parametric  resolution corresponding
+  //! Returns the parametric resolution corresponding
  //! to the real space resolution <R3d>.
  Standard_EXPORT virtual Standard_Real Resolution(const Standard_Real R3d) const;

@@ -88,7 +88,7 @@ public:
  //! Stores in <T> the parameters bounding the intervals
  //! of continuity <S>.
  //!
-  //! The array must provide  enough room to accommodate
+  //! The array must provide enough room to accommodate
  //! for the parameters. i.e. T.Length() > NbIntervals()
  Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
                                 const GeomAbs_Shape   S) const Standard_OVERRIDE;
@@ -133,7 +133,7 @@ class Geom2d_BSplineCurve : public Geom2d_BoundedCurve
 {

 public:
-  //! Creates a  non-rational B_spline curve on the
+  //! Creates a non-rational B_spline curve on the
  //! basis <Knots, Multiplicities> of degree <Degree>.
  //! The following conditions must be verified.
  //! 0 < Degree <= MaxDegree.
@@ -164,7 +164,7 @@ public:
                                      const Standard_Integer         Degree,
                                      const Standard_Boolean         Periodic = Standard_False);

-  //! Creates  a rational B_spline  curve  on the basis
+  //! Creates a rational B_spline curve on the basis
  //! <Knots, Multiplicities> of degree <Degree>.
  //! The following conditions must be verified.
  //! 0 < Degree <= MaxDegree.
@@ -179,7 +179,7 @@ public:
  //! may be Degree+1 (this is even recommended if you want the
  //! curve to start and finish on the first and last pole).
  //!
-  //! On a periodic  curve the first  and  the last multicities
+  //! On a periodic curve the first and the last multicities
  //! must be the same.
  //!
  //! on non-periodic curves
@@ -633,16 +633,16 @@ public:
  //! one requested, this function impacts the part defined
  //! by the parameter with a value greater than U, i.e. the
  //! part of the curve to the "right" of the singularity.
-  //! Raises  UndefinedDerivative if the continuity of the curve is not CN.
+  //! Raises UndefinedDerivative if the continuity of the curve is not CN.
  //! RangeError if N < 1.
  //! The following functions computes the point of parameter U
  //! and the derivatives at this point on the B-spline curve
  //! arc defined between the knot FromK1 and the knot ToK2.
-  //! U can be out of bounds [Knot (FromK1),  Knot (ToK2)] but
+  //! U can be out of bounds [Knot (FromK1), Knot (ToK2)] but
  //! for the computation we only use the definition of the curve
  //! between these two knots. This method is useful to compute
  //! local derivative, if the order of continuity of the whole
-  //! curve is not greater enough.    Inside the parametric
+  //! curve is not greater enough. Inside the parametric
  //! domain Knot (FromK1), Knot (ToK2) the evaluations are
  //! the same as if we consider the whole definition of the
  //! curve. Of course the evaluations are different outside
@@ -780,7 +780,7 @@ public:
  //! Locates the parametric value U in the sequence of knots.
  //! If "WithKnotRepetition" is True we consider the knot's
  //! representation with repetition of multiple knot value,
-  //! otherwise  we consider the knot's representation with
+  //! otherwise we consider the knot's representation with
  //! no repetition of multiple knot values.
  //! Knots (I1) <= U <= Knots (I2)
  //! . if I1 = I2  U is a knot value (the tolerance criterion
@@ -869,7 +869,7 @@ public:

 protected:
 private:
-  //! Recompute  the  flatknots,  the knotsdistribution, the continuity.
+  //! Recompute the flatknots, the knotsdistribution, the continuity.
  Standard_EXPORT void UpdateKnots();

  Standard_Boolean                 rational;
@@ -101,7 +101,7 @@ public:
  //! CurvePoles and the set of weights PoleWeights.
  //! If all the weights are identical the curve is considered
  //! as non rational. Raises ConstructionError if the number
-  //! of poles is greater than  MaxDegree + 1 or lower than 2
+  //! of poles is greater than MaxDegree + 1 or lower than 2
  //! or CurvePoles and CurveWeights have not the same length
  //! or one weight value is lower or equal to Resolution from
  //! package gp.
@@ -59,7 +59,7 @@ DEFINE_STANDARD_HANDLE(Geom2d_Circle, Geom2d_Conic)
 //! See Also
 //! GCE2d_MakeCircle which provides functions for
 //! more complex circle constructions
-//! gp_Ax22d and  gp_Circ2d for an equivalent, non-parameterized data structure.
+//! gp_Ax22d and gp_Circ2d for an equivalent, non-parameterized data structure.
 class Geom2d_Circle : public Geom2d_Conic
 {

@@ -78,7 +78,7 @@ public:

  //! returns the eccentricity value of the conic e.
  //! e = 0 for a circle
-  //! 0 < e < 1 for an ellipse  (e = 0 if MajorRadius = MinorRadius)
+  //! 0 < e < 1 for an ellipse (e = 0 if MajorRadius = MinorRadius)
  //! e > 1 for a hyperbola
  //! e = 1 for a parabola
  Standard_EXPORT virtual Standard_Real Eccentricity() const = 0;
@@ -95,7 +95,7 @@ public:
  //! The local coordinate system of the conic is modified.
  Standard_EXPORT void Reverse() Standard_OVERRIDE;

-  //! Returns the  parameter on the  reversed  curve for
+  //! Returns the parameter on the reversed curve for
  //! the point of parameter U on <me>.
  Standard_EXPORT virtual Standard_Real ReversedParameter(const Standard_Real U) const
    Standard_OVERRIDE = 0;
@@ -63,9 +63,9 @@ class Geom2d_Curve : public Geom2d_Geometry
 public:
  //! Changes the direction of parametrization of <me>.
  //! The "FirstParameter" and the "LastParameter" are not changed
-  //! but the orientation  of the curve is modified. If the curve
+  //! but the orientation of the curve is modified. If the curve
  //! is bounded the StartPoint of the initial curve becomes the
-  //! EndPoint of the reversed curve  and the EndPoint of the initial
+  //! EndPoint of the reversed curve and the EndPoint of the initial
  //! curve becomes the StartPoint of the reversed curve.
  Standard_EXPORT virtual void Reverse() = 0;

@@ -138,10 +138,10 @@ public:
  //! . the curve is always periodic by definition (Circle)
  //! . the curve can be defined as periodic (BSpline). In this case
  //! a function SetPeriodic allows you to give the shape of the
-  //! curve.  The general rule for this case is : if a curve can be
+  //! curve. The general rule for this case is : if a curve can be
  //! periodic or not the default periodicity set is non periodic
  //! and you have to turn (explicitly) the curve into a periodic
-  //! curve  if you want the curve to be periodic.
+  //! curve if you want the curve to be periodic.
  Standard_EXPORT virtual Standard_Boolean IsPeriodic() const = 0;

  //! Returns the period of this curve.
@@ -163,8 +163,8 @@ public:
  Standard_EXPORT virtual Standard_Boolean IsCN(const Standard_Integer N) const = 0;

  //! Returns in P the point of parameter U.
-  //! If the curve is periodic  then the returned point is P(U) with
-  //! U = Ustart + (U - Uend)  where Ustart and Uend are the
+  //! If the curve is periodic then the returned point is P(U) with
+  //! U = Ustart + (U - Uend) where Ustart and Uend are the
  //! parametric bounds of the curve.
  //!
  //! Raised only for the "OffsetCurve" if it is not possible to
@@ -206,8 +206,8 @@ public:
  Standard_EXPORT virtual gp_Vec2d DN(const Standard_Real U, const Standard_Integer N) const = 0;

  //! Computes the point of parameter U on <me>.
-  //! If the curve is periodic  then the returned point is P(U) with
-  //! U = Ustart + (U - Uend)  where Ustart and Uend are the
+  //! If the curve is periodic then the returned point is P(U) with
+  //! U = Ustart + (U - Uend) where Ustart and Uend are the
  //! parametric bounds of the curve.
  //!
  //! it is implemented with D0.
@@ -157,7 +157,7 @@ public:
  //! circle).
  Standard_EXPORT gp_Ax2d Directrix2() const;

-  //! Returns the eccentricity of the ellipse  between 0.0 and 1.0
+  //! Returns the eccentricity of the ellipse between 0.0 and 1.0
  //! If f is the distance between the center of the ellipse and
  //! the Focus1 then the eccentricity e = f / MajorRadius.
  //! Returns 0 if MajorRadius = 0
@@ -188,12 +188,12 @@ public:
  Standard_EXPORT Standard_Real Parameter() const;

  //! Returns the value of the first parameter of this
-  //! ellipse. This is  0.0, which gives the start point of this ellipse.
+  //! ellipse. This is 0.0, which gives the start point of this ellipse.
  //! The start point and end point of an ellipse are coincident.
  Standard_EXPORT Standard_Real FirstParameter() const Standard_OVERRIDE;

-  //! Returns the value of the  last parameter of this
-  //! ellipse. This is  2.*Pi, which gives the end point of this ellipse.
+  //! Returns the value of the last parameter of this
+  //! ellipse. This is 2.*Pi, which gives the end point of this ellipse.
  //! The start point and end point of an ellipse are coincident.
  Standard_EXPORT Standard_Real LastParameter() const Standard_OVERRIDE;

@@ -73,7 +73,7 @@ public:
  //! Scales a Geometry. S is the scaling value.
  Standard_EXPORT void Scale(const gp_Pnt2d& P, const Standard_Real S);

-  //! Translates a Geometry.  V is the vector of the translation.
+  //! Translates a Geometry. V is the vector of the translation.
  Standard_EXPORT void Translate(const gp_Vec2d& V);

  //! Translates a Geometry from the point P1 to the point P2.
@@ -87,7 +87,7 @@ class Geom2d_Hyperbola : public Geom2d_Conic
 {

 public:
-  //! Creates  an Hyperbola from a non persistent one from package gp
+  //! Creates an Hyperbola from a non persistent one from package gp
  Standard_EXPORT Geom2d_Hyperbola(const gp_Hypr2d& H);

  //! MajorAxis is the "XAxis" of the hyperbola.
@@ -99,10 +99,10 @@ public:
  //! For a line, the returned value is -U.
  Standard_EXPORT Standard_Real ReversedParameter(const Standard_Real U) const Standard_OVERRIDE;

-  //! Returns RealFirst  from  Standard.
+  //! Returns RealFirst from Standard.
  Standard_EXPORT Standard_Real FirstParameter() const Standard_OVERRIDE;

-  //! Returns RealLast  from Standard
+  //! Returns RealLast from Standard
  Standard_EXPORT Standard_Real LastParameter() const Standard_OVERRIDE;

  //! Returns False
@@ -91,8 +91,8 @@ public:
  //! In this package the entities are not shared. The OffsetCurve is
  //! built with a copy of the curve C. So when C is modified the
  //! OffsetCurve is not modified
-  //! Warning!  if isNotCheckC0 = false,
-  //! ConstructionError  raised if the basis curve C is not at least C1.
+  //! Warning! if isNotCheckC0 = false,
+  //! ConstructionError raised if the basis curve C is not at least C1.
  //! No check is done to know if ||V^Z|| != 0.0 at any point.
  Standard_EXPORT Geom2d_OffsetCurve(const Handle(Geom2d_Curve)& C,
                                     const Standard_Real         Offset,
@@ -151,7 +151,7 @@ public:
  //! direction.
  //! If T is the first derivative with not null length and
  //! Z the direction normal to the plane of the curve, the
-  //! relation ||T(U) ^ Z|| != 0  must be satisfied to evaluate
+  //! relation ||T(U) ^ Z|| != 0 must be satisfied to evaluate
  //! the offset curve.
  //! No check is done at the creation time and we suppose
  //! in this package that the offset curve is well defined.
@@ -164,13 +164,13 @@ public:

  //! Warning! this should not be called
  //! if the continuity of the basis curve is not C2.
-  //! Nevertheless, it's OK to use it  on portion
+  //! Nevertheless, it's OK to use it on portion
  //! where the curve is C2
  Standard_EXPORT void D1(const Standard_Real U, gp_Pnt2d& P, gp_Vec2d& V1) const Standard_OVERRIDE;

-  //! Warning!  This  should  not  be called
+  //! Warning! This should not be called
  //! if the continuity of the basis curve is not C3.
-  //! Nevertheless, it's OK to use it  on portion
+  //! Nevertheless, it's OK to use it on portion
  //! where the curve is C3
  Standard_EXPORT void D2(const Standard_Real U,
                          gp_Pnt2d&           P,
@@ -179,7 +179,7 @@ public:

  //! Warning! This should not be called
  //! if the continuity of the basis curve is not C4.
-  //! Nevertheless, it's OK to use it  on portion
+  //! Nevertheless, it's OK to use it on portion
  //! where the curve is C4
  Standard_EXPORT void D3(const Standard_Real U,
                          gp_Pnt2d&           P,
@@ -190,11 +190,11 @@ public:
  //! The returned vector gives the value of the derivative
  //! for the order of derivation N.
  //! Warning! this should not be called
-  //! raises  UndefunedDerivative   if the continuity of the basis curve is not CN+1.
-  //! Nevertheless, it's OK to use it  on portion
+  //! raises UndefunedDerivative if the continuity of the basis curve is not CN+1.
+  //! Nevertheless, it's OK to use it on portion
  //! where the curve is CN+1
-  //! raises  RangeError if N < 1.
-  //! raises  NotImplemented if N > 3.
+  //! raises RangeError if N < 1.
+  //! raises NotImplemented if N > 3.
  //! The following functions compute the value and derivatives
  //! on the offset curve and returns the derivatives on the
  //! basis curve too.
@@ -231,7 +231,7 @@ public:
  //! Is the order of continuity of the curve N ?
  //! Warnings :
  //! This method answer True if the continuity of the basis curve
-  //! is N + 1.  We suppose in this class that a normal direction
+  //! is N + 1. We suppose in this class that a normal direction
  //! to the basis curve (used to compute the offset curve) is
  //! defined at any point on the basis curve.
  //! Raised if N < 0.
@@ -253,7 +253,7 @@ public:
  //! Note: the basis curve is also modified.
  Standard_EXPORT void Transform(const gp_Trsf2d& T) Standard_OVERRIDE;

-  //! Returns the  parameter on the  transformed  curve for
+  //! Returns the parameter on the transformed curve for
  //! the transform of the point of parameter U on <me>.
  //!
  //! me->Transformed(T)->Value(me->TransformedParameter(U,T))
@@ -267,8 +267,8 @@ public:
                                                             const gp_Trsf2d&    T) const
    Standard_OVERRIDE;

-  //! Returns a  coefficient to compute the parameter on
-  //! the transformed  curve  for  the transform  of the
+  //! Returns a coefficient to compute the parameter on
+  //! the transformed curve for the transform of the
  //! point on <me>.
  //!
  //! Transformed(T)->Value(U * ParametricTransformation(T))
@@ -112,7 +112,7 @@ public:
  //! Returns RealFirst from Standard.
  Standard_EXPORT Standard_Real FirstParameter() const Standard_OVERRIDE;

-  //! Returns  RealLast from Standard.
+  //! Returns RealLast from Standard.
  Standard_EXPORT Standard_Real LastParameter() const Standard_OVERRIDE;

  //! Returns False
@@ -147,7 +147,7 @@ public:
  //! Returns in P the point of parameter U.
  //! If U = 0 the returned point is the origin of the XAxis and
  //! the YAxis of the parabola and it is the vertex of the parabola.
-  //! P = S + F * (U * U * XDir +  * U * YDir)
+  //! P = S + F * (U * U * XDir + * U * YDir)
  //! where S is the vertex of the parabola, XDir the XDirection and
  //! YDir the YDirection of the parabola's local coordinate system.
  Standard_EXPORT void D0(const Standard_Real U, gp_Pnt2d& P) const Standard_OVERRIDE;
@@ -44,7 +44,7 @@ public:
  //! returns the X coordinate of <me>.
  Standard_EXPORT virtual Standard_Real X() const = 0;

-  //! returns  the Y coordinate of <me>.
+  //! returns the Y coordinate of <me>.
  Standard_EXPORT virtual Standard_Real Y() const = 0;

  //! computes the distance between <me> and <Other>.
@@ -136,7 +136,7 @@ public:
  //! Returns the coefficients of the global matrix of transformation.
  //! It is a 2 rows X 3 columns matrix.
  //!
-  //! Raised if  Row < 1 or Row > 2  or  Col < 1 or Col > 2
+  //! Raised if Row < 1 or Row > 2 or Col < 1 or Col > 2
  //!
  //! Computes the reverse transformation.
  Standard_EXPORT Standard_Real Value(const Standard_Integer Row, const Standard_Integer Col) const;
@@ -184,7 +184,7 @@ public:
  Standard_EXPORT Handle(Geom2d_Transformation) Powered(const Standard_Integer N) const;

  //! Computes the matrix of the transformation composed with
-  //! <me> and Other.     <me> = Other * <me>
+  //! <me> and Other. <me> = Other * <me>
  Standard_EXPORT void PreMultiply(const Handle(Geom2d_Transformation)& Other);

  //! Applies the transformation <me> to the triplet {X, Y}.
@@ -52,7 +52,7 @@ public:
  //! Returns the coordinates of <me>.
  Standard_EXPORT void Coord(Standard_Real& X, Standard_Real& Y) const;

-  //! Returns the  Magnitude of <me>.
+  //! Returns the Magnitude of <me>.
  Standard_EXPORT virtual Standard_Real Magnitude() const = 0;

  //! Returns the square magnitude of <me>.
@@ -77,7 +77,7 @@ public:
    return Added(Other);
  }

-  //! Computes the cross product  between <me> and Other
+  //! Computes the cross product between <me> and Other
  //! <me> ^ Other. A new vector is returned.
  Standard_EXPORT Standard_Real Crossed(const Handle(Geom2d_Vector)& Other) const Standard_OVERRIDE;

@@ -44,7 +44,7 @@ public:
                                          Standard_Real&      F,
                                          Standard_Real&      D);

-  //! True  if  Param  corresponds  to  a minus
+  //! True if Param corresponds to a minus
  //! of the radius of curvature.
  Standard_EXPORT Standard_Boolean IsMinKC(const Standard_Real Param) const;