Documentation - Fix whitespace and typos (#815)

2026-09-04 11:47:53 +08:00 · 2025-11-09 16:38:29 -05:00
parent 989f00b9c4
commit a47cffd0eb
95 changed files with 507 additions and 512 deletions
@@ -85,7 +85,7 @@ public:
  //! not possible to have a direction with null length.
  Standard_EXPORT void Cross(const Handle(Geom_Vector)& Other) Standard_OVERRIDE;

-  //! Computes the triple vector product  <me> ^(V1 ^ V2).
+  //! Computes the triple vector product <me> ^(V1 ^ V2).
  //!
  //! Raised if V1 and V2 are parallel or <me> and (V1 ^ V2) are
  //! parallel
@@ -74,7 +74,7 @@ public:
  //! Scales a Geometry. S is the scaling value.
  Standard_EXPORT void Scale(const gp_Pnt& 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_Vec& V);

  //! Translates a Geometry from the point P1 to the point P2.
@@ -100,7 +100,7 @@ public:
  //! - the "Y Direction" of A2 defines the minor axis
  //! of the hyperbola, i.e. the minor radius
  //! MinorRadius is measured along this axis,
-  //! - A2 is the local coordinate system of the   hyperbola.
+  //! - A2 is the local coordinate system of the hyperbola.
  //! Exceptions
  //! Standard_ConstructionError if:
  //! - MajorRadius is less than 0.0,
@@ -93,7 +93,7 @@ public:
  Standard_EXPORT Standard_Real FirstParameter() const Standard_OVERRIDE;

  //! Returns the value of the last parameter of this
-  //! line. This is  Standard_Real::RealLast().
+  //! line. This is Standard_Real::RealLast().
  Standard_EXPORT Standard_Real LastParameter() const Standard_OVERRIDE;

  //! returns False
@@ -155,7 +155,7 @@ public:
                                                             const gp_Trsf&      T) const
    Standard_OVERRIDE;

-  //! Returns a  coefficient to compute the parameter on
+  //! Returns a coefficient to compute the parameter on
  //! the transformed curve for the transform of the
  //! point on <me>.
  //!
@@ -108,7 +108,7 @@ public:
  //! @endcode
  //! This method does not change <U> and <V>
  //!
-  //! It  can be redefined.  For  example on  the Plane,
+  //! It can be redefined. For example on the Plane,
  //! Cylinder, Cone, Revolved and Extruded surfaces.
  Standard_EXPORT virtual void TransformParameters(Standard_Real& U,
                                                   Standard_Real& V,
@@ -44,14 +44,14 @@
 class Approx_SweepFunction;
 class AdvApprox_Cutting;

-//! Approximation  of  an  Surface   S(u,v)
-//! (and eventually associate  2d Curves) defined
+//! Approximation of an Surface S(u,v)
+//! (and eventually associate 2d Curves) defined
 //! by section's law.
 //!
 //! This surface is defined by a function F(u, v)
 //! where Ft(u) = F(u, t) is a bspline curve.
-//! To use this algorithme, you  have to implement Ft(u)
-//! as a derivative class  of Approx_SweepFunction.
+//! To use this algorithm, you have to implement Ft(u)
+//! as a derivative class of Approx_SweepFunction.
 //! This algorithm can be used by blending, sweeping...
 class Approx_SweepApproximation
 {
@@ -158,7 +158,7 @@ public:
  //! 2d curve approximation.
  Standard_EXPORT Standard_Real Average2dError(const Standard_Integer Index) const;

-  //! returns the  maximum 3d  error  of the  <Index>
+  //! returns the maximum 3d error of the <Index>
  //! 2d curve approximation on the Surface.
  Standard_EXPORT Standard_Real TolCurveOnSurf(const Standard_Integer Index) const;

@@ -113,7 +113,7 @@ public:
  Standard_EXPORT virtual void SetInterval(const Standard_Real First, const Standard_Real Last) = 0;

  //! Returns the resolutions in the  sub-space 2d <Index>
-  //! This information is usfull to find an good tolerance in
+  //! This information is useful to find a good tolerance in
  //! 2d approximation.
  Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
                                          const Standard_Real    Tol,
@@ -31,12 +31,12 @@ class Geom2dConvert_CompCurveToBSplineCurve
 public:
  DEFINE_STANDARD_ALLOC

-  //! Initialize the algorithme
+  //! Initialize the algorithm
  //! - Parameterisation is used to convert
  Standard_EXPORT Geom2dConvert_CompCurveToBSplineCurve(
    const Convert_ParameterisationType Parameterisation = Convert_TgtThetaOver2);

-  //! Initialize the algorithme with one curve
+  //! Initialize the algorithm with one curve
  //! - Parameterisation is used to convert
  Standard_EXPORT Geom2dConvert_CompCurveToBSplineCurve(
    const Handle(Geom2d_BoundedCurve)& BasisCurve,
@@ -32,20 +32,20 @@ class GeomConvert_CompCurveToBSplineCurve
 public:
  DEFINE_STANDARD_ALLOC

-  //! Initialize the algorithme
+  //! Initialize the algorithm
  //! - Parameterisation is used to convert
  Standard_EXPORT GeomConvert_CompCurveToBSplineCurve(
    const Convert_ParameterisationType Parameterisation = Convert_TgtThetaOver2);

-  //! Initialize the algorithme with one curve
+  //! Initialize the algorithm with one curve
  //! - Parameterisation is used to convert
  Standard_EXPORT GeomConvert_CompCurveToBSplineCurve(
    const Handle(Geom_BoundedCurve)&   BasisCurve,
    const Convert_ParameterisationType Parameterisation = Convert_TgtThetaOver2);

-  //! Append a curve in  the BSpline Return False if the
-  //! curve is not G0  with the BSplineCurve.  Tolerance
-  //! is   used to   check   continuity  and decrease
+  //! Append a curve in the BSpline Return False if the
+  //! curve is not G0 with the BSplineCurve. Tolerance
+  //! is used to check continuity and decrease
  //! Multiplicity at the common Knot until MinM
  //! if MinM = 0, the common Knot can be removed
  //!