From: luzpaz Date: Wed, 29 Oct 2025 17:57:19 +0000 (-0400) Subject: Documentation - Fix whitespace and typos (#772) X-Git-Url: http://git.dev.opencascade.org/gitweb/?a=commitdiff_plain;h=ae33c4ef42e6f49b9e222ed68fda541013bfa85a;p=occt.git Documentation - Fix whitespace and typos (#772) - Corrected spelling errors (e.g., "aera" → "area", "nithing" → "nothing") - Normalized excessive whitespace in comments for better readability - Standardized comment formatting while preserving technical content --- diff --git a/src/Draw/TKDraw/DBRep/DBRep.hxx b/src/Draw/TKDraw/DBRep/DBRep.hxx index d6e0698b6e..2d6c16402c 100644 --- a/src/Draw/TKDraw/DBRep/DBRep.hxx +++ b/src/Draw/TKDraw/DBRep/DBRep.hxx @@ -34,8 +34,8 @@ public: //! Creation of isoparametric curves. //! Implements ProgressIndicator for DRAW - //! Sets in the variable . Overwrite the - //! variable if already set. + //! Sets in the variable . + //! Overwrite the variable if already set. Standard_EXPORT static void Set(const Standard_CString Name, const TopoDS_Shape& S); //! Returns the shape in the variable. diff --git a/src/Draw/TKDraw/DBRep/DBRep_DrawableShape.hxx b/src/Draw/TKDraw/DBRep/DBRep_DrawableShape.hxx index 4c8186acda..610a538e53 100644 --- a/src/Draw/TKDraw/DBRep/DBRep_DrawableShape.hxx +++ b/src/Draw/TKDraw/DBRep/DBRep_DrawableShape.hxx @@ -63,15 +63,15 @@ public: //! Return const & Standard_EXPORT TopoDS_Shape Shape() const; - //! When True the orientations of the edges and free - //! vertices are displayed. + //! When True the orientations of the edges and free + //! vertices are displayed. Standard_EXPORT void DisplayOrientation(const Standard_Boolean D); - //! When True the triangulations of the faces + //! When True the triangulations of the faces //! are displayed even if there is a surface. Standard_EXPORT void DisplayTriangulation(const Standard_Boolean D); - //! When True the polygons of the edges + //! When True the polygons of the edges //! are displayed even if there is a geometric curve. Standard_EXPORT void DisplayPolygons(const Standard_Boolean D); diff --git a/src/Draw/TKDraw/Draw/Draw.hxx b/src/Draw/TKDraw/Draw/Draw.hxx index 9d1f10cc08..eb8335b4be 100644 --- a/src/Draw/TKDraw/Draw/Draw.hxx +++ b/src/Draw/TKDraw/Draw/Draw.hxx @@ -51,7 +51,7 @@ public: //! @name Tcl variables management tools const Handle(Draw_Drawable3D)& D, const Standard_Boolean Disp); - //! Sets a variable, a null handle clear the + //! Sets a variable, a null handle clear the //! vartiable. Automatic display is context driven. Standard_EXPORT static void Set(const Standard_CString Name, const Handle(Draw_Drawable3D)& D); @@ -76,7 +76,7 @@ public: //! @name Tcl variables management tools return getDrawable(aName, Standard_False); } - //! Gets a numeric variable. Returns True if the + //! Gets a numeric variable. Returns True if the //! variable exist. Standard_EXPORT static Standard_Boolean Get(const Standard_CString Name, Standard_Real& val); diff --git a/src/Draw/TKDraw/Draw/Draw_Display.hxx b/src/Draw/TKDraw/Draw/Draw_Display.hxx index 06c10bdd58..e5005e3006 100644 --- a/src/Draw/TKDraw/Draw/Draw_Display.hxx +++ b/src/Draw/TKDraw/Draw/Draw_Display.hxx @@ -28,9 +28,9 @@ class gp_Pnt2d; class gp_Circ; class gp_Circ2d; -//! Use to draw in a 3d or a 2d view. +//! Use to draw in a 3d or a 2d view. //! -//! * The 3d methods draw in the 3d system, in a 2d +//! * The 3d methods draw in the 3d system, in a 2d //! view the drawing is projected on X,Y. //! //! * The 2d methods draw in the projection plane. @@ -64,16 +64,16 @@ public: Standard_EXPORT void Draw(const gp_Pnt2d& p1, const gp_Pnt2d& p2); - //! Draw a circle from angle to - //! (Radians). if ModifyWithZoom = 0, then + //! Draw a circle from angle to + //! (Radians). if ModifyWithZoom = 0, then //! rayon of circle is convert to Integer. Standard_EXPORT void Draw(const gp_Circ& C, const Standard_Real A1, const Standard_Real A2, const Standard_Boolean ModifyWithZoom = Standard_True); - //! Draw a 2D circle from angle to - //! (Radians). if ModifyWithZoom = 0, then + //! Draw a 2D circle from angle to + //! (Radians). if ModifyWithZoom = 0, then //! rayon of circle is convert to Integer. Standard_EXPORT void Draw(const gp_Circ2d& C, const Standard_Real A1, @@ -119,15 +119,15 @@ public: //! Returns the current Zoom value. Standard_EXPORT Standard_Real Zoom() const; - //! Returns the identifier of the view where the + //! Returns the identifier of the view where the //! display is drawing. Standard_EXPORT Standard_Integer ViewId() const; - //! Returns True if the last drawing operations - //! generated a pick hit. When HasPicked is True the + //! Returns True if the last drawing operations + //! generated a pick hit. When HasPicked is True the //! Drawing should be resumed. //! - //! This function is used to shorten the drawing when + //! This function is used to shorten the drawing when //! picking and to save the picked sub-parts. Standard_EXPORT Standard_Boolean HasPicked() const; diff --git a/src/ModelingAlgorithms/TKGeomAlgo/Law/Law_BSpline.hxx b/src/ModelingAlgorithms/TKGeomAlgo/Law/Law_BSpline.hxx index 623926a7ae..2c76a9f744 100644 --- a/src/ModelingAlgorithms/TKGeomAlgo/Law/Law_BSpline.hxx +++ b/src/ModelingAlgorithms/TKGeomAlgo/Law/Law_BSpline.hxx @@ -38,29 +38,29 @@ DEFINE_STANDARD_HANDLE(Law_BSpline, Standard_Transient) //! Rational or non-rational //! Periodic or non-periodic //! -//! a b-spline curve is defined by : +//! A b-spline curve is defined by: //! //! The Degree (up to 25) //! -//! The Poles (and the weights if it is rational) +//! The Poles (and the weights if it is rational) //! //! The Knots and Multiplicities //! -//! The knot vector is an increasing sequence of -//! reals without repetition. The multiplicities are +//! The knot vector is an increasing sequence of +//! reals without repetition. The multiplicities are //! the repetition of the knots. //! //! If the knots are regularly spaced (the difference -//! of two consecutive knots is a constant), the -//! knots repartition is : +//! of two consecutive knots is a constant), the +//! knots repartition is: //! //! - Uniform if all multiplicities are 1. //! -//! - Quasi-uniform if all multiplicities are 1 +//! - Quasi-uniform if all multiplicities are 1 //! but the first and the last which are Degree+1. //! -//! - PiecewiseBezier if all multiplicities are -//! Degree but the first and the last which are +//! - PiecewiseBezier if all multiplicities are +//! Degree but the first and the last which are //! Degree+1. //! //! The curve may be periodic. @@ -68,7 +68,7 @@ DEFINE_STANDARD_HANDLE(Law_BSpline, Standard_Transient) //! On a periodic curve if there are k knots and p //! poles. the period is knot(k) - knot(1) //! -//! the poles and knots are infinite vectors with : +//! the poles and knots are infinite vectors with: //! //! knot(i+k) = knot(i) + period //! @@ -88,7 +88,7 @@ class Law_BSpline : public Standard_Transient { public: - //! Creates a non-rational B_spline curve on the + //! Creates a non-rational B_spline curve on the //! basis of degree . Standard_EXPORT Law_BSpline(const TColStd_Array1OfReal& Poles, const TColStd_Array1OfReal& Knots, @@ -96,7 +96,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 //! of degree . Standard_EXPORT Law_BSpline(const TColStd_Array1OfReal& Poles, const TColStd_Array1OfReal& Weights, @@ -105,90 +105,90 @@ public: const Standard_Integer Degree, const Standard_Boolean Periodic = Standard_False); - //! Increase the degree to . Nothing is done - //! if is lower or equal to the current + //! Increase the degree to . Nothing is done + //! if is lower or equal to the current //! degree. Standard_EXPORT void IncreaseDegree(const Standard_Integer Degree); - //! Increases the multiplicity of the knot to + //! Increases the multiplicity of the knot to //! . //! - //! If is lower or equal to the current - //! multiplicity nothing is done. If is higher than - //! the degree the degree is used. + //! If is lower or equal to the current multiplicity + //! nothing is done. If is higher than the degree + //! the degree is used. //! If is not in [FirstUKnotIndex, LastUKnotIndex] Standard_EXPORT void IncreaseMultiplicity(const Standard_Integer Index, const Standard_Integer M); - //! Increases the multiplicities of the knots in + //! Increases the multiplicities of the knots in //! [I1,I2] to . //! - //! For each knot if is lower or equal to the - //! current multiplicity nothing is done. If is + //! For each knot if is lower or equal to the + //! current multiplicity nothing is done. If is //! higher than the degree the degree is used. //! If are not in [FirstUKnotIndex, LastUKnotIndex] Standard_EXPORT void IncreaseMultiplicity(const Standard_Integer I1, const Standard_Integer I2, const Standard_Integer M); - //! Increment the multiplicities of the knots in + //! Increment the multiplicities of the knots in //! [I1,I2] by . //! - //! If is not positive nithing is done. + //! If is not positive nothing is done. //! - //! For each knot the resulting multiplicity is + //! For each knot the resulting multiplicity is //! limited to the Degree. //! If are not in [FirstUKnotIndex, LastUKnotIndex] Standard_EXPORT void IncrementMultiplicity(const Standard_Integer I1, const Standard_Integer I2, const Standard_Integer M); - //! Inserts a knot value in the sequence of knots. If - //! is an existing knot the multiplicity is + //! Inserts a knot value in the sequence of knots. + //! If is an existing knot the multiplicity is //! increased by . //! - //! If U is not on the parameter range nothing is + //! If U is not on the parameter range nothing is //! done. //! //! If the multiplicity is negative or null nothing is - //! done. The new multiplicity is limited to the + //! done. The new multiplicity is limited to the //! degree. //! - //! The tolerance criterion for knots equality is + //! The tolerance criterion for knots equality is //! the max of Epsilon(U) and ParametricTolerance. Standard_EXPORT void InsertKnot(const Standard_Real U, const Standard_Integer M = 1, const Standard_Real ParametricTolerance = 0.0, const Standard_Boolean Add = Standard_True); - //! Inserts a set of knots values in the sequence of + //! Inserts a set of knots values in the sequence of //! knots. //! //! For each U = Knots(i), M = Mults(i) //! - //! If is an existing knot the multiplicity is - //! increased by if is True, increased to + //! If is an existing knot the multiplicity is + //! increased by if is True, increased to //! if is False. //! - //! If U is not on the parameter range nothing is + //! If U is not on the parameter range nothing is //! done. //! //! If the multiplicity is negative or null nothing is - //! done. The new multiplicity is limited to the + //! done. The new multiplicity is limited to the //! degree. //! - //! The tolerance criterion for knots equality is + //! The tolerance criterion for knots equality is //! the max of Epsilon(U) and ParametricTolerance. Standard_EXPORT void InsertKnots(const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults, const Standard_Real ParametricTolerance = 0.0, const Standard_Boolean Add = Standard_False); - //! Decrement the knots multiplicity to . If M is - //! 0 the knot is removed. The Poles sequence is + //! Decrement the knots multiplicity to . If M is + //! 0 the knot is removed. The Poles sequence is //! modified. //! - //! As there are two ways to compute the new poles the - //! average is computed if the distance is lower than + //! As there are two ways to compute the new poles the + //! average is computed if the distance is lower than //! the , else False is returned. //! //! A low tolerance is used to prevent the modification @@ -200,7 +200,7 @@ public: //! [FirstUKnotIndex, LastUKnotIndex] //! pole insertion and pole removing //! this operation is limited to the Uniform or QuasiUniform - //! BSplineCurve. The knot values are modified . If the BSpline is + //! BSplineCurve. The knot values are modified. If the BSpline is //! NonUniform or Piecewise Bezier an exception Construction error //! is raised. Standard_EXPORT Standard_Boolean RemoveKnot(const Standard_Integer Index, @@ -359,16 +359,16 @@ public: Standard_Real& V2, Standard_Real& V3) const; - //! 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 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 domain Knot - //! (FromK1), Knot (ToK2) the evaluations are the same as if we - //! consider the whole definition of the curve. Of course the + //! 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 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 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 this parametric domain. Standard_EXPORT Standard_Real DN(const Standard_Real U, const Standard_Integer N) const; @@ -569,7 +569,7 @@ private: //! the answer will be false Standard_EXPORT Standard_Boolean IsCacheValid(const Standard_Real Parameter) const; - //! Recompute the flatknots, the knotsdistribution, the + //! Recompute the flatknots, the knotsdistribution, the //! continuity. Standard_EXPORT void UpdateKnots(); diff --git a/src/ModelingData/TKG3d/GProp/GProp.hxx b/src/ModelingData/TKG3d/GProp/GProp.hxx index 94719e6f99..8c29acb074 100644 --- a/src/ModelingData/TKG3d/GProp/GProp.hxx +++ b/src/ModelingData/TKG3d/GProp/GProp.hxx @@ -31,14 +31,14 @@ class gp_Mat; //! geometric system (heterogeneous composition of the previous //! entities). //! -//! Global properties are : +//! Global properties are: //! . length, area, volume, //! . centre of mass, //! . axis of inertia, //! . moments of inertia, //! . radius of gyration. //! -//! It provides also a class to compile the average point or +//! It provides also a class to compile the average point or //! line of a set of points. class GProp { @@ -48,12 +48,12 @@ public: //! methods of package //! Computes the matrix Operator, referred to as the //! "Huyghens Operator" of a geometric system at the - //! point Q of the space, using the following data : + //! point Q of the space, using the following data: //! - Mass, i.e. the mass of the system, //! - G, the center of mass of the system. //! The "Huyghens Operator" is used to compute //! Inertia/Q, the matrix of inertia of the system at - //! the point Q using Huyghens' theorem : + //! the point Q using Huyghens' theorem: //! Inertia/Q = Inertia/G + HOperator (Q, G, Mass) //! where Inertia/G is the matrix of inertia of the //! system relative to its center of mass as returned by diff --git a/src/ModelingData/TKG3d/GProp/GProp_GProps.hxx b/src/ModelingData/TKG3d/GProp/GProp_GProps.hxx index ab48e59f7b..4db2e348a3 100644 --- a/src/ModelingData/TKG3d/GProp/GProp_GProps.hxx +++ b/src/ModelingData/TKG3d/GProp/GProp_GProps.hxx @@ -26,9 +26,9 @@ class gp_Ax1; class GProp_PrincipalProps; //! Implements a general mechanism to compute the global properties of -//! a "compound geometric system" in 3d space by composition of the -//! global properties of "elementary geometric entities" such as -//! (curve, surface, solid, set of points). It is possible to compose +//! a "compound geometric system" in 3d space by composition of the +//! global properties of "elementary geometric entities" such as +//! (curve, surface, solid, set of points). It is possible to compose //! the properties of several "compound geometric systems" too. //! //! To computes the global properties of a compound geometric diff --git a/src/ModelingData/TKG3d/GProp/GProp_PrincipalProps.hxx b/src/ModelingData/TKG3d/GProp/GProp_PrincipalProps.hxx index d9867189c1..4660e6a031 100644 --- a/src/ModelingData/TKG3d/GProp/GProp_PrincipalProps.hxx +++ b/src/ModelingData/TKG3d/GProp/GProp_PrincipalProps.hxx @@ -53,25 +53,25 @@ public: Standard_EXPORT GProp_PrincipalProps(); //! returns true if the geometric system has an axis of symmetry. - //! For comparing moments relative tolerance 1.e-10 is used. - //! Usually it is enough for objects, restricted by faces with - //! analytical geometry. + //! For comparing moments relative tolerance 1.e-10 is used. + //! Usually it is enough for objects, restricted by faces with + //! analytical geometry. Standard_EXPORT Standard_Boolean HasSymmetryAxis() const; //! returns true if the geometric system has an axis of symmetry. - //! aTol is relative tolerance for checking equality of moments - //! If aTol == 0, relative tolerance is ~ 1.e-16 (Epsilon(I)) + //! aTol is relative tolerance for checking equality of moments + //! If aTol == 0, relative tolerance is ~ 1.e-16 (Epsilon(I)) Standard_EXPORT Standard_Boolean HasSymmetryAxis(const Standard_Real aTol) const; //! returns true if the geometric system has a point of symmetry. - //! For comparing moments relative tolerance 1.e-10 is used. - //! Usually it is enough for objects, restricted by faces with - //! analytical geometry. + //! For comparing moments relative tolerance 1.e-10 is used. + //! Usually it is enough for objects, restricted by faces with + //! analytical geometry. Standard_EXPORT Standard_Boolean HasSymmetryPoint() const; //! returns true if the geometric system has a point of symmetry. - //! aTol is relative tolerance for checking equality of moments - //! If aTol == 0, relative tolerance is ~ 1.e-16 (Epsilon(I)) + //! aTol is relative tolerance for checking equality of moments + //! If aTol == 0, relative tolerance is ~ 1.e-16 (Epsilon(I)) Standard_EXPORT Standard_Boolean HasSymmetryPoint(const Standard_Real aTol) const; //! Ixx, Iyy and Izz return the principal moments of inertia diff --git a/src/ModelingData/TKG3d/Geom/Geom_BSplineCurve.hxx b/src/ModelingData/TKG3d/Geom/Geom_BSplineCurve.hxx index dbdda27460..38840ee909 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_BSplineCurve.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_BSplineCurve.hxx @@ -206,53 +206,53 @@ public: const Standard_Integer I2, const Standard_Integer M); - //! Increment the multiplicities of the knots in + //! Increment the multiplicities of the knots in //! [I1,I2] by . //! - //! If is not positive nithing is done. + //! If is not positive nothing is done. //! - //! For each knot the resulting multiplicity is + //! For each knot the resulting multiplicity is //! limited to the Degree. //! If are not in [FirstUKnotIndex, LastUKnotIndex] Standard_EXPORT void IncrementMultiplicity(const Standard_Integer I1, const Standard_Integer I2, const Standard_Integer M); - //! Inserts a knot value in the sequence of knots. If - //! is an existing knot the multiplicity is + //! Inserts a knot value in the sequence of knots. + //! If is an existing knot the multiplicity is //! increased by . //! - //! If U is not on the parameter range nothing is + //! If U is not on the parameter range nothing is //! done. //! - //! If the multiplicity is negative or null nothing is - //! done. The new multiplicity is limited to the + //! If the multiplicity is negative or null nothing + //! is done. The new multiplicity is limited to the //! degree. //! - //! The tolerance criterion for knots equality is + //! The tolerance criterion for knots equality is //! the max of Epsilon(U) and ParametricTolerance. Standard_EXPORT void InsertKnot(const Standard_Real U, const Standard_Integer M = 1, const Standard_Real ParametricTolerance = 0.0, const Standard_Boolean Add = Standard_True); - //! Inserts a set of knots values in the sequence of + //! Inserts a set of knots values in the sequence of //! knots. //! //! For each U = Knots(i), M = Mults(i) //! - //! If is an existing knot the multiplicity is - //! increased by if is True, increased to + //! If is an existing knot the multiplicity is + //! increased by if is True, increased to //! if is False. //! - //! If U is not on the parameter range nothing is + //! If U is not on the parameter range nothing is //! done. //! - //! If the multiplicity is negative or null nothing is - //! done. The new multiplicity is limited to the + //! If the multiplicity is negative or null nothing + //! is done. The new multiplicity is limited to the //! degree. //! - //! The tolerance criterion for knots equality is + //! The tolerance criterion for knots equality is //! the max of Epsilon(U) and ParametricTolerance. Standard_EXPORT void InsertKnots(const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults, @@ -273,8 +273,8 @@ public: //! A low tolerance is used to prevent modification of //! the curve. A high tolerance is used to "smooth" the curve. //! Exceptions - //! Standard_OutOfRange if Index is outside the - //! bounds of the knots table. + //! Standard_OutOfRange if Index is outside the bounds of the + //! knots table. //! pole insertion and pole removing //! this operation is limited to the Uniform or QuasiUniform //! BSplineCurve. The knot values are modified . If the BSpline is @@ -292,7 +292,7 @@ public: //! of the reversed curve. 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 . //! //! returns UFirst + ULast - U @@ -555,7 +555,7 @@ public: //! 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 diff --git a/src/ModelingData/TKG3d/Geom/Geom_BSplineSurface.hxx b/src/ModelingData/TKG3d/Geom/Geom_BSplineSurface.hxx index 77954d4578..d4e7933d5e 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_BSplineSurface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_BSplineSurface.hxx @@ -158,24 +158,24 @@ class Geom_BSplineSurface : public Geom_BoundedSurface { public: - //! Creates a non-rational b-spline surface (weights + //! Creates a non-rational b-spline surface (weights //! default value is 1.). //! The following conditions must be verified. //! 0 < UDegree <= MaxDegree. //! UKnots.Length() == UMults.Length() >= 2 //! UKnots(i) < UKnots(i+1) (Knots are increasing) //! 1 <= UMults(i) <= UDegree - //! On a non uperiodic surface the first and last - //! umultiplicities may be UDegree+1 (this is even + //! On a non uperiodic surface the first and last + //! umultiplicities may be UDegree+1 (this is even //! recommended if you want the curve to start and finish on //! the first and last pole). - //! On a uperiodic surface the first and the last + //! On a uperiodic surface the first and the last //! umultiplicities must be the same. //! on non-uperiodic surfaces //! Poles.ColLength() == Sum(UMults(i)) - UDegree - 1 >= 2 //! on uperiodic surfaces //! Poles.ColLength() == Sum(UMults(i)) except the first or last - //! The previous conditions for U holds also for V, with the + //! The previous conditions for U holds also for V, with the //! RowLength of the poles. Standard_EXPORT Geom_BSplineSurface(const TColgp_Array2OfPnt& Poles, const TColStd_Array1OfReal& UKnots, @@ -198,12 +198,12 @@ public: //! UKnots(i) < UKnots(i+1) (Knots are increasing) //! 1 <= UMults(i) <= UDegree //! - //! On a non uperiodic surface the first and last - //! umultiplicities may be UDegree+1 (this is even - //! recommended if you want the curve to start and finish on - //! the first and last pole). + //! On a non uperiodic surface the first and last + //! umultiplicities may be UDegree+1 (this is even recommended + //! if you want the curve to start and finish on the first + //! and last pole). //! - //! On a uperiodic surface the first and the last + //! On a uperiodic surface the first and the last //! umultiplicities must be the same. //! //! on non-uperiodic surfaces @@ -215,7 +215,7 @@ public: //! Poles.ColLength() == Sum(UMults(i)) except the first or //! last //! - //! The previous conditions for U holds also for V, with the + //! The previous conditions for U holds also for V, with the //! RowLength of the poles. Standard_EXPORT Geom_BSplineSurface(const TColgp_Array2OfPnt& Poles, const TColStd_Array2OfReal& Weights, diff --git a/src/ModelingData/TKG3d/Geom/Geom_CartesianPoint.hxx b/src/ModelingData/TKG3d/Geom/Geom_CartesianPoint.hxx index 3d97bee8b2..99aa2961ea 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_CartesianPoint.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_CartesianPoint.hxx @@ -51,13 +51,13 @@ public: //! Set to P.X(), P.Y(), P.Z() coordinates. Standard_EXPORT void SetPnt(const gp_Pnt& P); - //! Changes the X coordinate of me. + //! Changes the X coordinate of . Standard_EXPORT void SetX(const Standard_Real X); - //! Changes the Y coordinate of me. + //! Changes the Y coordinate of . Standard_EXPORT void SetY(const Standard_Real Y); - //! Changes the Z coordinate of me. + //! Changes the Z coordinate of . Standard_EXPORT void SetZ(const Standard_Real Z); //! Returns the coordinates of . diff --git a/src/ModelingData/TKG3d/Geom/Geom_Curve.hxx b/src/ModelingData/TKG3d/Geom/Geom_Curve.hxx index 475df8a846..26a9e88c30 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_Curve.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_Curve.hxx @@ -62,9 +62,9 @@ class Geom_Curve : public Geom_Geometry public: //! Changes the direction of parametrization of . //! 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; @@ -78,7 +78,7 @@ public: //! me->Value(U) Standard_EXPORT virtual Standard_Real ReversedParameter(const Standard_Real U) const = 0; - //! 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->Transformed(T)->Value(me->TransformedParameter(U,T)) @@ -93,8 +93,8 @@ public: Standard_EXPORT virtual Standard_Real TransformedParameter(const Standard_Real U, const gp_Trsf& T) const; - //! 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 . //! //! Transformed(T)->Value(U * ParametricTransformation(T)) @@ -169,8 +169,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 @@ -204,7 +204,7 @@ public: //! order of derivation N. //! Raised if the continuity of the curve is not CN. //! - //! Raised if the derivative cannot be computed + //! Raised if the derivative cannot be computed //! easily. e.g. rational bspline and n > 3. //! Raised if N < 1. Standard_EXPORT virtual gp_Vec DN(const Standard_Real U, const Standard_Integer N) const = 0; diff --git a/src/ModelingData/TKG3d/Geom/Geom_CylindricalSurface.hxx b/src/ModelingData/TKG3d/Geom/Geom_CylindricalSurface.hxx index a6c3aae047..c26a1191e5 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_CylindricalSurface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_CylindricalSurface.hxx @@ -54,9 +54,9 @@ DEFINE_STANDARD_HANDLE(Geom_CylindricalSurface, Geom_ElementarySurface) //! @endcode //! //! The "XAxis" and the "YAxis" define the placement plane of the -//! surface (Z = 0, and parametric value V = 0) perpendicular to +//! surface (Z = 0, and parametric value V = 0) perpendicular to //! the symmetry axis. The "XAxis" defines the origin of the -//! parameter U = 0. The trigonometric sense gives the positive +//! parameter U = 0. The trigonometric sense gives the positive //! orientation for the parameter U. //! //! When you create a CylindricalSurface the U and V directions of @@ -93,17 +93,17 @@ public: //! returns a non transient cylinder with the same geometric properties as . Standard_EXPORT gp_Cylinder Cylinder() const; - //! Return the parameter on the Ureversed surface for + //! Return the parameter on the Ureversed surface for //! the point of parameter U on . //! Return 2.PI - U. Standard_EXPORT Standard_Real UReversedParameter(const Standard_Real U) const Standard_OVERRIDE; - //! Return the parameter on the Vreversed surface for + //! Return the parameter on the Vreversed surface for //! the point of parameter V on . //! Return -V Standard_EXPORT Standard_Real VReversedParameter(const Standard_Real V) const Standard_OVERRIDE; - //! Computes the parameters on the transformed surface for + //! Computes the parameters on the transformed surface for //! the transform of the point of parameters U,V on . //! @code //! me->Transformed(T)->Value(U',V') @@ -218,7 +218,7 @@ public: gp_Vec& D2UV) const Standard_OVERRIDE; //! Computes the current point, the first, the second and the - //! third derivatives in the directions U and V. + //! third derivatives in the directions U and V. Standard_EXPORT void D3(const Standard_Real U, const Standard_Real V, gp_Pnt& P, diff --git a/src/ModelingData/TKG3d/Geom/Geom_ElementarySurface.hxx b/src/ModelingData/TKG3d/Geom/Geom_ElementarySurface.hxx index c6e6074525..4dd17dce6e 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_ElementarySurface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_ElementarySurface.hxx @@ -89,7 +89,7 @@ public: //! Reverses the U parametric direction of the surface. Standard_EXPORT virtual void UReverse() Standard_OVERRIDE; - //! Return the parameter on the Ureversed surface for + //! Return the parameter on the Ureversed surface for //! the point of parameter U on . //! //! me->UReversed()->Value(me->UReversedParameter(U),V) @@ -101,7 +101,7 @@ public: //! Reverses the V parametric direction of the surface. Standard_EXPORT virtual void VReverse() Standard_OVERRIDE; - //! Return the parameter on the Vreversed surface for + //! Return the parameter on the Vreversed surface for //! the point of parameter V on . //! //! me->VReversed()->Value(U,me->VReversedParameter(V)) diff --git a/src/ModelingData/TKG3d/Geom/Geom_Line.hxx b/src/ModelingData/TKG3d/Geom/Geom_Line.hxx index c621daa4a8..3d4d26ebb5 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_Line.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_Line.hxx @@ -141,7 +141,7 @@ public: //! Applies the transformation T to this line. Standard_EXPORT void Transform(const gp_Trsf& 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->Transformed(T)->Value(me->TransformedParameter(U,T)) @@ -156,7 +156,7 @@ public: Standard_OVERRIDE; //! Returns a coefficient to compute the parameter on - //! the transformed curve for the transform of the + //! the transformed curve for the transform of the //! point on . //! //! Transformed(T)->Value(U * ParametricTransformation(T)) diff --git a/src/ModelingData/TKG3d/Geom/Geom_OffsetCurve.hxx b/src/ModelingData/TKG3d/Geom/Geom_OffsetCurve.hxx index f98507126a..0b9e176476 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_OffsetCurve.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_OffsetCurve.hxx @@ -177,13 +177,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 a portion //! where the curve is C2 Standard_EXPORT void D1(const Standard_Real U, gp_Pnt& P, gp_Vec& V1) const Standard_OVERRIDE; //! 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 a portion //! where the curve is C3 Standard_EXPORT void D2(const Standard_Real U, gp_Pnt& P, @@ -268,8 +268,8 @@ public: const gp_Trsf& 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 . //! //! Transformed(T)->Value(U * ParametricTransformation(T)) diff --git a/src/ModelingData/TKG3d/Geom/Geom_OffsetSurface.hxx b/src/ModelingData/TKG3d/Geom/Geom_OffsetSurface.hxx index 31831c3078..ac5060b58f 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_OffsetSurface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_OffsetSurface.hxx @@ -351,15 +351,15 @@ public: //! Creates a new object which is a copy of this offset surface. Standard_EXPORT Handle(Geom_Geometry) Copy() const Standard_OVERRIDE; - //! returns an equivalent surface of the offset surface - //! when the basis surface is a canonic surface or a - //! rectangular limited surface on canonic surface or if + //! returns an equivalent surface of the offset surface + //! when the basis surface is a canonic surface or a + //! rectangular limited surface on canonic surface or if //! the offset is null. Standard_EXPORT Handle(Geom_Surface) Surface() const; - //! if Standard_True, L is the local osculating surface - //! along U at the point U,V. It means that DL/DU is - //! collinear to DS/DU . If IsOpposite == Standard_True + //! if Standard_True, L is the local osculating surface + //! along U at the point U,V. It means that DL/DU is + //! collinear to DS/DU. If IsOpposite == Standard_True //! these vectors have opposite direction. Standard_EXPORT Standard_Boolean UOsculatingSurface(const Standard_Real U, @@ -369,8 +369,8 @@ public: //! if Standard_True, L is the local osculating surface //! along V at the point U,V. - //! It means that DL/DV is - //! collinear to DS/DV . If IsOpposite == Standard_True + //! It means that DL/DV is collinear to DS/DV. + //! If IsOpposite == Standard_True //! these vectors have opposite direction. Standard_EXPORT Standard_Boolean VOsculatingSurface(const Standard_Real U, diff --git a/src/ModelingData/TKG3d/Geom/Geom_OsculatingSurface.hxx b/src/ModelingData/TKG3d/Geom/Geom_OsculatingSurface.hxx index 5794211d27..45d4d55174 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_OsculatingSurface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_OsculatingSurface.hxx @@ -41,8 +41,8 @@ public: Standard_EXPORT Geom_OsculatingSurface(); - //! detects if the surface has punctual U or V - //! isoparametric curve along on the bounds of the surface + //! detects if the surface has punctual U or V + //! isoparametric curve along on the bounds of the surface //! relatively to the tolerance Tol and Builds the corresponding //! osculating surfaces. Standard_EXPORT Geom_OsculatingSurface(const Handle(Geom_Surface)& BS, const Standard_Real Tol); @@ -82,8 +82,7 @@ private: const Handle(Geom_BSplineSurface)& BS, Handle(Geom_BSplineSurface)& L) const; - //! returns True if the isoparametric is - //! quasi-punctual + //! returns True if the isoparametric is quasi-punctual Standard_EXPORT Standard_Boolean IsQPunctual(const Handle(Geom_Surface)& S, const Standard_Real Param, const GeomAbs_IsoType IT, diff --git a/src/ModelingData/TKG3d/Geom/Geom_Plane.hxx b/src/ModelingData/TKG3d/Geom/Geom_Plane.hxx index 66d164273c..96d90fc5dd 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_Plane.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_Plane.hxx @@ -144,7 +144,7 @@ public: //! @code //! me->Value(U,V).Transformed(T) //! @endcode - //! Where U',V' are obtained by transforming U,V with the 2d transformation returned by + //! Where U',V' are obtained by transforming U,V with the 2d transformation returned by //! @code //! me->ParametricTransformation(T) //! @endcode diff --git a/src/ModelingData/TKG3d/Geom/Geom_RectangularTrimmedSurface.hxx b/src/ModelingData/TKG3d/Geom/Geom_RectangularTrimmedSurface.hxx index 4de61c9a82..dc0df9e518 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_RectangularTrimmedSurface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_RectangularTrimmedSurface.hxx @@ -49,9 +49,9 @@ DEFINE_STANDARD_HANDLE(Geom_RectangularTrimmedSurface, Geom_BoundedSurface) //! modified the trimmed surface is not changed. //! Consequently, the trimmed surface does not //! necessarily have the same orientation as the basis surface. -//! Warning: The case of surface being trimmed is periodic and +//! Warning: The case of surface being trimmed is periodic and //! parametrics values are outside the domain is possible. -//! But, domain of the trimmed surface can be translated +//! But, domain of the trimmed surface can be translated //! by (n X) the period. class Geom_RectangularTrimmedSurface : public Geom_BoundedSurface { @@ -67,7 +67,7 @@ public: //! surface. By default in this case the surface has the same //! orientation as the basis surface S. //! The returned surface is not closed and not periodic. - //! ConstructionError Raised if + //! ConstructionError Raised if //! S is not periodic in the UDirection and U1 or U2 are out of the //! bounds of S. //! S is not periodic in the VDirection and V1 or V2 are out of the @@ -344,7 +344,7 @@ public: DEFINE_STANDARD_RTTIEXT(Geom_RectangularTrimmedSurface, Geom_BoundedSurface) private: - //! General set trim, to implement constructors and + //! General set trim, to implement constructors and //! others set trim. Standard_EXPORT void SetTrim(const Standard_Real U1, const Standard_Real U2, diff --git a/src/ModelingData/TKG3d/Geom/Geom_SphericalSurface.hxx b/src/ModelingData/TKG3d/Geom/Geom_SphericalSurface.hxx index fa68fe47bc..f2360e1df4 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_SphericalSurface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_SphericalSurface.hxx @@ -118,7 +118,7 @@ public: //! In the case of a sphere, these functions returns -U. Standard_EXPORT Standard_Real VReversedParameter(const Standard_Real V) const Standard_OVERRIDE; - //! Computes the aera of the spherical surface. + //! Computes the area of the spherical surface. Standard_EXPORT Standard_Real Area() const; //! Returns the parametric bounds U1, U2, V1 and V2 of this sphere. diff --git a/src/ModelingData/TKG3d/Geom/Geom_Surface.hxx b/src/ModelingData/TKG3d/Geom/Geom_Surface.hxx index 2c93d9d8dd..00c11243d9 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_Surface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_Surface.hxx @@ -62,7 +62,7 @@ public: //! A copy of is returned. Standard_NODISCARD Standard_EXPORT Handle(Geom_Surface) UReversed() const; - //! Returns the parameter on the Ureversed surface for + //! Returns the parameter on the Ureversed surface for //! the point of parameter U on . //! @code //! me->UReversed()->Value(me->UReversedParameter(U),V) @@ -82,7 +82,7 @@ public: //! A copy of is returned. Standard_NODISCARD Standard_EXPORT Handle(Geom_Surface) VReversed() const; - //! Returns the parameter on the Vreversed surface for + //! Returns the parameter on the Vreversed surface for //! the point of parameter V on . //! @code //! me->VReversed()->Value(U,me->VReversedParameter(V)) @@ -93,7 +93,7 @@ public: //! @endcode Standard_EXPORT virtual Standard_Real VReversedParameter(const Standard_Real V) const = 0; - //! Computes the parameters on the transformed surface for + //! Computes the parameters on the transformed surface for //! the transform of the point of parameters U,V on . //! @code //! me->Transformed(T)->Value(U',V') @@ -114,7 +114,7 @@ public: Standard_Real& V, const gp_Trsf& T) const; - //! Returns a 2d transformation used to find the new + //! Returns a 2d transformation used to find the new //! parameters of a point on the transformed surface. //! @code //! me->Transformed(T)->Value(U',V') @@ -123,14 +123,14 @@ public: //! @code //! me->Value(U,V).Transformed(T) //! @endcode - //! Where U',V' are obtained by transforming U,V with + //! Where U',V' are obtained by transforming U,V with //! the 2d transformation returned by //! @code //! me->ParametricTransformation(T) //! @endcode //! This method returns an identity transformation //! - //! 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 gp_GTrsf2d ParametricTransformation(const gp_Trsf& T) const; diff --git a/src/ModelingData/TKG3d/Geom/Geom_SurfaceOfLinearExtrusion.hxx b/src/ModelingData/TKG3d/Geom/Geom_SurfaceOfLinearExtrusion.hxx index 463df950ec..2dd005bd3f 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_SurfaceOfLinearExtrusion.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_SurfaceOfLinearExtrusion.hxx @@ -227,7 +227,7 @@ public: //! Applies the transformation T to this surface of linear extrusion. Standard_EXPORT void Transform(const gp_Trsf& T) Standard_OVERRIDE; - //! Computes the parameters on the transformed surface for + //! Computes the parameters on the transformed surface for //! the transform of the point of parameters U,V on . //! @code //! me->Transformed(T)->Value(U',V') @@ -247,7 +247,7 @@ public: Standard_Real& V, const gp_Trsf& T) const Standard_OVERRIDE; - //! Returns a 2d transformation used to find the new + //! Returns a 2d transformation used to find the new //! parameters of a point on the transformed surface. //! @code //! me->Transformed(T)->Value(U',V') diff --git a/src/ModelingData/TKG3d/Geom/Geom_SurfaceOfRevolution.hxx b/src/ModelingData/TKG3d/Geom/Geom_SurfaceOfRevolution.hxx index 14b2b7b4a7..ed89142a69 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_SurfaceOfRevolution.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_SurfaceOfRevolution.hxx @@ -154,7 +154,7 @@ public: //! Computes the u parameter on the modified //! surface, when reversing its u parametric - //! direction, for any point of u parameter U on this surface of revolution. + //! direction, for any point of u parameter U on this surface of revolution. //! In the case of a revolved surface: //! - UReversedParameter returns 2.*Pi - U Standard_EXPORT Standard_Real UReversedParameter(const Standard_Real U) const Standard_OVERRIDE; @@ -177,7 +177,7 @@ public: //! ReversedParameter called with V on the meridian. Standard_EXPORT Standard_Real VReversedParameter(const Standard_Real V) const Standard_OVERRIDE; - //! Computes the parameters on the transformed surface for + //! Computes the parameters on the transformed surface for //! the transform of the point of parameters U,V on . //! @code //! me->Transformed(T)->Value(U',V') @@ -195,7 +195,7 @@ public: Standard_Real& V, const gp_Trsf& T) const Standard_OVERRIDE; - //! Returns a 2d transformation used to find the new + //! Returns a 2d transformation used to find the new //! parameters of a point on the transformed surface. //! @code //! me->Transformed(T)->Value(U',V') @@ -204,12 +204,12 @@ public: //! @code //! me->Value(U,V).Transformed(T) //! @endcode - //! Where U',V' are obtained by transforming U,V with + //! Where U',V' are obtained by transforming U,V with //! the 2d transformation returned by //! @code //! me->ParametricTransformation(T) //! @endcode - //! This method returns a scale centered on the + //! This method returns a scale centered on the //! U axis with BasisCurve()->ParametricTransformation(T) Standard_EXPORT virtual gp_GTrsf2d ParametricTransformation(const gp_Trsf& T) const Standard_OVERRIDE; @@ -253,7 +253,7 @@ public: //! meridian through an angle U about the axis of revolution. Standard_EXPORT Handle(Geom_Curve) VIso(const Standard_Real V) const Standard_OVERRIDE; - //! Computes the point P (U, V) on the surface. + //! Computes the point P (U, V) on the surface. //! U is the angle of the rotation around the revolution axis. //! The direction of this axis gives the sense of rotation. //! V is the parameter of the revolved curve. @@ -304,13 +304,12 @@ public: //! Raised if the continuity of the surface is not CNu in the u //! direction and CNv in the v direction. //! Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0. - //! The following functions evaluates the local - //! derivatives on surface. Useful to manage discontinuities - //! on the surface. + //! The following functions evaluates the local derivatives + //! on surface. Useful to manage discontinuities on the surface. //! if Side = 1 -> P = S( U+,V ) //! if Side = -1 -> P = S( U-,V ) //! else P is betveen discontinuities - //! can be evaluated using methods of + //! can be evaluated using methods of //! global evaluations P = S( U ,V ) Standard_EXPORT gp_Vec DN(const Standard_Real U, const Standard_Real V, diff --git a/src/ModelingData/TKG3d/Geom/Geom_ToroidalSurface.hxx b/src/ModelingData/TKG3d/Geom/Geom_ToroidalSurface.hxx index 875d47b90b..7c8e0ccd28 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_ToroidalSurface.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_ToroidalSurface.hxx @@ -124,17 +124,17 @@ public: //! properties as . Standard_EXPORT gp_Torus Torus() const; - //! Return the parameter on the Ureversed surface for + //! Return the parameter on the Ureversed surface for //! the point of parameter U on . //! Return 2.PI - U. Standard_EXPORT Standard_Real UReversedParameter(const Standard_Real U) const Standard_OVERRIDE; - //! Return the parameter on the Ureversed surface for + //! Return the parameter on the Ureversed surface for //! the point of parameter U on . //! Return 2.PI - U. Standard_EXPORT Standard_Real VReversedParameter(const Standard_Real U) const Standard_OVERRIDE; - //! Computes the aera of the surface. + //! Computes the area of the surface. Standard_EXPORT Standard_Real Area() const; //! Returns the parametric bounds U1, U2, V1 and V2 of this torus. diff --git a/src/ModelingData/TKG3d/Geom/Geom_TrimmedCurve.hxx b/src/ModelingData/TKG3d/Geom/Geom_TrimmedCurve.hxx index cabb2a79bc..3cfa3c5ef7 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_TrimmedCurve.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_TrimmedCurve.hxx @@ -223,7 +223,7 @@ public: //! Warning The basis curve is also modified. Standard_EXPORT void Transform(const gp_Trsf& 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->Transformed(T)->Value(me->TransformedParameter(U,T)) @@ -237,8 +237,8 @@ public: const gp_Trsf& 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 . //! //! Transformed(T)->Value(U * ParametricTransformation(T)) diff --git a/src/ModelingData/TKG3d/Geom/Geom_VectorWithMagnitude.hxx b/src/ModelingData/TKG3d/Geom/Geom_VectorWithMagnitude.hxx index 3171017166..e02a5e452b 100644 --- a/src/ModelingData/TKG3d/Geom/Geom_VectorWithMagnitude.hxx +++ b/src/ModelingData/TKG3d/Geom/Geom_VectorWithMagnitude.hxx @@ -77,20 +77,20 @@ public: Standard_NODISCARD Standard_EXPORT Handle(Geom_VectorWithMagnitude) Added( const Handle(Geom_Vector)& Other) const; - //! Computes the cross product between and Other + //! Computes the cross product between and Other //! ^ Other. Standard_EXPORT void Cross(const Handle(Geom_Vector)& Other) Standard_OVERRIDE; - //! Computes the cross product between and Other + //! Computes the cross product between and Other //! ^ Other. A new vector is returned. Standard_EXPORT Handle(Geom_Vector) Crossed(const Handle(Geom_Vector)& Other) const Standard_OVERRIDE; - //! Computes the triple vector product ^ (V1 ^ V2). + //! Computes the triple vector product ^ (V1 ^ V2). Standard_EXPORT void CrossCross(const Handle(Geom_Vector)& V1, const Handle(Geom_Vector)& V2) Standard_OVERRIDE; - //! Computes the triple vector product ^ (V1 ^ V2). + //! Computes the triple vector product ^ (V1 ^ V2). //! A new vector is returned. Standard_EXPORT Handle(Geom_Vector) CrossCrossed(const Handle(Geom_Vector)& V1, const Handle(Geom_Vector)& V2) const diff --git a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor.hxx b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor.hxx index 89ef0efe1d..9550648de6 100644 --- a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor.hxx +++ b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor.hxx @@ -26,14 +26,14 @@ class Adaptor3d_Curve; class Geom_Surface; class Adaptor3d_Surface; -//! this package contains the geometric definition of +//! this package contains the geometric definition of //! curve and surface necessary to use algorithms. class GeomAdaptor { public: DEFINE_STANDARD_ALLOC - //! Inherited from GHCurve. Provides a curve + //! Inherited from GHCurve. Provides a curve //! handled by reference. //! Build a Geom_Curve using the information from the //! Curve from Adaptor3d diff --git a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_Curve.hxx b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_Curve.hxx index fc217b612c..6528a06aa7 100644 --- a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_Curve.hxx +++ b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_Curve.hxx @@ -96,20 +96,20 @@ public: Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE; - //! Returns the number of intervals for continuity + //! Returns the number of intervals for continuity //! . May be one if Continuity(me) >= Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Stores in the parameters bounding the intervals + //! Stores in the parameters bounding the intervals //! of continuity . //! - //! 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; - //! Returns a curve equivalent of between - //! parameters and . is used to + //! Returns a curve equivalent of between + //! parameters and . is used to //! test for 3d points confusion. //! If >= Standard_EXPORT Handle(Adaptor3d_Curve) Trim(const Standard_Real First, diff --git a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_Surface.hxx b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_Surface.hxx index 97bc0fdcb0..849f4e6760 100644 --- a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_Surface.hxx +++ b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_Surface.hxx @@ -119,35 +119,35 @@ public: Standard_EXPORT GeomAbs_Shape VContinuity() const Standard_OVERRIDE; - //! Returns the number of U intervals for continuity + //! Returns the number of U intervals for continuity //! . May be one if UContinuity(me) >= Standard_EXPORT Standard_Integer NbUIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the number of V intervals for continuity + //! Returns the number of V intervals for continuity //! . May be one if VContinuity(me) >= Standard_EXPORT Standard_Integer NbVIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the intervals with the requested continuity + //! Returns the intervals with the requested continuity //! in the U direction. Standard_EXPORT void UIntervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the intervals with the requested continuity + //! Returns the intervals with the requested continuity //! in the V direction. Standard_EXPORT void VIntervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns a surface trimmed in the U direction - //! equivalent of between - //! parameters and . is used to + //! Returns a surface trimmed in the U direction + //! equivalent of between + //! parameters and . is used to //! test for 3d points confusion. //! If >= Standard_EXPORT Handle(Adaptor3d_Surface) UTrim(const Standard_Real First, const Standard_Real Last, const Standard_Real Tol) const Standard_OVERRIDE; - //! Returns a surface trimmed in the V direction between - //! parameters and . is used to + //! Returns a surface trimmed in the V direction between + //! parameters and . is used to //! test for 3d points confusion. //! If >= Standard_EXPORT Handle(Adaptor3d_Surface) VTrim(const Standard_Real First, @@ -175,7 +175,7 @@ public: const Standard_Real V, gp_Pnt& P) const Standard_OVERRIDE; - //! Computes the point and the first derivatives on + //! Computes the point and the first derivatives on //! the surface. //! //! Warning : On the specific case of BSplineSurface: @@ -188,8 +188,8 @@ public: gp_Vec& D1U, gp_Vec& D1V) const Standard_OVERRIDE; - //! Computes the point, the first and second - //! derivatives on the surface. + //! Computes the point, the first and second derivatives + //! on the surface. //! //! Warning : On the specific case of BSplineSurface: //! if the surface is cut in interval of continuity at least C2, @@ -204,7 +204,7 @@ public: gp_Vec& D2V, gp_Vec& D2UV) const Standard_OVERRIDE; - //! Computes the point, the first, second and third + //! Computes the point, the first, second and third //! derivatives on the surface. //! //! Warning : On the specific case of BSplineSurface: @@ -237,17 +237,17 @@ public: const Standard_Integer Nu, const Standard_Integer Nv) const Standard_OVERRIDE; - //! Returns the parametric U resolution corresponding + //! Returns the parametric U resolution corresponding //! to the real space resolution . Standard_EXPORT Standard_Real UResolution(const Standard_Real R3d) const Standard_OVERRIDE; - //! Returns the parametric V resolution corresponding + //! Returns the parametric V resolution corresponding //! to the real space resolution . Standard_EXPORT Standard_Real VResolution(const Standard_Real R3d) const Standard_OVERRIDE; - //! Returns the type of the surface : Plane, Cylinder, - //! Cone, Sphere, Torus, BezierSurface, - //! BSplineSurface, SurfaceOfRevolution, + //! Returns the type of the surface: Plane, Cylinder, + //! Cone, Sphere, Torus, BezierSurface, + //! BSplineSurface, SurfaceOfRevolution, //! SurfaceOfExtrusion, OtherSurface virtual GeomAbs_SurfaceType GetType() const Standard_OVERRIDE { return mySurfaceType; } diff --git a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_SurfaceOfLinearExtrusion.hxx b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_SurfaceOfLinearExtrusion.hxx index d10a701e54..0571ae6c93 100644 --- a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_SurfaceOfLinearExtrusion.hxx +++ b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_SurfaceOfLinearExtrusion.hxx @@ -30,12 +30,11 @@ class gp_Ax1; DEFINE_STANDARD_HANDLE(GeomAdaptor_SurfaceOfLinearExtrusion, GeomAdaptor_Surface) -//! Generalised cylinder. This surface is obtained by sweeping a curve in a given -//! direction. The parametrization range for the parameter U is defined +//! Generalised cylinder. This surface is obtained by sweeping a curve in a given +//! direction. The parametrization range for the parameter U is defined //! with referenced the curve. //! The parametrization range for the parameter V is ]-infinite,+infinite[ -//! The position of the curve gives the origin for the -//! parameter V. +//! The position of the curve gives the origin for the parameter V. //! The continuity of the surface is CN in the V direction. class GeomAdaptor_SurfaceOfLinearExtrusion : public GeomAdaptor_Surface { @@ -72,35 +71,35 @@ public: //! Return CN. Standard_EXPORT GeomAbs_Shape VContinuity() const Standard_OVERRIDE; - //! Returns the number of U intervals for continuity + //! Returns the number of U intervals for continuity //! . May be one if UContinuity(me) >= Standard_EXPORT Standard_Integer NbUIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the number of V intervals for continuity + //! Returns the number of V intervals for continuity //! . May be one if VContinuity(me) >= Standard_EXPORT Standard_Integer NbVIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the intervals with the requested continuity + //! Returns the intervals with the requested continuity //! in the U direction. Standard_EXPORT void UIntervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the intervals with the requested continuity + //! Returns the intervals with the requested continuity //! in the V direction. Standard_EXPORT void VIntervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns a surface trimmed in the U direction - //! equivalent of between - //! parameters and . is used to + //! Returns a surface trimmed in the U direction + //! equivalent of between + //! parameters and . is used to //! test for 3d points confusion. //! If >= Standard_EXPORT Handle(Adaptor3d_Surface) UTrim(const Standard_Real First, const Standard_Real Last, const Standard_Real Tol) const Standard_OVERRIDE; - //! Returns a surface trimmed in the V direction between - //! parameters and . is used to + //! Returns a surface trimmed in the V direction between + //! parameters and . is used to //! test for 3d points confusion. //! If >= Standard_EXPORT Handle(Adaptor3d_Surface) VTrim(const Standard_Real First, @@ -119,17 +118,17 @@ public: Standard_EXPORT Standard_Real VPeriod() const Standard_OVERRIDE; - //! Returns the parametric U resolution corresponding + //! Returns the parametric U resolution corresponding //! to the real space resolution . Standard_EXPORT Standard_Real UResolution(const Standard_Real R3d) const Standard_OVERRIDE; - //! Returns the parametric V resolution corresponding + //! Returns the parametric V resolution corresponding //! to the real space resolution . Standard_EXPORT Standard_Real VResolution(const Standard_Real R3d) const Standard_OVERRIDE; - //! Returns the type of the surface : Plane, Cylinder, - //! Cone, Sphere, Torus, BezierSurface, - //! BSplineSurface, SurfaceOfRevolution, + //! Returns the type of the surface: Plane, Cylinder, + //! Cone, Sphere, Torus, BezierSurface, + //! BSplineSurface, SurfaceOfRevolution, //! SurfaceOfExtrusion, OtherSurface Standard_EXPORT GeomAbs_SurfaceType GetType() const Standard_OVERRIDE; diff --git a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_SurfaceOfRevolution.hxx b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_SurfaceOfRevolution.hxx index b568ba5779..cddac2e68c 100644 --- a/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_SurfaceOfRevolution.hxx +++ b/src/ModelingData/TKG3d/GeomAdaptor/GeomAdaptor_SurfaceOfRevolution.hxx @@ -82,35 +82,35 @@ public: //! Return CN. Standard_EXPORT GeomAbs_Shape VContinuity() const Standard_OVERRIDE; - //! Returns the number of U intervals for continuity + //! Returns the number of U intervals for continuity //! . May be one if UContinuity(me) >= Standard_EXPORT Standard_Integer NbUIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the number of V intervals for continuity + //! Returns the number of V intervals for continuity //! . May be one if VContinuity(me) >= Standard_EXPORT Standard_Integer NbVIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the intervals with the requested continuity + //! Returns the intervals with the requested continuity //! in the U direction. Standard_EXPORT void UIntervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns the intervals with the requested continuity + //! Returns the intervals with the requested continuity //! in the V direction. Standard_EXPORT void VIntervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE; - //! Returns a surface trimmed in the U direction - //! equivalent of between - //! parameters and . is used to + //! Returns a surface trimmed in the U direction + //! equivalent of between + //! parameters and . is used to //! test for 3d points confusion. //! If >= Standard_EXPORT Handle(Adaptor3d_Surface) UTrim(const Standard_Real First, const Standard_Real Last, const Standard_Real Tol) const Standard_OVERRIDE; - //! Returns a surface trimmed in the V direction between - //! parameters and . is used to + //! Returns a surface trimmed in the V direction between + //! parameters and . is used to //! test for 3d points confusion. //! If >= Standard_EXPORT Handle(Adaptor3d_Surface) VTrim(const Standard_Real First, @@ -129,17 +129,17 @@ public: Standard_EXPORT Standard_Real VPeriod() const Standard_OVERRIDE; - //! Returns the parametric U resolution corresponding + //! Returns the parametric U resolution corresponding //! to the real space resolution . Standard_EXPORT Standard_Real UResolution(const Standard_Real R3d) const Standard_OVERRIDE; - //! Returns the parametric V resolution corresponding + //! Returns the parametric V resolution corresponding //! to the real space resolution . Standard_EXPORT Standard_Real VResolution(const Standard_Real R3d) const Standard_OVERRIDE; - //! Returns the type of the surface : Plane, Cylinder, - //! Cone, Sphere, Torus, BezierSurface, - //! BSplineSurface, SurfaceOfRevolution, + //! Returns the type of the surface: Plane, Cylinder, + //! Cone, Sphere, Torus, BezierSurface, + //! BSplineSurface, SurfaceOfRevolution, //! SurfaceOfExtrusion, OtherSurface Standard_EXPORT GeomAbs_SurfaceType GetType() const Standard_OVERRIDE; diff --git a/src/ModelingData/TKG3d/GeomLProp/GeomLProp.hxx b/src/ModelingData/TKG3d/GeomLProp/GeomLProp.hxx index 857b4e7807..da2c94ec20 100644 --- a/src/ModelingData/TKG3d/GeomLProp/GeomLProp.hxx +++ b/src/ModelingData/TKG3d/GeomLProp/GeomLProp.hxx @@ -34,7 +34,7 @@ public: //! Computes the regularity at the junction between C1 and //! C2. The booleans r1 and r2 are true if the curves must - //! be taken reversed. The point u1 on C1 and the point + //! be taken reversed. The point u1 on C1 and the point //! u2 on C2 must be confused. //! tl and ta are the linear and angular tolerance used two //! compare the derivative. @@ -47,7 +47,7 @@ public: const Standard_Real tl, const Standard_Real ta); - //! The same as preceding but using the standard + //! The same as preceding but using the standard //! tolerances from package Precision. Standard_EXPORT static GeomAbs_Shape Continuity(const Handle(Geom_Curve)& C1, const Handle(Geom_Curve)& C2, diff --git a/src/ModelingData/TKG3d/LProp3d/LProp3d_CLProps.hxx b/src/ModelingData/TKG3d/LProp3d/LProp3d_CLProps.hxx index 40c37f143f..ef211ecbe6 100644 --- a/src/ModelingData/TKG3d/LProp3d/LProp3d_CLProps.hxx +++ b/src/ModelingData/TKG3d/LProp3d/LProp3d_CLProps.hxx @@ -93,7 +93,7 @@ public: //! three first derivatives are all null. Standard_EXPORT Standard_Boolean IsTangentDefined(); - //! output the tangent direction + //! output the tangent direction Standard_EXPORT void Tangent(gp_Dir& D); //! Returns the curvature. diff --git a/src/ModelingData/TKG3d/TopAbs/TopAbs.hxx b/src/ModelingData/TKG3d/TopAbs/TopAbs.hxx index e38bf23a3a..18bf3de30d 100644 --- a/src/ModelingData/TKG3d/TopAbs/TopAbs.hxx +++ b/src/ModelingData/TKG3d/TopAbs/TopAbs.hxx @@ -27,18 +27,18 @@ #include //! This package gives resources for Topology oriented -//! applications such as : Topological Data Structure, +//! applications such as: Topological Data Structure, //! Topological Algorithms. //! -//! It contains : +//! It contains the: //! -//! * The ShapeEnum enumeration to describe the +//! * ShapeEnum enumeration to describe the //! different topological shapes. //! -//! * The Orientation enumeration to describe the +//! * Orientation enumeration to describe the //! orientation of a topological shape. //! -//! * The State enumeration to describes the +//! * State enumeration to describes the //! position of a point relative to a Shape. //! //! * Methods to manage the enumerations. @@ -48,12 +48,12 @@ class TopAbs public: DEFINE_STANDARD_ALLOC - //! Compose the Orientation and . This - //! composition is not symmetric (if you switch and - //! the result is different). It assumes that + //! Compose the Orientation and . This + //! composition is not symmetric (if you switch and + //! the result is different). It assumes that //! is the Orientation of a Shape S1 containing a Shape S2 - //! of Orientation Or2. The result is the cumulated - //! orientation of S2 in S1. The composition law is : + //! of Orientation Or2. The result is the cumulated + //! orientation of S2 in S1. The composition law is: //! //! \ Or2 FORWARD REVERSED INTERNAL EXTERNAL //! Or1 ------------------------------------- diff --git a/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_Context.hxx b/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_Context.hxx index c37d16f510..452d9d9acc 100644 --- a/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_Context.hxx +++ b/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_Context.hxx @@ -25,8 +25,8 @@ #include #include -//! contains all the parameters for approximation -//! ( tolerancy, computing option, ...) +//! contains all the parameters for approximation +//! (tolerancy, computing option, ...) class AdvApp2Var_Context { public: diff --git a/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_MathBase.cxx b/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_MathBase.cxx index 94f992300b..72223bc571 100644 --- a/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_MathBase.cxx +++ b/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_MathBase.cxx @@ -3048,7 +3048,7 @@ int mmdrvcb_(integer* ideriv, /* TABPNT : Table of values of consecutive derivatives */ /* of parameter TPARAM. */ /* IERCOD : 0 = OK, */ - /* 1 = incoherent input. */ + /* 1 = incoherent input. */ /* COMMONS USED : */ /* ---------------- */ @@ -3237,10 +3237,10 @@ int AdvApp2Var_MathBase::mmdrvck_(integer* ncoeff, /* INPUT ARGUMENTS : */ /* ------------------ */ /* NCOEFF : Degree +1 of the curve. */ - /* NDIMEN : Dimension of the space (2 or 3 in general) */ + /* NDIMEN : Dimension of the space (2 or 3 in general) */ /* COURBE : Table of coefficients of the curve. */ - /* IDERIV : Required order of derivation : 1=1st derivative, etc... */ - /* TPARAM : Value of parameter of the curve. */ + /* IDERIV : Required order of derivation : 1=1st derivative, etc... */ + /* TPARAM : Value of parameter of the curve. */ /* OUTPUT ARGUMENTS : */ /* ------------------- */ @@ -4290,8 +4290,7 @@ int AdvApp2Var_MathBase::mmfmcb5_(integer* isenmsc, /* -------------------- */ /* ISENMSC : required direction of the transfer : */ /* 1 : passage of (NDIMEN,.) ---> (.,NDIMEN) direction to AB */ - /* -1 : passage of (.,NDIMEN) ---> (NDIMEN,.) direction to TS,T - V*/ + /* -1 : passage of (.,NDIMEN) ---> (NDIMEN,.) direction to TS,T V*/ /* NDIMAX : format / dimension */ /* NCF1MX : format by t of COURB1 */ /* if ISENMSC= 1 : COURB1: The curve to be processed (NDIMAX,.) */ diff --git a/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_SysBase.cxx b/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_SysBase.cxx index 563cb873d4..60a425e125 100644 --- a/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_SysBase.cxx +++ b/src/ModelingData/TKGeomBase/AdvApp2Var/AdvApp2Var_SysBase.cxx @@ -2284,7 +2284,7 @@ int AdvApp2Var_SysBase::mcrfill_(integer* size, void* tin, void* tout) /* Routine mcrfree */ /* -------------- */ /* */ -/* Desallocation of a memory zone . */ +/* Desallocation of a memory zone. */ /* */ /* CALL MCRFREE (IBYTE,IADR,IER) */ /* */ diff --git a/src/ModelingData/TKGeomBase/AppDef/AppDef_Compute.hxx b/src/ModelingData/TKGeomBase/AppDef/AppDef_Compute.hxx index b472c56090..940ff923c2 100644 --- a/src/ModelingData/TKGeomBase/AppDef/AppDef_Compute.hxx +++ b/src/ModelingData/TKGeomBase/AppDef/AppDef_Compute.hxx @@ -153,7 +153,7 @@ public: //! returns the result of the approximation. Standard_EXPORT const AppParCurves_MultiBSpCurve& SplineValue(); - //! returns the type of parametrization + //! returns the type of parametrization Standard_EXPORT Approx_ParametrizationType Parametrization() const; //! returns the new parameters of the approximation diff --git a/src/ModelingData/TKGeomBase/AppDef/AppDef_MultiLine.hxx b/src/ModelingData/TKGeomBase/AppDef/AppDef_MultiLine.hxx index 5183ba8905..770733eb0d 100644 --- a/src/ModelingData/TKGeomBase/AppDef/AppDef_MultiLine.hxx +++ b/src/ModelingData/TKGeomBase/AppDef/AppDef_MultiLine.hxx @@ -59,7 +59,7 @@ public: Standard_EXPORT AppDef_MultiLine(); //! given the number NbMult of MultiPointConstraints of this - //! MultiLine , it initializes all the fields.SetValue must be + //! MultiLine, it initializes all the fields.SetValue must be //! called in order for the values of the multipoint //! constraint to be taken into account. //! An exception is raised if NbMult < 0. diff --git a/src/ModelingData/TKGeomBase/AppDef/AppDef_Variational.hxx b/src/ModelingData/TKGeomBase/AppDef/AppDef_Variational.hxx index 9fb62020a8..b6332702bb 100644 --- a/src/ModelingData/TKGeomBase/AppDef/AppDef_Variational.hxx +++ b/src/ModelingData/TKGeomBase/AppDef/AppDef_Variational.hxx @@ -37,7 +37,7 @@ class FEmTool_Assembly; class PLib_Base; //! This class is used to smooth N points with constraints -//! by minimization of quadratic criterium but also +//! by minimization of quadratic criterium but also //! variational criterium in order to obtain " fair Curve " //! Computes the approximation of a Multiline by //! Variational optimization. @@ -47,10 +47,10 @@ public: DEFINE_STANDARD_ALLOC //! Constructor. - //! Initialization of the fields. + //! Initialization of the fields. //! warning : Nc0 : number of PassagePoint consraints - //! Nc2 : number of TangencyPoint constraints - //! Nc3 : number of CurvaturePoint constraints + //! Nc2 : number of TangencyPoint constraints + //! Nc3 : number of CurvaturePoint constraints //! if //! ((MaxDegree-Continuity)*MaxSegment -Nc0 - 2*Nc1 //! -3*Nc2) @@ -76,11 +76,11 @@ public: Standard_EXPORT void Approximate(); //! returns True if the creation is done - //! and correspond to the current fields. + //! and correspond to the current fields. Standard_EXPORT Standard_Boolean IsCreated() const; //! returns True if the approximation is ok - //! and correspond to the current fields. + //! and correspond to the current fields. Standard_EXPORT Standard_Boolean IsDone() const; //! returns True if the problem is overconstrained @@ -123,8 +123,8 @@ public: Standard_Real& VSecondOrder, Standard_Real& VThirdOrder) const; - //! returns the Weights (as percent) associed to the criterium used in - //! the optimization. + //! returns the Weights (as percent) associed to the criterium used in + //! the optimization. Standard_EXPORT void CriteriumWeight(Standard_Real& Percent1, Standard_Real& Percent2, Standard_Real& Percent3) const; @@ -138,11 +138,11 @@ public: //! returns the Continuity used in the approximation Standard_EXPORT GeomAbs_Shape Continuity() const; - //! returns if the approximation search to minimize the + //! returns if the approximation search to minimize the //! maximum Error or not. Standard_EXPORT Standard_Boolean WithMinMax() const; - //! returns if the approximation can insert new Knots or not. + //! returns if the approximation can insert new Knots or not. Standard_EXPORT Standard_Boolean WithCutting() const; //! returns the tolerance used in the approximation. @@ -186,11 +186,11 @@ public: //! this method modify nothing and returns false Standard_EXPORT Standard_Boolean SetContinuity(const GeomAbs_Shape C); - //! Define if the approximation search to minimize the + //! Define if the approximation search to minimize the //! maximum Error or not. Standard_EXPORT void SetWithMinMax(const Standard_Boolean MinMax); - //! Define if the approximation can insert new Knots or not. + //! Define if the approximation can insert new Knots or not. //! If this value is incompatible with the others fields //! this method modify nothing and returns false Standard_EXPORT Standard_Boolean SetWithCutting(const Standard_Boolean Cutting); @@ -203,8 +203,8 @@ public: const Standard_Real Percent2, const Standard_Real Percent3); - //! define the Weight (as percent) associed to the - //! criterium Order used in the optimization : Others + //! define the Weight (as percent) associed to the + //! criterium Order used in the optimization : Others //! weights are updated. //! if Percent < 0 //! if Order < 1 or Order > 3 diff --git a/src/ModelingData/TKGeomBase/Approx/Approx_Curve3d.hxx b/src/ModelingData/TKGeomBase/Approx/Approx_Curve3d.hxx index 7c115f424a..348bab1aef 100644 --- a/src/ModelingData/TKGeomBase/Approx/Approx_Curve3d.hxx +++ b/src/ModelingData/TKGeomBase/Approx/Approx_Curve3d.hxx @@ -41,7 +41,7 @@ public: 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 + //! with a result that is not NECESSARILY within the required //! tolerance Standard_EXPORT Standard_Boolean HasResult() const; diff --git a/src/ModelingData/TKGeomBase/Approx/Approx_CurveOnSurface.hxx b/src/ModelingData/TKGeomBase/Approx/Approx_CurveOnSurface.hxx index 5bcea0ada0..a984dfae85 100644 --- a/src/ModelingData/TKGeomBase/Approx/Approx_CurveOnSurface.hxx +++ b/src/ModelingData/TKGeomBase/Approx/Approx_CurveOnSurface.hxx @@ -24,7 +24,7 @@ class Geom_BSplineCurve; class Geom2d_BSplineCurve; -//! Approximation of curve on surface +//! Approximation of curve on surface class Approx_CurveOnSurface { public: diff --git a/src/ModelingData/TKGeomBase/Approx/Approx_SameParameter.hxx b/src/ModelingData/TKGeomBase/Approx/Approx_SameParameter.hxx index 5c1550fc3f..fe254c0e88 100644 --- a/src/ModelingData/TKGeomBase/Approx/Approx_SameParameter.hxx +++ b/src/ModelingData/TKGeomBase/Approx/Approx_SameParameter.hxx @@ -24,7 +24,7 @@ class Geom_Curve; class Geom2d_Curve; class Geom_Surface; -//! Approximation of a PCurve on a surface to make its +//! Approximation of a PCurve on a surface to make its //! parameter be the same that the parameter of a given 3d //! reference curve. class Approx_SameParameter diff --git a/src/ModelingData/TKGeomBase/Approx/Approx_SweepFunction.hxx b/src/ModelingData/TKGeomBase/Approx/Approx_SweepFunction.hxx index 2f6c4599d6..a763ba79c5 100644 --- a/src/ModelingData/TKGeomBase/Approx/Approx_SweepFunction.hxx +++ b/src/ModelingData/TKGeomBase/Approx/Approx_SweepFunction.hxx @@ -48,8 +48,8 @@ public: TColgp_Array1OfPnt2d& Poles2d, TColStd_Array1OfReal& Weigths) = 0; - //! compute the first derivative in v direction of the - //! section for v = param + //! compute the first derivative in v direction of the + //! section for v = param //! Warning : It used only for C1 or C2 approximation Standard_EXPORT virtual Standard_Boolean D1(const Standard_Real Param, const Standard_Real First, @@ -61,8 +61,8 @@ public: TColStd_Array1OfReal& Weigths, TColStd_Array1OfReal& DWeigths); - //! 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 //! Warning : It used only for C2 approximation Standard_EXPORT virtual Standard_Boolean D2(const Standard_Real Param, const Standard_Real First, @@ -77,10 +77,10 @@ public: TColStd_Array1OfReal& DWeigths, TColStd_Array1OfReal& D2Weigths); - //! get the number of 2d curves to approximate. + //! get the number of 2d curves to approximate. Standard_EXPORT virtual Standard_Integer Nb2dCurves() const = 0; - //! 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 = 0; @@ -94,20 +94,20 @@ public: //! Returns if the sections are rational or not Standard_EXPORT virtual Standard_Boolean IsRational() const = 0; - //! Returns the number of intervals for continuity + //! Returns the number of intervals for continuity //! . //! May be one if Continuity(me) >= Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const = 0; - //! Stores in the parameters bounding the intervals + //! Stores in the parameters bounding the intervals //! of continuity . //! - //! 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 = 0; //! Sets the bounds of the parametric interval on - //! the fonction + //! the function //! This determines the derivatives in these values if the //! function is not Cn. Standard_EXPORT virtual void SetInterval(const Standard_Real First, const Standard_Real Last) = 0; diff --git a/src/ModelingData/TKGeomBase/CPnts/CPnts_MyGaussFunction.hxx b/src/ModelingData/TKGeomBase/CPnts/CPnts_MyGaussFunction.hxx index 633b323b0e..790568fc9b 100644 --- a/src/ModelingData/TKGeomBase/CPnts/CPnts_MyGaussFunction.hxx +++ b/src/ModelingData/TKGeomBase/CPnts/CPnts_MyGaussFunction.hxx @@ -33,7 +33,7 @@ public: CPnts_MyGaussFunction(); - //! F is a pointer on a function D is a client data + //! F is a pointer on a function D is a client data //! //! Each value is computed with F(D) Standard_EXPORT void Init(const CPnts_RealFunction& F, const Standard_Address D); diff --git a/src/ModelingData/TKGeomBase/CPnts/CPnts_MyRootFunction.hxx b/src/ModelingData/TKGeomBase/CPnts/CPnts_MyRootFunction.hxx index 4c8ba512a0..05d913e4fe 100644 --- a/src/ModelingData/TKGeomBase/CPnts/CPnts_MyRootFunction.hxx +++ b/src/ModelingData/TKGeomBase/CPnts/CPnts_MyRootFunction.hxx @@ -36,7 +36,7 @@ public: CPnts_MyRootFunction(); - //! F is a pointer on a function D is a client data + //! F is a pointer on a function D is a client data //! Order is the order of integration to use Standard_EXPORT void Init(const CPnts_RealFunction& F, const Standard_Address D, diff --git a/src/ModelingData/TKGeomBase/Extrema/Extrema_Curve2dTool.hxx b/src/ModelingData/TKGeomBase/Extrema/Extrema_Curve2dTool.hxx index 6fa6d2dbb7..7b36bb6087 100644 --- a/src/ModelingData/TKGeomBase/Extrema/Extrema_Curve2dTool.hxx +++ b/src/ModelingData/TKGeomBase/Extrema/Extrema_Curve2dTool.hxx @@ -102,12 +102,12 @@ public: //! order of derivation N. static gp_Vec2d DN(const Adaptor2d_Curve2d& C, const Standard_Real U, const Standard_Integer N); - //! Returns the parametric resolution corresponding + //! Returns the parametric resolution corresponding //! to the real space resolution . static Standard_Real Resolution(const Adaptor2d_Curve2d& C, const Standard_Real R3d); - //! Returns the type of the curve in the current - //! interval : Line, Circle, Ellipse, Hyperbola, + //! Returns the type of the curve in the current + //! interval : Line, Circle, Ellipse, Hyperbola, //! Parabola, BezierCurve, BSplineCurve, OtherCurve. static GeomAbs_CurveType GetType(const Adaptor2d_Curve2d& C); diff --git a/src/ModelingData/TKGeomBase/Extrema/Extrema_ECC2d.hxx b/src/ModelingData/TKGeomBase/Extrema/Extrema_ECC2d.hxx index d6223e1669..588098204c 100644 --- a/src/ModelingData/TKGeomBase/Extrema/Extrema_ECC2d.hxx +++ b/src/ModelingData/TKGeomBase/Extrema/Extrema_ECC2d.hxx @@ -46,7 +46,7 @@ public: Standard_EXPORT Extrema_ECC2d(const Adaptor2d_Curve2d& C1, const Adaptor2d_Curve2d& C2); //! Calculates all the distances as above - //! between Uinf and Usup for C1 and between Vinf and Vsup + //! between Uinf and Usup for C1 and between Vinf and Vsup //! for C2. Standard_EXPORT Extrema_ECC2d(const Adaptor2d_Curve2d& C1, const Adaptor2d_Curve2d& C2, diff --git a/src/ModelingData/TKGeomBase/GCPnts/GCPnts_TangentialDeflection.hxx b/src/ModelingData/TKGeomBase/GCPnts/GCPnts_TangentialDeflection.hxx index 3d1d46c228..5accf3e281 100644 --- a/src/ModelingData/TKGeomBase/GCPnts/GCPnts_TangentialDeflection.hxx +++ b/src/ModelingData/TKGeomBase/GCPnts/GCPnts_TangentialDeflection.hxx @@ -25,8 +25,8 @@ #include #include -//! Computes a set of points on a curve from package -//! Adaptor3d such as between two successive points +//! Computes a set of points on a curve from package +//! Adaptor3d such as between two successive points //! P1(u1)and P2(u2) : //! @code //! . ||P1P3^P3P2||/||P1P3||*||P3P2|| 2 in the OutParameters Array + //! There will be at the end at most NumPoints + 1 + //! if NumPoints > 2 in the OutParameters Array Standard_EXPORT static void RemovePointsFromArray(const Standard_Integer NumPoints, const TColStd_Array1OfReal& InParameters, Handle(TColStd_HArray1OfReal)& OutParameters); - //! this makes sure that there is at least MinNumPoints + //! this makes sure that there is at least MinNumPoints //! in OutParameters taking into account the parameters in //! the InParameters array provided those are in order, //! that is the sequence of real in the InParameter is strictly @@ -207,9 +207,9 @@ public: const Standard_Real Confusion = 1.0e-9, const Standard_Boolean IsAdjustToFirstInterval = Standard_False); - //! this will compute the maximum distance at the - //! parameters given in the Parameters array by - //! evaluating each parameter the two curves and taking + //! this will compute the maximum distance at the + //! parameters given in the Parameters array by + //! evaluating each parameter the two curves and taking //! the maximum of the evaluated distance Standard_EXPORT static void EvalMaxParametricDistance(const Adaptor3d_Curve& Curve, const Adaptor3d_Curve& AReferenceCurve, @@ -227,8 +227,8 @@ public: const TColStd_Array1OfReal& Parameters, Standard_Real& MaxDistance); - //! Cancel,on the boundaries,the denominator first derivative - //! in the directions wished by the user and set its value to 1. + //! Cancel,on the boundaries,the denominator first derivative + //! in the directions wished by the user and set its value to 1. Standard_EXPORT static void CancelDenominatorDerivative(Handle(Geom_BSplineSurface)& BSurf, const Standard_Boolean UDirection, const Standard_Boolean VDirection); diff --git a/src/ModelingData/TKGeomBase/GeomLib/GeomLib_Check2dBSplineCurve.hxx b/src/ModelingData/TKGeomBase/GeomLib/GeomLib_Check2dBSplineCurve.hxx index 7545839c20..141e09ff82 100644 --- a/src/ModelingData/TKGeomBase/GeomLib/GeomLib_Check2dBSplineCurve.hxx +++ b/src/ModelingData/TKGeomBase/GeomLib/GeomLib_Check2dBSplineCurve.hxx @@ -23,7 +23,7 @@ class Geom2d_BSplineCurve; -//! Checks for the end tangents : whether or not those +//! Checks for the end tangents : whether or not those //! are reversed class GeomLib_Check2dBSplineCurve { diff --git a/src/ModelingData/TKGeomBase/GeomLib/GeomLib_PolyFunc.hxx b/src/ModelingData/TKGeomBase/GeomLib/GeomLib_PolyFunc.hxx index f4a08367bc..d5f9011a25 100644 --- a/src/ModelingData/TKGeomBase/GeomLib/GeomLib_PolyFunc.hxx +++ b/src/ModelingData/TKGeomBase/GeomLib/GeomLib_PolyFunc.hxx @@ -24,7 +24,7 @@ #include #include -//! Polynomial Function +//! Polynomial Function class GeomLib_PolyFunc : public math_FunctionWithDerivative { public: diff --git a/src/ModelingData/TKGeomBase/Hermit/Hermit.hxx b/src/ModelingData/TKGeomBase/Hermit/Hermit.hxx index e33a028cac..ac5b53e95e 100644 --- a/src/ModelingData/TKGeomBase/Hermit/Hermit.hxx +++ b/src/ModelingData/TKGeomBase/Hermit/Hermit.hxx @@ -24,9 +24,9 @@ class Geom2d_BSplineCurve; class Geom_BSplineCurve; -//! This is used to reparameterize Rational BSpline -//! Curves so that we can concatenate them later to -//! build C1 Curves It builds and 1D-reparameterizing +//! This is used to reparameterize Rational BSpline +//! Curves so that we can concatenate them later to +//! build C1 Curves It builds and 1D-reparameterizing //! function starting from an Hermite interpolation and //! adding knots and modifying poles of the 1D BSpline //! obtained that way. The goal is to build a(u) so that diff --git a/src/ModelingData/TKGeomBase/IntAna/IntAna_IntQuadQuad.hxx b/src/ModelingData/TKGeomBase/IntAna/IntAna_IntQuadQuad.hxx index 0d1b28abb2..056544cdc7 100644 --- a/src/ModelingData/TKGeomBase/IntAna/IntAna_IntQuadQuad.hxx +++ b/src/ModelingData/TKGeomBase/IntAna/IntAna_IntQuadQuad.hxx @@ -44,7 +44,7 @@ public: //! Empty Constructor Standard_EXPORT IntAna_IntQuadQuad(); - //! Creates the intersection between a cylinder and a quadric . + //! Creates the intersection between a cylinder and a quadric. //! Tol est a definir plus precisemment. Standard_EXPORT IntAna_IntQuadQuad(const gp_Cylinder& C, const IntAna_Quadric& Q, @@ -92,17 +92,17 @@ public: Standard_Real& U1, Standard_Real& U2) const; - //! Returns True if the Curve I shares its last bound + //! Returns True if the Curve I shares its last bound //! with another curve. Standard_EXPORT Standard_Boolean HasNextCurve(const Standard_Integer I) const; - //! If HasNextCurve(I) returns True, this function - //! returns the Index J of the curve which has a - //! common bound with the curve I. If theOpposite == - //! True , then the last parameter of the curve I, and - //! the last parameter of the curve J give the same - //! point. Else the last parameter of the curve I and - //! the first parameter of the curve J are the same + //! If HasNextCurve(I) returns True, this function + //! returns the Index J of the curve which has a + //! common bound with the curve I. If theOpposite == + //! True, then the last parameter of the curve I, and + //! the last parameter of the curve J give the same + //! point. Else the last parameter of the curve I and + //! the first parameter of the curve J are the same //! point. Standard_EXPORT Standard_Integer NextCurve(const Standard_Integer I, Standard_Boolean& theOpposite) const; @@ -112,13 +112,13 @@ public: Standard_EXPORT Standard_Boolean HasPreviousCurve(const Standard_Integer I) const; //! if HasPreviousCurve(I) returns True, this function - //! returns the Index J of the curve which has a - //! common bound with the curve I. If theOpposite == - //! True , then the first parameter of the curve I, - //! and the first parameter of the curve J give the - //! same point. Else the first parameter of the curve - //! I and the last parameter of the curve J are the - //! same point. + //! returns the Index J of the curve which has a common + //! bound with the curve I. If theOpposite == True + //! then the first parameter of the curve I, and the + //! first parameter of the curve J give the same + //! point. Else the first parameter of the curve I and + //! the last parameter of the curve J are the same + //! point. Standard_EXPORT Standard_Integer PreviousCurve(const Standard_Integer I, Standard_Boolean& theOpposite) const; diff --git a/src/ModelingData/TKGeomBase/ProjLib/ProjLib_ProjectedCurve.hxx b/src/ModelingData/TKGeomBase/ProjLib/ProjLib_ProjectedCurve.hxx index ffc28273e3..8c43cabce1 100644 --- a/src/ModelingData/TKGeomBase/ProjLib/ProjLib_ProjectedCurve.hxx +++ b/src/ModelingData/TKGeomBase/ProjLib/ProjLib_ProjectedCurve.hxx @@ -120,8 +120,8 @@ public: Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE; - //! If necessary, breaks the curve in intervals of - //! continuity . And returns the number of + //! If necessary, breaks the curve in intervals of + //! continuity . And returns the number of //! intervals. Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE; @@ -186,7 +186,7 @@ public: Standard_EXPORT gp_Vec2d DN(const Standard_Real U, const Standard_Integer N) const Standard_OVERRIDE; - //! Returns the parametric resolution corresponding + //! Returns the parametric resolution corresponding //! to the real space resolution . Standard_EXPORT Standard_Real Resolution(const Standard_Real R3d) const Standard_OVERRIDE; diff --git a/src/ModelingData/TKGeomBase/gce/gce_MakePln.hxx b/src/ModelingData/TKGeomBase/gce/gce_MakePln.hxx index 6d5e0fc0f4..18c3dd2478 100644 --- a/src/ModelingData/TKGeomBase/gce/gce_MakePln.hxx +++ b/src/ModelingData/TKGeomBase/gce/gce_MakePln.hxx @@ -97,7 +97,7 @@ public: //! Make a pln passing through the location of and //! normal to the Direction of . - //! Warning - If an error occurs (that is, when IsDone returns + //! Warning - If an error occurs (that is, when IsDone returns //! false), the Status function returns: //! - gce_BadEquation if Sqrt(A*A + B*B + //! C*C) is less than or equal to gp::Resolution(),