lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-08-15 05:09:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation - Fix whitespaces (#816)

Browse Source 
- Standardized spacing in comment formatting (removing extra spaces after colons, between words)
- Fixed one typo in a parameter name within a comment
- Translated one French comment to English
This commit is contained in:
luzpaz
2025-11-10 12:42:08 -05:00
committed by GitHub
parent a47cffd0eb
commit f9f94b6e36
169 changed files with 1047 additions and 1056 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI.hxx
+9 -9
View File
@@ -26,29 +26,29 @@
class gp_Pln;
//! The GeomAPI package provides an Application
//! The GeomAPI package provides an Application
//! Programming Interface for the Geometry.
//!
//! The API is a set of classes and methods aiming to
//! The API is a set of classes and methods aiming to
//! provide :
//!
//! * High level and simple calls for the most common
//! * High level and simple calls for the most common
//! operations.
//!
//! * Keeping an access on the low-level
//! * Keeping an access on the low-level
//! implementation of high-level calls.
//!
//! The API provides classes to call the algorithms
//! The API provides classes to call the algorithms
//! of the Geometry
//!
//! * The constructors of the classes provides the
//! * The constructors of the classes provides the
//! different constructions methods.
//!
//! * The class keeps as fields the different tools
//! * The class keeps as fields the different tools
//! used by the algorithms
//!
//! * The class provides a casting method to get
//! automatically the result with a function-like
//! * The class provides a casting method to get
//! automatically the result with a function-like
//! call.
//!
//! For example to evaluate the distance <D> between a
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ExtremaCurveCurve.hxx
+7 -7
View File
@@ -63,7 +63,7 @@ public:
Standard_EXPORT GeomAPI_ExtremaCurveCurve(const Handle(Geom_Curve)& C1,
const Handle(Geom_Curve)& C2);
//! Computes the portion of the curve C1 limited by the two
//! Computes the portion of the curve C1 limited by the two
//! points of parameter (U1min,U1max), and
//! - the portion of the curve C2 limited by the two
//! points of parameter (U2min,U2max).
@@ -154,18 +154,18 @@ public:
//! return the algorithmic object from Extrema
const Extrema_ExtCC& Extrema() const;
//! set in <P1> and <P2> the couple solution points
//! such a the distance [P1,P2] is the minimum. taking in account
//! extremity points of curves.
//! set in <P1> and <P2> the couple solution points
//! such a the distance [P1,P2] is the minimum. taking in account
//! extremity points of curves.
Standard_EXPORT Standard_Boolean TotalNearestPoints(gp_Pnt& P1, gp_Pnt& P2);
//! set in <U1> and <U2> the parameters of the couple
//! solution points which represents the total nearest
//! set in <U1> and <U2> the parameters of the couple
//! solution points which represents the total nearest
//! solution.
Standard_EXPORT Standard_Boolean TotalLowerDistanceParameters(Standard_Real& U1,
Standard_Real& U2);
//! return the distance of the total nearest couple solution
//! return the distance of the total nearest couple solution
//! point.
//! if <myExtCC> is not done
Standard_EXPORT Standard_Real TotalLowerDistance();
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ExtremaCurveSurface.hxx
+10 -10
View File
@@ -62,15 +62,15 @@ public:
//! which it is going to work.
Standard_EXPORT GeomAPI_ExtremaCurveSurface();
//! Computes the extrema distances between the
//! curve <C> and the surface <S>.
//! Computes the extrema distances between the
//! curve <C> and the surface <S>.
Standard_EXPORT GeomAPI_ExtremaCurveSurface(const Handle(Geom_Curve)& Curve,
const Handle(Geom_Surface)& Surface);
//! Computes the extrema distances between the
//! curve <C> and the surface <S>. The solution
//! Computes the extrema distances between the
//! curve <C> and the surface <S>. The solution
//! point are computed in the domain [Wmin,Wmax] of
//! the curve and in the domain [Umin,Umax]
//! the curve and in the domain [Umin,Umax]
//! [Vmin,Vmax] of the surface.
//! Warning
//! Use the function NbExtrema to obtain the number
@@ -84,14 +84,14 @@ public:
const Standard_Real Vmin,
const Standard_Real Vmax);
//! Computes the extrema distances between the
//! curve <C> and the surface <S>.
//! Computes the extrema distances between the
//! curve <C> and the surface <S>.
Standard_EXPORT void Init(const Handle(Geom_Curve)& Curve, const Handle(Geom_Surface)& Surface);
//! Computes the extrema distances between the
//! curve <C> and the surface <S>. The solution
//! Computes the extrema distances between the
//! curve <C> and the surface <S>. The solution
//! point are computed in the domain [Wmin,Wmax] of
//! the curve and in the domain [Umin,Umax]
//! the curve and in the domain [Umin,Umax]
//! [Vmin,Vmax] of the surface.
//! Warning
//! Use the function NbExtrema to obtain the number
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ExtremaSurfaceSurface.hxx
+6 -6
View File
@@ -56,12 +56,12 @@ public:
//! to define the surfaces on which it is going to work.
Standard_EXPORT GeomAPI_ExtremaSurfaceSurface();
//! Computes the extrema distances between the
//! surfaces <S1> and <S2>
//! Computes the extrema distances between the
//! surfaces <S1> and <S2>
Standard_EXPORT GeomAPI_ExtremaSurfaceSurface(const Handle(Geom_Surface)& S1,
const Handle(Geom_Surface)& S2);
//! Computes the extrema distances between
//! Computes the extrema distances between
//! the portion of the surface S1 limited by the
//! two values of parameter (U1min,U1max) in
//! the u parametric direction, and by the two
@@ -84,12 +84,12 @@ public:
const Standard_Real V2max);
//! Initializes this algorithm with the given arguments
//! and computes the extrema distances between the
//! surfaces <S1> and <S2>
//! and computes the extrema distances between the
//! surfaces <S1> and <S2>
Standard_EXPORT void Init(const Handle(Geom_Surface)& S1, const Handle(Geom_Surface)& S2);
//! Initializes this algorithm with the given arguments
//! and computes the extrema distances between -
//! and computes the extrema distances between -
//! the portion of the surface S1 limited by the two
//! values of parameter (U1min,U1max) in the u
//! parametric direction, and by the two values of
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_IntCS.hxx
+1 -1
View File
@@ -28,7 +28,7 @@ class Geom_Surface;
class gp_Pnt;
//! This class implements methods for
//! computing intersection points and segments between a
//! computing intersection points and segments between a
class GeomAPI_IntCS
{
public:
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_IntSS.hxx
+4 -4
View File
@@ -29,10 +29,10 @@ class Geom_Surface;
class Geom_Curve;
//! This class implements methods for
//! computing the intersection curves between two surfaces.
//! The result is curves from Geom. The "domain" used for
//! a surface is the natural parametric domain
//! unless the surface is a RectangularTrimmedSurface
//! computing the intersection curves between two surfaces.
//! The result is curves from Geom. The "domain" used for
//! a surface is the natural parametric domain
//! unless the surface is a RectangularTrimmedSurface
//! from Geom.
class GeomAPI_IntSS
{
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_Interpolate.hxx
+4 -4
View File
@@ -29,11 +29,11 @@
class gp_Vec;
//! This class is used to interpolate a BsplineCurve
//! passing through an array of points, with a C2
//! This class is used to interpolate a BsplineCurve
//! passing through an array of points, with a C2
//! Continuity if tangency is not requested at the point.
//! If tangency is requested at the point the continuity will
//! be C1. If Perodicity is requested the curve will be closed
//! be C1. If Perodicity is requested the curve will be closed
//! and the junction will be the first point given. The curve
//! will than be only C1
//! Describes functions for building a constrained 3D BSpline curve.
@@ -53,7 +53,7 @@ public:
DEFINE_STANDARD_ALLOC
//! Initializes an algorithm for constructing a
//! constrained BSpline curve passing through the points of the table Points.
//! constrained BSpline curve passing through the points of the table Points.
//! Tangential vectors can then be assigned, using the function Load.
//! If PeriodicFlag is true, the constrained BSpline
//! curve will be periodic and closed. In this case,
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_PointsToBSpline.hxx
+24 -24
View File
@@ -28,8 +28,8 @@
#include <TColStd_Array1OfReal.hxx>
class Geom_BSplineCurve;
//! This class is used to approximate a BsplineCurve
//! passing through an array of points, with a given Continuity.
//! This class is used to approximate a BsplineCurve
//! passing through an array of points, with a given Continuity.
//! Describes functions for building a 3D BSpline
//! curve which approximates a set of points.
//! A PointsToBSpline object provides a framework for:
@@ -44,11 +44,11 @@ public:
//! Use an Init function to define and build the BSpline curve.
Standard_EXPORT GeomAPI_PointsToBSpline();
//! Approximate a BSpline Curve passing through an
//! array of Point. The resulting BSpline will have
//! Approximate a BSpline Curve passing through an
//! array of Point. The resulting BSpline will have
//! the following properties:
//! 1- his degree will be in the range [Degmin,Degmax]
//! 2- his continuity will be at least <Continuity>
//! 2- his continuity will be at least <Continuity>
//! 3- the distance from the point <Points> to the
//! BSpline will be lower to Tol3D
Standard_EXPORT GeomAPI_PointsToBSpline(const TColgp_Array1OfPnt& Points,
@@ -57,11 +57,11 @@ public:
const GeomAbs_Shape Continuity = GeomAbs_C2,
const Standard_Real Tol3D = 1.0e-3);
//! Approximate a BSpline Curve passing through an
//! array of Point. The resulting BSpline will have
//! Approximate a BSpline Curve passing through an
//! array of Point. The resulting BSpline will have
//! the following properties:
//! 1- his degree will be in the range [Degmin,Degmax]
//! 2- his continuity will be at least <Continuity>
//! 2- his continuity will be at least <Continuity>
//! 3- the distance from the point <Points> to the
//! BSpline will be lower to Tol3D
Standard_EXPORT GeomAPI_PointsToBSpline(const TColgp_Array1OfPnt& Points,
@@ -71,13 +71,13 @@ public:
const GeomAbs_Shape Continuity = GeomAbs_C2,
const Standard_Real Tol3D = 1.0e-3);
//! Approximate a BSpline Curve passing through an
//! array of Point, which parameters are given by the
//! Approximate a BSpline Curve passing through an
//! array of Point, which parameters are given by the
//! array <Parameters>.
//! The resulting BSpline will have the following
//! The resulting BSpline will have the following
//! properties:
//! 1- his degree will be in the range [Degmin,Degmax]
//! 2- his continuity will be at least <Continuity>
//! 2- his continuity will be at least <Continuity>
//! 3- the distance from the point <Points> to the
//! BSpline will be lower to Tol3D
Standard_EXPORT GeomAPI_PointsToBSpline(const TColgp_Array1OfPnt& Points,
@@ -87,7 +87,7 @@ public:
const GeomAbs_Shape Continuity = GeomAbs_C2,
const Standard_Real Tol3D = 1.0e-3);
//! Approximate a BSpline Curve passing through an
//! Approximate a BSpline Curve passing through an
//! array of Point using variational smoothing algorithm,
//! which tries to minimize additional criterium:
//! Weight1*CurveLength + Weight2*Curvature + Weight3*Torsion
@@ -99,11 +99,11 @@ public:
const GeomAbs_Shape Continuity = GeomAbs_C2,
const Standard_Real Tol3D = 1.0e-3);
//! Approximate a BSpline Curve passing through an
//! array of Point. The resulting BSpline will have
//! Approximate a BSpline Curve passing through an
//! array of Point. The resulting BSpline will have
//! the following properties:
//! 1- his degree will be in the range [Degmin,Degmax]
//! 2- his continuity will be at least <Continuity>
//! 2- his continuity will be at least <Continuity>
//! 3- the distance from the point <Points> to the
//! BSpline will be lower to Tol3D
Standard_EXPORT void Init(const TColgp_Array1OfPnt& Points,
@@ -112,11 +112,11 @@ public:
const GeomAbs_Shape Continuity = GeomAbs_C2,
const Standard_Real Tol3D = 1.0e-3);
//! Approximate a BSpline Curve passing through an
//! array of Point. The resulting BSpline will have
//! Approximate a BSpline Curve passing through an
//! array of Point. The resulting BSpline will have
//! the following properties:
//! 1- his degree will be in the range [Degmin,Degmax]
//! 2- his continuity will be at least <Continuity>
//! 2- his continuity will be at least <Continuity>
//! 3- the distance from the point <Points> to the
//! BSpline will be lower to Tol3D
Standard_EXPORT void Init(const TColgp_Array1OfPnt& Points,
@@ -126,13 +126,13 @@ public:
const GeomAbs_Shape Continuity = GeomAbs_C2,
const Standard_Real Tol3D = 1.0e-3);
//! Approximate a BSpline Curve passing through an
//! array of Point, which parameters are given by the
//! Approximate a BSpline Curve passing through an
//! array of Point, which parameters are given by the
//! array <Parameters>.
//! The resulting BSpline will have the following
//! The resulting BSpline will have the following
//! properties:
//! 1- his degree will be in the range [Degmin,Degmax]
//! 2- his continuity will be at least <Continuity>
//! 2- his continuity will be at least <Continuity>
//! 3- the distance from the point <Points> to the
//! BSpline will be lower to Tol3D
Standard_EXPORT void Init(const TColgp_Array1OfPnt& Points,
@@ -142,7 +142,7 @@ public:
const GeomAbs_Shape Continuity = GeomAbs_C2,
const Standard_Real Tol3D = 1.0e-3);
//! Approximate a BSpline Curve passing through an
//! Approximate a BSpline Curve passing through an
//! array of Point using variational smoothing algorithm,
//! which tries to minimize additional criterium:
//! Weight1*CurveLength + Weight2*Curvature + Weight3*Torsion
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ProjectPointOnCurve.hxx
+7 -7
View File
@@ -27,8 +27,8 @@
class gp_Pnt;
class Geom_Curve;
//! This class implements methods for computing all the orthogonal
//! projections of a 3D point onto a 3D curve.
//! This class implements methods for computing all the orthogonal
//! projections of a 3D point onto a 3D curve.
class GeomAPI_ProjectPointOnCurve
{
public:
@@ -38,29 +38,29 @@ public:
//! Init function for further initialization.
Standard_EXPORT GeomAPI_ProjectPointOnCurve();
//! Create the projection of a point <P> on a curve
//! Create the projection of a point <P> on a curve
//! <Curve>
Standard_EXPORT GeomAPI_ProjectPointOnCurve(const gp_Pnt& P, const Handle(Geom_Curve)& Curve);
//! Create the projection of a point <P> on a curve
//! Create the projection of a point <P> on a curve
//! <Curve> limited by the two points of parameter Umin and Usup.
Standard_EXPORT GeomAPI_ProjectPointOnCurve(const gp_Pnt& P,
const Handle(Geom_Curve)& Curve,
const Standard_Real Umin,
const Standard_Real Usup);
//! Init the projection of a point <P> on a curve
//! Init the projection of a point <P> on a curve
//! <Curve>
Standard_EXPORT void Init(const gp_Pnt& P, const Handle(Geom_Curve)& Curve);
//! Init the projection of a point <P> on a curve
//! Init the projection of a point <P> on a curve
//! <Curve> limited by the two points of parameter Umin and Usup.
Standard_EXPORT void Init(const gp_Pnt& P,
const Handle(Geom_Curve)& Curve,
const Standard_Real Umin,
const Standard_Real Usup);
//! Init the projection of a point <P> on a curve
//! Init the projection of a point <P> on a curve
//! <Curve> limited by the two points of parameter Umin and Usup.
Standard_EXPORT void Init(const Handle(Geom_Curve)& Curve,
const Standard_Real Umin,
src/ModelingAlgorithms/TKGeomAlgo/GeomAPI/GeomAPI_ProjectPointOnSurf.hxx
+7 -7
View File
@@ -29,8 +29,8 @@
class gp_Pnt;
class Geom_Surface;
//! This class implements methods for computing all the orthogonal
//! projections of a point onto a surface.
//! This class implements methods for computing all the orthogonal
//! projections of a point onto a surface.
class GeomAPI_ProjectPointOnSurf
{
public:
@@ -40,15 +40,15 @@ public:
//! Init function for further initialization.
Standard_EXPORT GeomAPI_ProjectPointOnSurf();
//! Create the projection of a point <P> on a surface
//! Create the projection of a point <P> on a surface
//! <Surface>
Standard_EXPORT GeomAPI_ProjectPointOnSurf(const gp_Pnt& P,
const Handle(Geom_Surface)& Surface,
const Extrema_ExtAlgo Algo = Extrema_ExtAlgo_Grad);
//! Create the projection of a point <P> on a surface
//! Create the projection of a point <P> on a surface
//! <Surface>
//! Create the projection of a point <P> on a surface
//! Create the projection of a point <P> on a surface
//! <Surface>. The solution are computed in the domain
//! [Umin,Usup] [Vmin,Vsup] of the surface.
Standard_EXPORT GeomAPI_ProjectPointOnSurf(const gp_Pnt& P,
@@ -65,7 +65,7 @@ public:
const Standard_Real Tolerance,
const Extrema_ExtAlgo Algo = Extrema_ExtAlgo_Grad);
//! Init the projection of a point <P> on a surface
//! Init the projection of a point <P> on a surface
//! <Surface>
Standard_EXPORT GeomAPI_ProjectPointOnSurf(const gp_Pnt& P,
const Handle(Geom_Surface)& Surface,
@@ -80,7 +80,7 @@ public:
const Standard_Real Tolerance,
const Extrema_ExtAlgo Algo = Extrema_ExtAlgo_Grad);
//! Init the projection of a point <P> on a surface
//! Init the projection of a point <P> on a surface
//! <Surface>. The solution are computed in the domain
//! [Umin,Usup] [Vmin,Vsup] of the surface.
Standard_EXPORT void Init(const gp_Pnt& P,