Documentation - Fix whitespaces and typos (#819)

- Fixed inconsistent whitespace and line breaks in comments - Corrected spelling errors ("witch" → "which", "sprcified" → "specified", "nul" → "null", etc.) - Improved formatting consistency in documentation comments
2026-09-07 13:18:19 +08:00 · 2025-11-12 13:06:11 -05:00
parent 61d69fde9e
commit ed1d0c88cc
164 changed files with 765 additions and 770 deletions
@@ -50,7 +50,7 @@ public:
                                 const Standard_Real Major,
                                 const Standard_Real Minor);

-  //! The surface normal should be directed  towards the
+  //! The surface normal should be directed towards the
  //! outside.
  Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE;

@@ -33,7 +33,7 @@ public:
  //! Default constructor
  BRepPrim_Wedge() {}

-  //! Creates a  Wedge  algorithm.   <Axes> is  the axis
+  //! Creates a Wedge algorithm. <Axes> is the axis
  //! system for the primitive.
  //!
  //! XMin, YMin, ZMin are set to 0
@@ -49,7 +49,7 @@ public:
                                 const Standard_Real dy,
                                 const Standard_Real dz);

-  //! Creates  a Wedge  primitive. <Axes> is   the  axis
+  //! Creates a Wedge primitive. <Axes> is the axis
  //! system for the primitive.
  //!
  //! XMin, YMin, ZMin are set to 0
@@ -67,7 +67,7 @@ public:
                                 const Standard_Real dz,
                                 const Standard_Real ltx);

-  //! Create  a Wedge primitive.   <Axes>  is  the  axis
+  //! Create a Wedge primitive. <Axes> is the axis
  //! system for the primitive.
  //!
  //! all the fields are set to the corresponding value
@@ -25,7 +25,7 @@
 #include <BRepPrimAPI_MakeOneAxis.hxx>
 class gp_Ax2;

-//! Describes functions to build cylinders or portions of  cylinders.
+//! Describes functions to build cylinders or portions of cylinders.
 //! A MakeCylinder object provides a framework for:
 //! -   defining the construction of a cylinder,
 //! -   implementing the construction algorithm, and
@@ -56,8 +56,8 @@ public:
                                           const Standard_Real R,
                                           const Standard_Real H);

-  //! Make a cylinder   of  radius R  and  length H with
-  //! angle  H.
+  //! Make a cylinder of radius R and length H with
+  //! angle H.
  //! Constructs
  //! -   a cylinder of radius R and height H, or
  //! -   a portion of cylinder of radius R and height H, and of
@@ -58,8 +58,8 @@ public:
                                        const Standard_Boolean Canonize = Standard_True);

  //! Builds a semi-infinite or an infinite prism of base S.
-  //! If Inf is true the prism  is infinite, if Inf is false
-  //! the prism is semi-infinite (in the direction D).  If C
+  //! If Inf is true the prism is infinite, if Inf is false
+  //! the prism is semi-infinite (in the direction D). If C
  //! is true S is copied (for semi-infinite prisms).
  //! If Canonize is true then generated surfaces
  //! are attempted to be canonized in simple types
@@ -76,7 +76,7 @@ public:
  Standard_EXPORT virtual void Build(
    const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;

-  //! Returns the  TopoDS  Shape of the bottom of the prism.
+  //! Returns the TopoDS Shape of the bottom of the prism.
  Standard_EXPORT TopoDS_Shape FirstShape() Standard_OVERRIDE;

  //! Returns the TopoDS Shape of the top of the prism.
@@ -94,12 +94,12 @@ public:
  //! Returns true if the shape S has been deleted.
  Standard_EXPORT virtual Standard_Boolean IsDeleted(const TopoDS_Shape& S) Standard_OVERRIDE;

-  //! Returns the TopoDS Shape of the bottom  of the  prism.
-  //! generated  with  theShape (subShape of the  generating shape).
+  //! Returns the TopoDS Shape of the bottom of the prism.
+  //! generated with theShape (subShape of the generating shape).
  Standard_EXPORT TopoDS_Shape FirstShape(const TopoDS_Shape& theShape);

-  //! Returns the  TopoDS  Shape of the top  of  the  prism.
-  //! generated  with  theShape (subShape of the  generating shape).
+  //! Returns the TopoDS Shape of the top of the prism.
+  //! generated with theShape (subShape of the generating shape).
  Standard_EXPORT TopoDS_Shape LastShape(const TopoDS_Shape& theShape);

 protected:
@@ -32,11 +32,11 @@ class TopoDS_Shape;
 //! -      Edges generate Faces.
 //! -      Wires generate Shells.
 //! -      Faces generate Solids.
-//! -      Shells generate Composite  Solids.
+//! -      Shells generate Composite Solids.
 //! You are not allowed to sweep Solids and Composite Solids.
 //! Two kinds of sweeps are implemented in the BRepPrimAPI package:
-//! -      The linear sweep called a   Prism
-//! -      The rotational sweep    called a Revol
+//! -      The linear sweep called a Prism
+//! -      The rotational sweep called a Revol
 //! Swept constructions along complex profiles such as BSpline curves
 //! are also available in the BRepOffsetAPI package..
 class BRepPrimAPI_MakeSweep : public BRepBuilderAPI_MakeShape
@@ -44,7 +44,7 @@ class BRepPrimAPI_MakeSweep : public BRepBuilderAPI_MakeShape
 public:
  DEFINE_STANDARD_ALLOC

-  //! Returns the  TopoDS  Shape of the bottom of the sweep.
+  //! Returns the TopoDS Shape of the bottom of the sweep.
  Standard_EXPORT virtual TopoDS_Shape FirstShape() = 0;

  //! Returns the TopoDS Shape of the top of the sweep.
@@ -103,7 +103,7 @@ public:
  //! Make a section of a torus of radii R1 R2.
  //! For all algorithms The resulting shape is composed of
  //! -      a lateral toroidal face,
-  //! -      two conical faces (defined  by the equation v = angle1 and
+  //! -      two conical faces (defined by the equation v = angle1 and
  //! v = angle2) if the sphere is truncated in the v parametric
  //! direction (they may be cylindrical faces in some
  //! particular conditions), and in case of a portion
@@ -28,7 +28,7 @@ class TopoDS_Shape;

 //! This class provides iteration services required by
 //! the Generating Line (TopoDS Shape) of a BRepSweep.
-//! This   tool is  used  to   iterate  on the  direct
+//! This tool is used to iterate on the direct
 //! sub-shapes of a Shape.
 class BRepSweep_Iterator
 {
@@ -25,7 +25,7 @@
 #include <TopAbs_Orientation.hxx>

 //! This class provides iteration services required by
-//! the   Swept Primitives  for   a Directing NumShape
+//! the Swept Primitives for a Directing NumShape
 //! Line.
 class Sweep_NumShapeIterator
 {
@@ -25,16 +25,16 @@
 #include <TopAbs_ShapeEnum.hxx>
 #include <TopAbs_Orientation.hxx>

-//! This class provides  the indexation and  type analysis
-//! services required by  the NumShape Directing Shapes of
+//! This class provides the indexation and type analysis
+//! services required by the NumShape Directing Shapes of
 //! Swept Primitives.
 class Sweep_NumShapeTool
 {
 public:
  DEFINE_STANDARD_ALLOC

-  //! Create a new NumShapeTool with <aShape>.  The Tool
-  //! must prepare an indexation  for  all the subshapes
+  //! Create a new NumShapeTool with <aShape>. The Tool
+  //! must prepare an indexation for all the subshapes
  //! of this shape.
  Standard_EXPORT Sweep_NumShapeTool(const Sweep_NumShape& aShape);