Documentation - Fix whitespaces and typos (#821)

- Removed excessive whitespace between words in comments - Removed <br> syntax - Fixed spelling errors ("hilight" → "highlights", "texte" → "text") - Improved comment formatting and structure
2026-09-07 05:08:13 +08:00 · 2025-11-13 04:30:53 -05:00
parent 396b677095
commit df59c53e79
159 changed files with 1017 additions and 1012 deletions
@@ -45,7 +45,7 @@ class Geom2d_Curve;
 class Geom_Surface;
 class OSD_FileSystem;

-//! The BRepTools package provides  utilities for BRep
+//! The BRepTools package provides utilities for BRep
 //! data structures.
 //!
 //! * WireExplorer: Tool to explore the topology of
@@ -167,9 +167,9 @@ protected:
  //!
  //! If the first shape has the reversed orientation
  //! then the both shapes are reversed.
-  //! If the first shape has the internal or external orientation then: <br>
+  //! If the first shape has the internal or external orientation then:
  //! - the second shape is oriented forward (reversed) if it's orientation
-  //!   is equal (not equal) to the orientation of the first shape; <br>
+  //!   is equal (not equal) to the orientation of the first shape;
  //! - the first shape is oriented forward.
  Standard_EXPORT virtual void replace(const TopoDS_Shape&    shape,
                                       const TopoDS_Shape&    newshape,
@@ -98,7 +98,7 @@ public:
  //! Writes the geometry calling WriteGeometry.
  //!
  //! Dumps the shapes from last to first.
-  //! For each shape  :
+  //! For each shape:
  //! Write the type.
  //! calls WriteGeometry(S).
  //! Write the flags, the subshapes.
@@ -63,7 +63,7 @@ class GC_MakeHyperbola : public GC_Root
 public:
  DEFINE_STANDARD_ALLOC

-  //! Creates  an Hyperbola from a non persistent hyperbola  from package gp by conversion.
+  //! Creates an Hyperbola from a non persistent hyperbola from package gp by conversion.
  Standard_EXPORT GC_MakeHyperbola(const gp_Hypr& H);

  //! Constructs a hyperbola centered on the origin of the coordinate system
@@ -79,7 +79,7 @@ public:
  //! It returns false if <P1> <P2> <P3> are confused.
  Standard_EXPORT GC_MakePlane(const gp_Pnt& P1, const gp_Pnt& P2, const gp_Pnt& P3);

-  //! Make a Plane  passing through the location of <Axis>and
+  //! Make a Plane passing through the location of <Axis>and
  //! normal to the Direction of <Axis>.
  Standard_EXPORT GC_MakePlane(const gp_Ax1& Axis);

@@ -31,7 +31,7 @@ class gp_Pnt2d;

 //! This class implements the following algorithms used to
 //! create Ellipse from Geom2d.
-//! * Create an Ellipse from two apex  and the center.
+//! * Create an Ellipse from two apex and the center.
 //! Defines an ellipse in 2D space.
 //! The parametrization range is [0,2*PI].
 //! The ellipse is a closed and periodic curve.
@@ -49,7 +49,7 @@ public:
  Standard_EXPORT GCE2d_MakeEllipse(const gp_Elips2d& E);

  //! MajorAxis is the local coordinate system of the ellipse.
-  //! It is the "XAxis". The minor axis  is the YAxis of the
+  //! It is the "XAxis". The minor axis is the YAxis of the
  //! ellipse.
  //! Sense give the sense of parametrization of the Ellipse.
  //! It is not forbidden to create an ellipse with MajorRadius =
@@ -31,7 +31,7 @@ class gp_Pnt2d;

 //! This class implements the following algorithms used to
 //! create Hyperbola from Geom2d.
-//! * Create an Hyperbola from two apex  and the center.
+//! * Create an Hyperbola from two apex and the center.
 //! Defines the main branch of an hyperbola.
 //! The parameterization range is ]-infinite,+infinite[
 //! It is possible to get the other branch and the two conjugate
@@ -60,7 +60,7 @@ class GCE2d_MakeHyperbola : public GCE2d_Root
 public:
  DEFINE_STANDARD_ALLOC

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

  //! MajorAxis is the "XAxis" of the hyperbola.
@@ -31,8 +31,8 @@ class gp_Pnt2d;

 //! This class implements the following algorithms used to
 //! create Parabola from Geom2d.
-//! * Create an Parabola from two apex  and the center.
-//! Defines the parabola in the parameterization range  :
+//! * Create an Parabola from two apex and the center.
+//! Defines the parabola in the parameterization range:
 //! ]-infinite,+infinite[
 //! The vertex of the parabola is the "Location" point of the
 //! local coordinate system "XAxis" of the parabola.
@@ -21,7 +21,7 @@
 #include <Standard_ConstructionError.hxx>

 //! Dimension independent used to implement GCPnts_AbscissaPoint
-//! compute the type  and the length ratio if GCPnts_LengthParametrized.
+//! compute the type and the length ratio if GCPnts_LengthParametrized.
 template <class TheCurve>
 static GCPnts_AbscissaType computeType(const TheCurve& theC, Standard_Real& theRatio)
 {
@@ -61,21 +61,21 @@ public:
  //! approximation algorithm.
  Standard_EXPORT Handle(Geom2d_BSplineCurve) Curve() const;

-  //! returns  Standard_True  if  the  approximation  has
-  //! been  done  with  within  required tolerance
+  //! returns Standard_True if the approximation has
+  //! been done with within required tolerance
  Standard_EXPORT Standard_Boolean IsDone() const;

-  //! returns  Standard_True if the approximation did come out
-  //! with a result that  is not NECESSARELY within the required tolerance
+  //! returns Standard_True if the approximation did come out
+  //! with a result that is not NECESSARELY within the required tolerance
  Standard_EXPORT Standard_Boolean HasResult() const;

  //! Returns the greatest distance between a point on the
  //! source conic and the BSpline curve resulting from the
  //! approximation. (>0 when an approximation
-  //! has  been  done, 0  if  no  approximation)
+  //! has been done, 0 if no approximation)
  Standard_EXPORT Standard_Real MaxError() const;

-  //! Print on the stream  o  information about the object
+  //! Print on the stream o information about the object
  Standard_EXPORT void Dump(Standard_OStream& o) const;

 protected:
@@ -50,7 +50,7 @@ public:
  //! Radius is the radius of the circle in the reference plane of
  //! the cone.
  //! If Radius is lower than 0.0 the status is "
-  //! If Ang < Resolution from gp  or Ang >= (PI/2) - Resolution.
+  //! If Ang < Resolution from gp or Ang >= (PI/2) - Resolution.
  Standard_EXPORT gce_MakeCone(const gp_Ax2&       A2,
                               const Standard_Real Ang,
                               const Standard_Real Radius);
@@ -43,7 +43,7 @@ public:

  //! Creates an ellipse with the major axis, the major and the
  //! minor radius. The location of the MajorAxis is the center
-  //! of the  ellipse.
+  //! of the ellipse.
  //! The sense of parametrization is given by Sense.
  //! It is possible to create an ellipse with MajorRadius = MinorRadius.
  //! the status is "InvertRadius" if MajorRadius < MinorRadius or
@@ -57,7 +57,7 @@ public:
  //! the origin and the sense of parametrization.
  //! Creates an ellipse with the AxisPlacement the major and the
  //! minor radius. The location of Axis is the center
-  //! of the  ellipse.
+  //! of the ellipse.
  //! It is possible to create an ellipse with MajorRadius = MinorRadius.
  //! the status is "InvertRadius" if MajorRadius < MinorRadius or
  //! "NegativeRadius" if MinorRadius < 0.0
@@ -68,7 +68,7 @@ public:
  //! Makes an Elips2d with its center and two points.
  //! The sense of parametrization is given by S1, S2,
  //! and Center.
-  //! Depending on the constructor, the  implicit orientation of the ellipse is:
+  //! Depending on the constructor, the implicit orientation of the ellipse is:
  //! -   the sense defined by A,
  //! -   the sense defined by points Center, S1 and S2,
  //! -   the trigonometric sense if Sense is not given or is true, or
@@ -57,7 +57,7 @@ class gp_Pnt;
 //! to the hyperbola's plane.
 //!
 //! The "XAxis" of the hyperbola ("Location", "XDirection") is the
-//! major axis  and the  "YAxis" of the hyperbola ("Location",
+//! major axis and the "YAxis" of the hyperbola ("Location",
 //! "YDirection") is the minor axis.
 //!
 //! Warnings :
@@ -29,7 +29,7 @@ class gp_Pnt;

 //! This class implements the following algorithms used to
 //! create Parab from gp.
-//! Defines the parabola in the parameterization range  :
+//! Defines the parabola in the parameterization range:
 //! ]-infinite, +infinite[
 //! The vertex of the parabola is the "Location" point of the
 //! local coordinate system (axis placement) of the parabola.
@@ -47,7 +47,7 @@ class gp_Pnt2d;
 //! The focal length F = P/2 is the distance between the vertex
 //! and the focus of the parabola.
 //!
-//! * Create a Parab2d from one apex  and the center.
+//! * Create a Parab2d from one apex and the center.
 //! * Create a Parab2d with the directrix and the focus point.
 //! * Create a Parab2d with its vertex point and its axis
 //! of symmetry and its focus length.
@@ -58,7 +58,7 @@ public:
  //! the "YAxis" of the plane used to parametrize the plane.
  Standard_EXPORT gce_MakePln(const gp_Ax2& A2);

-  //! Creates a plane with the  "Location" point <P>
+  //! Creates a plane with the "Location" point <P>
  //! and the normal direction <V>.
  Standard_EXPORT gce_MakePln(const gp_Pnt& P, const gp_Dir& V);

@@ -95,7 +95,7 @@ public:
  //! The status is "ConfusedPoints" if <P1> <P2> are confused.
  Standard_EXPORT gce_MakePln(const gp_Pnt& P1, const gp_Pnt& P2);

-  //! Make a pln  passing through the location of <Axis>and
+  //! Make a pln passing through the location of <Axis>and
  //! normal to the Direction of <Axis>.
  //! Warning - If an error occurs (that is, when IsDone returns
  //! false), the Status function returns: