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

Documentation - Fix whitespaces and typos (#819)

Browse Source 
- Fixed inconsistent whitespace and line breaks in comments
- Corrected spelling errors ("witch" → "which", "sprcified" → "specified", "nul" → "null", etc.)
- Improved formatting consistency in documentation comments
This commit is contained in:
luzpaz
2025-11-12 13:06:11 -05:00
committed by GitHub
parent 61d69fde9e
commit ed1d0c88cc
164 changed files with 765 additions and 770 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_HCurve2dTool.hxx
+6 -6
View File
@@ -42,14 +42,14 @@ public:
static GeomAbs_Shape Continuity(const Handle(Adaptor2d_Curve2d)& C);
//! Returns the number of intervals for continuity
//! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(myclass) >= <S>
static Standard_Integer NbIntervals(const Handle(Adaptor2d_Curve2d)& C, const GeomAbs_Shape S);
//! Stores in <T> the parameters bounding the intervals
//! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
//! The array must provide enough room to accommodate
//! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
static void Intervals(const Handle(Adaptor2d_Curve2d)& C,
TColStd_Array1OfReal& T,
@@ -106,12 +106,12 @@ public:
const Standard_Real U,
const Standard_Integer N);
//! Returns the parametric resolution corresponding
//! Returns the parametric resolution corresponding
//! to the real space resolution <R3d>.
static Standard_Real Resolution(const Handle(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 Handle(Adaptor2d_Curve2d)& C);
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_InterferencePolyhedron.hxx
+6 -6
View File
@@ -26,9 +26,9 @@
class IntPatch_Polyhedron;
class Intf_TangentZone;
//! Computes the interference between two polyhedra or the
//! Computes the interference between two polyhedra or the
//! self interference of a polyhedron. Points of intersection,
//! polylines of intersection and zones of tangence.
//! polylines of intersection and zones of tangence.
class IntPatch_InterferencePolyhedron : public Intf_Interference
{
public:
@@ -37,12 +37,12 @@ public:
//! Constructs an empty interference of Polyhedron.
Standard_EXPORT IntPatch_InterferencePolyhedron();
//! Constructs and computes an interference between the two
//! Constructs and computes an interference between the two
//! Polyhedra.
Standard_EXPORT IntPatch_InterferencePolyhedron(const IntPatch_Polyhedron& Obje1,
const IntPatch_Polyhedron& Obje2);
//! Constructs and computes the self interference of a
//! Constructs and computes the self interference of a
//! Polyhedron.
Standard_EXPORT IntPatch_InterferencePolyhedron(const IntPatch_Polyhedron& Obje);
@@ -62,14 +62,14 @@ private:
Standard_EXPORT void Interference(const IntPatch_Polyhedron& Obje1,
const IntPatch_Polyhedron& Obje2);
//! Computes the intersection between the facet <Tri1> of
//! Computes the intersection between the facet <Tri1> of
//! <FirstPol> and the facet <Tri2> of <SecondPol>.
Standard_EXPORT void Intersect(const Standard_Integer TriF,
const IntPatch_Polyhedron& Obje1,
const Standard_Integer TriS,
const IntPatch_Polyhedron& Obje2);
//! Computes the zone of tangence between the facet <Tri1> of
//! Computes the zone of tangence between the facet <Tri1> of
//! <FirstPol> and the facet <Tri2> of <SecondPol>.
Standard_EXPORT Standard_Boolean TangentZoneValue(Intf_TangentZone& TheTZ,
const IntPatch_Polyhedron& Obje1,
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_Intersection.hxx
+5 -5
View File
@@ -52,18 +52,18 @@ public:
//! --- Parametric - Parametric
//! --- Implicit - Implicit
//!
//! TolArc is used to compute the intersections
//! between the restrictions of a surface and a
//! TolArc is used to compute the intersections
//! between the restrictions of a surface and a
//! walking line.
//!
//! TolTang is used to compute the points on a walking
//! line, and in geometric algorithms.
//!
//! Fleche is a parameter used in the walking
//! Fleche is a parameter used in the walking
//! algorithms to provide small curvatures on a line.
//!
//! UVMaxStep is a parameter used in the walking
//! algorithms to compute the distance between to
//! UVMaxStep is a parameter used in the walking
//! algorithms to compute the distance between to
//! points in their respective parametric spaces.
Standard_EXPORT void SetTolerances(const Standard_Real TolArc,
const Standard_Real TolTang,
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_Line.hxx
+1 -1
View File
@@ -61,7 +61,7 @@ public:
//! a way that the system of vector (N1,N2,T) is right-handed,
//! where N1 is the normal to the first surface at a point P,
//! N2 is the normal to the second surface at a point P,
//! T is the tangent to the intersection line at P.
//! T is the tangent to the intersection line at P.
//! If the system of vector is left-handed, the transition
//! is OUT.
//! When N1 and N2 are colinear all along the intersection
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_LineConstructor.hxx
+2 -2
View File
@@ -22,8 +22,8 @@
class Adaptor3d_TopolTool;
//! The intersections algorithms compute the intersection
//! on two surfaces and return the intersections lines as
//! The intersections algorithms compute the intersection
//! on two surfaces and return the intersections lines as
//! IntPatch_Line.
class IntPatch_LineConstructor
{
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_Polyhedron.hxx
+1 -1
View File
@@ -21,7 +21,7 @@
#include <Bnd_HArray1OfBox.hxx>
//! This class provides a linear approximation of the PSurface.
//! preview a constructor on a zone of a surface
//! preview a constructor on a zone of a surface
class IntPatch_Polyhedron
{
public:
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_PolyhedronTool.hxx
+6 -6
View File
@@ -29,7 +29,7 @@ class IntPatch_Polyhedron;
class gp_Pnt;
//! Describe the signature of a polyhedral surface with
//! only triangular facets and the necessary information
//! only triangular facets and the necessary information
//! to compute the interferences.
class IntPatch_PolyhedronTool
{
@@ -49,7 +49,7 @@ public:
//! Give the number of triangles in this polyhedral surface.
static Standard_Integer NbTriangles(const IntPatch_Polyhedron& thePolyh);
//! Give the indices of the 3 points of the triangle of
//! Give the indices of the 3 points of the triangle of
//! address Index in the Polyhedron.
static void Triangle(const IntPatch_Polyhedron& thePolyh,
const Standard_Integer Index,
@@ -62,10 +62,10 @@ public:
//! Gives the address Tricon of the triangle connexe to
//! the triangle of address Triang by the edge Pivot Pedge
//! and the third point of this connexe triangle. When we
//! are on a free edge TriCon==0 but the function return
//! the value of the triangle in the other side of Pivot
//! on the free edge. Used to turn around a vertex.
//! and the third point of this connexe triangle. When we
//! are on a free edge TriCon==0 but the function return
//! the value of the triangle in the other side of Pivot
//! on the free edge. Used to turn around a vertex.
static Standard_Integer TriConnex(const IntPatch_Polyhedron& thePolyh,
const Standard_Integer Triang,
const Standard_Integer Pivot,
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_PrmPrmIntersection.hxx
+16 -16
View File
@@ -39,8 +39,8 @@ public:
//! Empty Constructor
Standard_EXPORT IntPatch_PrmPrmIntersection();
//! Performs the intersection between <Caro1> and
//! <Caro2>. Associated Polyhedrons <Polyhedron1>
//! Performs the intersection between <Caro1> and
//! <Caro2>. Associated Polyhedrons <Polyhedron1>
//! and <Polyhedron2> are given.
Standard_EXPORT void Perform(const Handle(Adaptor3d_Surface)& Caro1,
const IntPatch_Polyhedron& Polyhedron1,
@@ -61,7 +61,7 @@ public:
const Standard_Real Deflection,
const Standard_Real Increment);
//! Performs the intersection between <Caro1> and
//! Performs the intersection between <Caro1> and
//! <Caro2>. The method computes the polyhedron on
//! each surface.
Standard_EXPORT void Perform(const Handle(Adaptor3d_Surface)& Caro1,
@@ -74,7 +74,7 @@ public:
const Standard_Real Increment,
const Standard_Boolean ClearFlag = Standard_True);
//! Performs the intersection between <Caro1> and
//! Performs the intersection between <Caro1> and
//! <Caro2>. The method computes the polyhedron on
//! each surface.
Standard_EXPORT void Perform(const Handle(Adaptor3d_Surface)& Caro1,
@@ -87,7 +87,7 @@ public:
const Standard_Real Increment,
IntSurf_ListOfPntOn2S& ListOfPnts);
//! Performs the intersection between <Caro1> and
//! Performs the intersection between <Caro1> and
//! <Caro2>. The method computes the polyhedron on
//! each surface.
Standard_EXPORT void Perform(const Handle(Adaptor3d_Surface)& Caro1,
@@ -103,7 +103,7 @@ public:
const Standard_Real Deflection,
const Standard_Real Increment);
//! Performs the intersection between <Caro1> and
//! Performs the intersection between <Caro1> and
//! <Caro2>. The method computes the polyhedron on
//! each surface.
Standard_EXPORT void Perform(const Handle(Adaptor3d_Surface)& Caro1,
@@ -113,10 +113,10 @@ public:
const Standard_Real Deflection,
const Standard_Real Increment);
//! Performs the intersection between <Caro1> and
//! Performs the intersection between <Caro1> and
//! <Caro2>.
//!
//! The polyhedron which approximates <Caro2>,
//! The polyhedron which approximates <Caro2>,
//! <Polyhedron2> is given. The other one is
//! computed.
Standard_EXPORT void Perform(const Handle(Adaptor3d_Surface)& Caro1,
@@ -129,10 +129,10 @@ public:
const Standard_Real Deflection,
const Standard_Real Increment);
//! Performs the intersection between <Caro1> and
//! Performs the intersection between <Caro1> and
//! <Caro2>.
//!
//! The polyhedron which approximates <Caro1>,
//! The polyhedron which approximates <Caro1>,
//! <Polyhedron1> is given. The other one is
//! computed.
Standard_EXPORT void Perform(const Handle(Adaptor3d_Surface)& Caro1,
@@ -158,14 +158,14 @@ public:
//! An exception is raised if Index<=0 or Index>NbLine.
const Handle(IntPatch_Line)& Line(const Standard_Integer Index) const;
//! Computes about <NbPoints> Intersection Points on
//! the Line <IndexLine> between the Points of Index
//! Computes about <NbPoints> Intersection Points on
//! the Line <IndexLine> between the Points of Index
//! <LowPoint> and <HighPoint>.
//!
//! All the points of the line of index <IndexLine>
//! with an index between <LowPoint> and <HighPoint>
//! are in the returned line. New Points are inserted
//! between existing points if those points are not
//! All the points of the line of index <IndexLine>
//! with an index between <LowPoint> and <HighPoint>
//! are in the returned line. New Points are inserted
//! between existing points if those points are not
//! too closed.
//!
//! An exception is raised if Index<=0 or Index>NbLine.
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_RLine.hxx
+1 -1
View File
@@ -177,7 +177,7 @@ public:
//! if (theMode == 0) then prints the information about WLine
//! if (theMode == 1) then prints the list of 3d-points
//! if (theMode == 2) then prints the list of 2d-points on the 1st surface
//! Otherwise, prints list of 2d-points on the 2nd surface
//! Otherwise, prints list of 2d-points on the 2nd surface
Standard_EXPORT void Dump(const Standard_Integer theMode) const;
DEFINE_STANDARD_RTTIEXT(IntPatch_RLine, IntPatch_PointLine)
src/ModelingAlgorithms/TKGeomAlgo/IntPatch/IntPatch_TheIWLineOfTheIWalking.hxx
+9 -10
View File
@@ -67,9 +67,8 @@ public:
void AddStatusLast(const Standard_Boolean HasLast,
const Standard_Integer Index,
const IntSurf_PathPoint& P);
//! associer a l 'indice du point sur la ligne l'indice du point
//! passant dans l'iterateur de depart
//! associate the index of the point on the line with the index of the point
//! passing through the starting iterator
void AddIndexPassing(const Standard_Integer Index);
void SetTangentVector(const gp_Vec& V, const Standard_Integer Index);
@@ -93,15 +92,15 @@ public:
Standard_Boolean IsClosed() const;
//! Returns True if the first point of the line is a
//! marching point . when is HasFirstPoint==False ,the line
//! begins on the natural bound of the surface.the line can be
//! too long
//! marching point. when HasFirstPoint==False the line
//! begins on the natural bound of the surface. The line
//! can be too long
Standard_Boolean HasFirstPoint() const;
//! Returns True if the end point of the line is a
//! marching point (Point from IntWS).
//! when is HasFirstPoint==False ,the line ends
//! on the natural bound of the surface.the line can be
//! when HasFirstPoint==False the line ends
//! on the natural bound of the surface. The line can be
//! too long.
Standard_Boolean HasLastPoint() const;
@@ -111,7 +110,7 @@ public:
const IntSurf_PathPoint& FirstPoint() const;
//! Returns the Index of first point of the line when it is a
//! marching point.This index is the index in the
//! marching point. This index is the index in the
//! PointStartIterator.
//! An exception is raised if HasFirstPoint returns False.
Standard_Integer FirstPointIndex() const;
@@ -122,7 +121,7 @@ public:
const IntSurf_PathPoint& LastPoint() const;
//! Returns the index of last point of the line when it is a
//! marching point.This index is the index in the
//! marching point. This index is the index in the
//! PointStartIterator.
//! An exception is raised if HasLastPoint returns False.
Standard_Integer LastPointIndex() const;