Documentation - Fix whitespace and typos (#815)

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_CircularBlendFunc.hxx

@@ -41,15 +41,15 @@ class GeomFill_CircularBlendFunc : public Approx_SweepFunction
 {
 
 public:
-  //! Create a Blend  with a  constant  radius with 2
-  //! guide-line.   <FShape>  sets the type of  fillet
-  //! surface. The --  default value is  Convert_TgtThetaOver2 (classical --
-  //! nurbs    --   representation  of   circles).
-  //! ChFi3d_QuasiAngular  --  corresponds  to a nurbs
-  //! representation   of  circles     --     which
-  //! parameterisation  matches  the  circle  one.  --
-  //! ChFi3d_Polynomial corresponds to a polynomial --
-  //! representation of circles.
+  //! Create a Blend with a constant radius with 2
+  //! guide-line. <FShape> sets the type of fillet
+  //! surface. The default value is Convert_TgtThetaOver2
+  //! (classical nurbs representation of circles).
+  //! ChFi3d_QuasiAngular corresponds to a nurbs
+  //! representation of circles which parameterisation
+  //! matches the circle one. ChFi3d_Polynomial
+  //! corresponds to a polynomial representation of
+  //! circles.
   Standard_EXPORT GeomFill_CircularBlendFunc(const Handle(Adaptor3d_Curve)& Path,
                                              const Handle(Adaptor3d_Curve)& Curve1,
                                              const Handle(Adaptor3d_Curve)& Curve2,
@@ -64,7 +64,7 @@ public:
                                               TColgp_Array1OfPnt2d& Poles2d,
                                               TColStd_Array1OfReal& Weigths) Standard_OVERRIDE;
 
-  //! compute the first  derivative in v direction  of the
+  //! compute the first derivative in v direction of the
   //! section for v =  param
   Standard_EXPORT virtual Standard_Boolean D1(const Standard_Real   Param,
                                               const Standard_Real   First,
@@ -76,8 +76,8 @@ public:
                                               TColStd_Array1OfReal& Weigths,
                                               TColStd_Array1OfReal& DWeigths) Standard_OVERRIDE;
 
-  //! compute the second derivative  in v direction of the
-  //! section  for v = param
+  //! compute the second derivative in v direction of the
+  //! section for v = param
   Standard_EXPORT virtual Standard_Boolean D2(const Standard_Real   Param,
                                               const Standard_Real   First,
                                               const Standard_Real   Last,
@@ -91,10 +91,10 @@ public:
                                               TColStd_Array1OfReal& DWeigths,
                                               TColStd_Array1OfReal& D2Weigths) Standard_OVERRIDE;
 
-  //! get the number of 2d curves to  approximate.
+  //! get the number of 2d curves to approximate.
   Standard_EXPORT virtual Standard_Integer Nb2dCurves() const Standard_OVERRIDE;
 
-  //! get the format of an  section
+  //! get the format of an section
   Standard_EXPORT virtual void SectionShape(Standard_Integer& NbPoles,
                                             Standard_Integer& NbKnots,
                                             Standard_Integer& Degree) const Standard_OVERRIDE;
@@ -108,15 +108,15 @@ public:
   //! Returns if the section is rational or not
   Standard_EXPORT virtual Standard_Boolean IsRational() const Standard_OVERRIDE;
 
-  //! Returns  the number  of  intervals for  continuity
+  //! Returns the number of intervals for continuity
   //! <S>. May be one if Continuity(me) >= <S>
   Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const
     Standard_OVERRIDE;
 
-  //! 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 Standard_OVERRIDE;
@@ -138,23 +138,23 @@ public:
                                             const Standard_Real   AngleTol,
                                             TColStd_Array1OfReal& Tol3d) const Standard_OVERRIDE;
 
-  //! Is usfull, if (me) have to  be run numerical
-  //! algorithme to perform D0, D1 or D2
+  //! Is useful, if (me) have to  be run numerical
+  //! algorithm to perform D0, D1 or D2
   Standard_EXPORT virtual void SetTolerance(const Standard_Real Tol3d,
                                             const Standard_Real Tol2d) Standard_OVERRIDE;
 
-  //! Get    the   barycentre of   Surface.   An   very  poor
+  //! Get the barycentre of Surface. An very poor
   //! estimation is sufficient. This information is useful
   //! to perform well conditioned rational approximation.
   Standard_EXPORT virtual gp_Pnt BarycentreOfSurf() const Standard_OVERRIDE;
 
-  //! Returns the   length of the maximum section. This
+  //! Returns the length of the maximum section. This
   //! information is useful to perform well conditioned rational
   //! approximation.
   Standard_EXPORT virtual Standard_Real MaximalSection() const Standard_OVERRIDE;
 
   //! Compute the minimal value of weight for each poles
-  //! of all  sections.  This information is  useful to
+  //! of all sections. This information is useful to
   //! perform well conditioned rational approximation.
   Standard_EXPORT virtual void GetMinimalWeight(TColStd_Array1OfReal& Weigths) const
     Standard_OVERRIDE;

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_ConstantBiNormal.hxx

@@ -31,7 +31,7 @@ class gp_Dir;
 class GeomFill_ConstantBiNormal;
 DEFINE_STANDARD_HANDLE(GeomFill_ConstantBiNormal, GeomFill_TrihedronLaw)
 
-//! Defined an Trihedron Law  where the BiNormal, is fixed
+//! Defined a Trihedron Law where the BiNormal, is fixed
 class GeomFill_ConstantBiNormal : public GeomFill_TrihedronLaw
 {
 
@@ -51,9 +51,9 @@ public:
                                               gp_Vec&             Normal,
                                               gp_Vec&             BiNormal) Standard_OVERRIDE;
 
-  //! Computes Triedrhon and  derivative Trihedron  on curve
+  //! Computes Triedrhon and derivative Trihedron on curve
   //! at parameter <Param>
-  //! Warning : It used only for C1 or C2 approximation
+  //! Warning: It used only for C1 or C2 approximation
   Standard_EXPORT virtual Standard_Boolean D1(const Standard_Real Param,
                                               gp_Vec&             Tangent,
                                               gp_Vec&             DTangent,
@@ -62,9 +62,9 @@ public:
                                               gp_Vec&             BiNormal,
                                               gp_Vec&             DBiNormal) Standard_OVERRIDE;
 
-  //! compute  Trihedron on curve
-  //! first and seconde  derivatives.
-  //! Warning : It used only for C2 approximation
+  //! compute Trihedron on curve
+  //! first and second derivatives.
+  //! Warning: It used only for C2 approximation
   Standard_EXPORT virtual Standard_Boolean D2(const Standard_Real Param,
                                               gp_Vec&             Tangent,
                                               gp_Vec&             DTangent,
@@ -76,22 +76,21 @@ public:
                                               gp_Vec&             DBiNormal,
                                               gp_Vec&             D2BiNormal) Standard_OVERRIDE;
 
-  //! Returns  the number  of  intervals for  continuity
-  //! <S>.
+  //! Returns the number of intervals for continuity <S>.
   //! May be one if Continuity(me) >= <S>
   Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const
     Standard_OVERRIDE;
 
-  //! 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 Standard_OVERRIDE;
 
-  //! Gets average value of Tangent(t) and Normal(t) it is usfull to
-  //! make fast approximation of rational  surfaces.
+  //! Gets average value of Tangent(t) and Normal(t) it is useful to
+  //! make fast approximation of rational surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
                                              gp_Vec& ANormal,
                                              gp_Vec& ABiNormal) Standard_OVERRIDE;

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_CorrectedFrenet.hxx

@@ -110,7 +110,7 @@ public:
   //! the curve must be set by method SetCurve.
   Standard_EXPORT GeomFill_Trihedron EvaluateBestMode();
 
-  //! Get average value of Tangent(t) and Normal(t) it is usfull to
+  //! Get average value of Tangent(t) and Normal(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
                                              gp_Vec& ANormal,

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_CurveAndTrihedron.hxx

@@ -127,10 +127,10 @@ public:
                                          Standard_Real& Last) const Standard_OVERRIDE;
 
   //! Get the maximum Norm  of the matrix-location part.  It
-  //! is usful to find an good Tolerance to approx M(t).
+  //! is usful to find a good Tolerance to approx M(t).
   Standard_EXPORT virtual Standard_Real GetMaximalNorm() Standard_OVERRIDE;
 
-  //! Get average value of M(t) and V(t) it is usfull to
+  //! Get average value of M(t) and V(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Mat& AM, gp_Vec& AV) Standard_OVERRIDE;
 

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_Darboux.hxx

@@ -83,7 +83,7 @@ public:
   Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
                                          const GeomAbs_Shape   S) const Standard_OVERRIDE;
 
-  //! Get average value of Tangent(t) and Normal(t) it is usfull to
+  //! Get average value of Tangent(t) and Normal(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
                                              gp_Vec& ANormal,

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_Fixed.hxx

@@ -82,7 +82,7 @@ public:
   Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
                                          const GeomAbs_Shape   S) const Standard_OVERRIDE;
 
-  //! Get average value of Tangent(t) and Normal(t) it is usfull to
+  //! Get average value of Tangent(t) and Normal(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
                                              gp_Vec& ANormal,

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_Frenet.hxx

@@ -91,7 +91,7 @@ public:
   Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
                                          const GeomAbs_Shape   S) const Standard_OVERRIDE;
 
-  //! Get average value of Tangent(t) and Normal(t) it is usfull to
+  //! Get average value of Tangent(t) and Normal(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
                                              gp_Vec& ANormal,

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_GuideTrihedronAC.hxx

@@ -93,7 +93,7 @@ public:
   Standard_EXPORT virtual void SetInterval(const Standard_Real First,
                                            const Standard_Real Last) Standard_OVERRIDE;
 
-  //! Get average value of M(t) and V(t) it is usfull to
+  //! Get average value of M(t) and V(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
                                              gp_Vec& ANormal,

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_GuideTrihedronPlan.hxx

@@ -100,7 +100,7 @@ public:
   Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T,
                                          const GeomAbs_Shape   S) const Standard_OVERRIDE;
 
-  //! Get average value of M(t) and V(t) it is usfull to
+  //! Get average value of M(t) and V(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
                                              gp_Vec& ANormal,

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_LocationDraft.hxx

@@ -141,7 +141,7 @@ public:
                                          Standard_Real& Last) const Standard_OVERRIDE;
 
   //! 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.
   //! Warning: Used only if Nb2dCurve > 0
   Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
@@ -150,10 +150,10 @@ public:
                                           Standard_Real&         TolV) const Standard_OVERRIDE;
 
   //! Get the maximum Norm  of the matrix-location part.  It
-  //! is usful to find an good Tolerance to approx M(t).
+  //! is usful to find a good Tolerance to approx M(t).
   Standard_EXPORT virtual Standard_Real GetMaximalNorm() Standard_OVERRIDE;
 
-  //! Get average value of M(t) and V(t) it is usfull to
+  //! Get average value of M(t) and V(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Mat& AM, gp_Vec& AV) Standard_OVERRIDE;
 

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_LocationGuide.hxx

@@ -160,7 +160,7 @@ public:
                                             const Standard_Real Tol2d) Standard_OVERRIDE;
 
   //! 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.
   //! Warning: Used only if Nb2dCurve > 0
   Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
@@ -169,10 +169,10 @@ public:
                                           Standard_Real&         TolV) const Standard_OVERRIDE;
 
   //! Get the maximum Norm  of the matrix-location part.  It
-  //! is usful to find an good Tolerance to approx M(t).
+  //! is usful to find a good Tolerance to approx M(t).
   Standard_EXPORT virtual Standard_Real GetMaximalNorm() Standard_OVERRIDE;
 
-  //! Get average value of M(t) and V(t) it is usfull to
+  //! Get average value of M(t) and V(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Mat& AM, gp_Vec& AV) Standard_OVERRIDE;
 

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_LocationLaw.hxx

@@ -135,7 +135,7 @@ public:
   Standard_EXPORT virtual void GetDomain(Standard_Real& First, Standard_Real& Last) const = 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,
@@ -148,10 +148,10 @@ public:
   Standard_EXPORT virtual void SetTolerance(const Standard_Real Tol3d, const Standard_Real Tol2d);
 
   //! Get the maximum Norm  of the matrix-location part.  It
-  //! is usful to find an good Tolerance to approx M(t).
+  //! is usful to find a good Tolerance to approx M(t).
   Standard_EXPORT virtual Standard_Real GetMaximalNorm() = 0;
 
-  //! Get average value of M(t) and V(t) it is usfull to
+  //! Get average value of M(t) and V(t) it is useful to
   //! make fast approximation of rational surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Mat& AM, gp_Vec& AV) = 0;
 

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_SweepFunction.hxx

@@ -123,7 +123,7 @@ public:
                                            const Standard_Real Last) Standard_OVERRIDE;
 
   //! 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.
   //! Warning: Used only if Nb2dCurve > 0
   Standard_EXPORT virtual void Resolution(const Standard_Integer Index,
@@ -141,7 +141,7 @@ public:
                                             const Standard_Real   AngleTol,
                                             TColStd_Array1OfReal& Tol3d) const Standard_OVERRIDE;
 
-  //! Is usfull, if (me) have to  be run numerical
+  //! Is useful, if (me) have to  be run numerical
   //! algorithme to perform D0, D1 or D2
   Standard_EXPORT virtual void SetTolerance(const Standard_Real Tol3d,
                                             const Standard_Real Tol2d) Standard_OVERRIDE;

src/ModelingAlgorithms/TKGeomAlgo/GeomFill/GeomFill_TrihedronLaw.hxx

@@ -95,7 +95,7 @@ public:
   //! the function
   Standard_EXPORT void GetInterval(Standard_Real& First, Standard_Real& Last);
 
-  //! Get average value of M(t) and V(t) it is usfull to
+  //! Get average value of M(t) and V(t) it is useful to
   //! make fast approximation of rational  surfaces.
   Standard_EXPORT virtual void GetAverageLaw(gp_Vec& ATangent,
                                              gp_Vec& ANormal,