lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-06-06 04:37:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation - Fix whitespaces and typos (#824)

Browse Source 
- Fixed excessive whitespace in multi-line comments
- Corrected spelling errors (e.g., "selectionnable" → "selectable", "begenning" → "beginning")
- Improved comment formatting and readability
This commit is contained in:
luzpaz
2025-11-13 15:31:57 -05:00
committed by GitHub
parent 570b34b666
commit 79289339d8
161 changed files with 879 additions and 883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/ModelingData/TKBRep/BRep/BRep_Builder.hxx
View File

@@ -106,7 +106,7 @@ public:
//! Updates the face Tolerance.
Standard_EXPORT void UpdateFace(const TopoDS_Face& F, const Standard_Real Tol) const;
//! Sets the NaturalRestriction flag of the face.
//! Sets the NaturalRestriction flag of the face.
Standard_EXPORT void NaturalRestriction(const TopoDS_Face& F, const Standard_Boolean N) const;
//! Makes an undefined Edge (no geometry).
@@ -299,7 +299,7 @@ public:
const Standard_Real Last,
const Standard_Boolean Only3d = Standard_False) const;
//! Sets the range of the edge on the pcurve on the
//! Sets the range of the edge on the pcurve on the
//! surface.
Standard_EXPORT void Range(const TopoDS_Edge& E,
const Handle(Geom_Surface)& S,

4
src/ModelingData/TKBRep/BRep/BRep_TFace.hxx
View File

@@ -35,7 +35,7 @@ DEFINE_STANDARD_HANDLE(BRep_TFace, TopoDS_TFace)
//! * A surface, a tolerance and a Location.
//!
//! * A NaturalRestriction flag, when this flag is
//! True the boundary of the face is known to be the
//! True the boundary of the face is known to be the
//! parametric space (Umin, UMax, VMin, VMax).
//!
//! * An optional list of triangulations. If there are any
@@ -106,7 +106,7 @@ public:
Standard_EXPORT void Triangulation(const Handle(Poly_Triangulation)& theTriangulation,
const Standard_Boolean theToReset = true);
//! Returns a copy of the TShape with no sub-shapes.
//! Returns a copy of the TShape with no sub-shapes.
//! The new Face has no triangulation.
Standard_EXPORT virtual Handle(TopoDS_TShape) EmptyCopy() const Standard_OVERRIDE;

6
src/ModelingData/TKBRep/BRep/BRep_Tool.hxx
View File

@@ -39,7 +39,7 @@ class TopLoc_Location;
class TopoDS_Edge;
class TopoDS_Vertex;
//! Provides class methods to access to the geometry
//! Provides class methods to access to the geometry
//! of BRep shapes.
class BRep_Tool
{
@@ -86,7 +86,7 @@ public:
//! Returns the tolerance of the face.
Standard_EXPORT static Standard_Real Tolerance(const TopoDS_Face& F);
//! Returns the NaturalRestriction flag of the face.
//! Returns the NaturalRestriction flag of the face.
Standard_EXPORT static Standard_Boolean NaturalRestriction(const TopoDS_Face& F);
//! Returns True if <F> has a surface, false otherwise.
@@ -259,7 +259,7 @@ public:
//! Returns the SameRange flag for the edge.
Standard_EXPORT static Standard_Boolean SameRange(const TopoDS_Edge& E);
//! Returns True if the edge is degenerated.
//! Returns True if the edge is degenerated.
Standard_EXPORT static Standard_Boolean Degenerated(const TopoDS_Edge& E);
//! Gets the range of the 3d curve.

4
src/ModelingData/TKBRep/BRepAdaptor/BRepAdaptor_CompCurve.hxx
View File

@@ -47,7 +47,7 @@ DEFINE_STANDARD_HANDLE(BRepAdaptor_CompCurve, Adaptor3d_Curve)
//! The Curve from BRepAdaptor allows to use a Wire
//! of the BRep topology like a 3D curve.
//! Warning: With this class of curve, C0 and C1 continuities
//! Warning: With this class of curve, C0 and C1 continuities
//! are not assumed. So be careful with some algorithm!
//! Please note that BRepAdaptor_CompCurve cannot be
//! periodic curve at all (even if it contains single
@@ -76,7 +76,7 @@ public:
//! Shallow copy of adaptor.
Standard_EXPORT virtual Handle(Adaptor3d_Curve) ShallowCopy() const Standard_OVERRIDE;
//! Sets the wire <W>.
//! Sets the wire <W>.
Standard_EXPORT void Initialize(const TopoDS_Wire& W,
const Standard_Boolean KnotByCurvilinearAbcissa);

2
src/ModelingData/TKBRep/BRepAdaptor/BRepAdaptor_Curve.hxx
View File

@@ -43,7 +43,7 @@ class Geom_OffsetCurve;
DEFINE_STANDARD_HANDLE(BRepAdaptor_Curve, Adaptor3d_Curve)
//! The Curve from BRepAdaptor allows to use an Edge
//! The Curve from BRepAdaptor allows to use an Edge
//! of the BRep topology like a 3D curve.
//!
//! It has the methods the class Curve from Adaptor3d.

2
src/ModelingData/TKBRep/BRepLProp/BRepLProp_CLProps.hxx
View File

@@ -97,7 +97,7 @@ public:
//! three first derivatives are all null.
Standard_EXPORT Standard_Boolean IsTangentDefined();
//! output the tangent direction <D>
//! output the tangent direction <D>
Standard_EXPORT void Tangent(gp_Dir& D);
//! Returns the curvature.

2
src/ModelingData/TKBRep/BRepTools/BRepTools_CopyModification.hxx
View File

@@ -91,7 +91,7 @@ public:
//! Returns the continuity of theNewEdge between theNewFace1 and theNewFace2.
//!
//! theNewEdge is the new edge created from theEdge. theNewFace1
//! theNewEdge is the new edge created from theEdge. theNewFace1
//! (resp. theNewFace2) is the new face created from theFace1 (resp. theFace2).
Standard_EXPORT GeomAbs_Shape Continuity(const TopoDS_Edge& theEdge,
const TopoDS_Face& theFace1,

2
src/ModelingData/TKBRep/BRepTools/BRepTools_GTrsfModification.hxx
View File

@@ -55,7 +55,7 @@ public:
//! normal of the surface. (the wires have to be
//! reversed). <RevFace> has to be set to
//! Standard_True if the orientation of the modified
//! face changes in the shells which contain it. --
//! face changes in the shells which contain it.
//! Here, <RevFace> will return Standard_True if the
//! -- gp_Trsf is negative.
Standard_EXPORT Standard_Boolean NewSurface(const TopoDS_Face& F,

6
src/ModelingData/TKBRep/BRepTools/BRepTools_Modification.hxx
View File

@@ -135,10 +135,10 @@ public:
Standard_Real& P,
Standard_Real& Tol) = 0;
//! Returns the continuity of <NewE> between <NewF1>
//! Returns the continuity of <NewE> between <NewF1>
//! and <NewF2>.
//! <NewE> is the new edge created from <E>. <NewF1>
//! (resp. <NewF2>) is the new face created from <F1>
//! <NewE> is the new edge created from <E>. <NewF1>
//! (resp. <NewF2>) is the new face created from <F1>
//! (resp. <F2>).
Standard_EXPORT virtual GeomAbs_Shape Continuity(const TopoDS_Edge& E,
const TopoDS_Face& F1,

2
src/ModelingData/TKBRep/BRepTools/BRepTools_Modifier.hxx
View File

@@ -49,7 +49,7 @@ public:
//! Creates a modifier on the shape <S>.
Standard_EXPORT BRepTools_Modifier(const TopoDS_Shape& S);
//! Creates a modifier on the shape <S>, and performs
//! Creates a modifier on the shape <S>, and performs
//! the modifications described by <M>.
Standard_EXPORT BRepTools_Modifier(const TopoDS_Shape& S,
const Handle(BRepTools_Modification)& M);

2
src/ModelingData/TKBRep/BRepTools/BRepTools_NurbsConvertModification.hxx
View File

@@ -54,7 +54,7 @@ public:
//! normal of the surface. (the wires have to be
//! reversed). <RevFace> has to be set to
//! Standard_True if the orientation of the modified
//! face changes in the shells which contain it. --
//! face changes in the shells which contain it.
//! Here, <RevFace> will return Standard_True if the
//! -- gp_Trsf is negative.
Standard_EXPORT Standard_Boolean NewSurface(const TopoDS_Face& F,

2
src/ModelingData/TKBRep/BRepTools/BRepTools_Quilt.hxx
View File

@@ -49,7 +49,7 @@ public:
//! Binds <Enew> to be the new edge instead of <Eold>.
//!
//! The faces of the added shape containing <Eold>
//! The faces of the added shape containing <Eold>
//! will be copied to substitute <Eold> by <Enew>.
//!
//! The vertices of <Eold> will be bound to the

4
src/ModelingData/TKBRep/BRepTools/BRepTools_ShapeSet.hxx
View File

@@ -33,7 +33,7 @@
class TopoDS_Shape;
//! Contains a Shape and all its subshapes, locations
//! Contains a Shape and all its subshapes, locations
//! and geometries.
//!
//! The topology is inherited from TopTools.
@@ -152,7 +152,7 @@ public:
Standard_EXPORT void DumpTriangulation(Standard_OStream& OS) const;
//! Reads the polygons on triangulation of me
//! from the stream <IS>.
//! from the stream <IS>.
Standard_EXPORT void ReadPolygonOnTriangulation(
Standard_IStream& IS,
const Message_ProgressRange& theProgress = Message_ProgressRange());

6
src/ModelingData/TKBRep/BRepTools/BRepTools_TrsfModification.hxx
View File

@@ -133,11 +133,11 @@ public:
Standard_Real& P,
Standard_Real& Tol) Standard_OVERRIDE;
//! Returns the continuity of <NewE> between <NewF1>
//! Returns the continuity of <NewE> between <NewF1>
//! and <NewF2>.
//!
//! <NewE> is the new edge created from <E>. <NewF1>
//! (resp. <NewF2>) is the new face created from <F1>
//! <NewE> is the new edge created from <E>. <NewF1>
//! (resp. <NewF2>) is the new face created from <F1>
//! (resp. <F2>).
Standard_EXPORT GeomAbs_Shape Continuity(const TopoDS_Edge& E,
const TopoDS_Face& F1,

6
src/ModelingData/TKBRep/BinTools/BinTools_ShapeSet.hxx
View File

@@ -139,7 +139,7 @@ public:
Standard_EXPORT virtual void AddShapes(TopoDS_Shape& S1, const TopoDS_Shape& S2);
//! Reads the 3d polygons of me
//! from the stream <IS>.
//! from the stream <IS>.
Standard_EXPORT void ReadPolygon3D(
Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
@@ -152,7 +152,7 @@ public:
const Message_ProgressRange& theRange = Message_ProgressRange()) const;
//! Reads the triangulation of me
//! from the stream <IS>.
//! from the stream <IS>.
Standard_EXPORT void ReadTriangulation(
Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());
@@ -165,7 +165,7 @@ public:
const Message_ProgressRange& theRange = Message_ProgressRange()) const;
//! Reads the polygons on triangulation of me
//! from the stream <IS>.
//! from the stream <IS>.
Standard_EXPORT void ReadPolygonOnTriangulation(
Standard_IStream& IS,
const Message_ProgressRange& theRange = Message_ProgressRange());

8
src/ModelingData/TKBRep/TopExp/TopExp.hxx
View File

@@ -47,7 +47,7 @@ public:
DEFINE_STANDARD_ALLOC
//! Tool to explore a topological data structure.
//! Stores in the map <M> all the sub-shapes of <S>
//! Stores in the map <M> all the sub-shapes of <S>
//! of type <T>.
//!
//! Warning: The map is not cleared at first.
@@ -55,7 +55,7 @@ public:
const TopAbs_ShapeEnum T,
TopTools_IndexedMapOfShape& M);
//! Stores in the map <M> all the sub-shapes of <S>.
//! Stores in the map <M> all the sub-shapes of <S>.
//! - If cumOri is true, the function composes all
//! sub-shapes with the orientation of S.
//! - If cumLoc is true, the function multiplies all
@@ -66,7 +66,7 @@ public:
const Standard_Boolean cumOri = Standard_True,
const Standard_Boolean cumLoc = Standard_True);
//! Stores in the map <M> all the sub-shapes of <S>.
//! Stores in the map <M> all the sub-shapes of <S>.
//! - If cumOri is true, the function composes all
//! sub-shapes with the orientation of S.
//! - If cumLoc is true, the function multiplies all
@@ -112,7 +112,7 @@ public:
Standard_EXPORT static TopoDS_Vertex LastVertex(const TopoDS_Edge& E,
const Standard_Boolean CumOri = Standard_False);
//! Returns in Vfirst, Vlast the FORWARD and REVERSED
//! Returns in Vfirst, Vlast the FORWARD and REVERSED
//! vertices of the edge <E>. May be null shapes.
//! CumOri = True : taking account the edge orientation
Standard_EXPORT static void Vertices(const TopoDS_Edge& E,

4
src/ModelingData/TKBRep/TopTools/TopTools.hxx
View File

@@ -24,10 +24,10 @@
#include <Standard_OStream.hxx>
class TopoDS_Shape;
//! The TopTools package provides utilities for the
//! The TopTools package provides utilities for the
//! topological data structure.
//!
//! * ShapeMapHasher. Hash a Shape base on the TShape
//! * ShapeMapHasher. Hash a Shape base on the TShape
//! and the Location. The Orientation is not used.
//!
//! * OrientedShapeMapHasher. Hash a Shape base on the

32
src/ModelingData/TKBRep/TopoDS/TopoDS_Shape.hxx
View File

@@ -102,7 +102,7 @@ public:
myLocation = theLoc;
}
//! Returns a shape similar to <me> with the local
//! Returns a shape similar to <me> with the local
//! coordinate system set to <Loc>.
//! @param theLoc the new local coordinate system.
//! @param theRaiseExc flag to raise exception in case of transformation with scale or negative.
@@ -121,7 +121,7 @@ public:
//! Sets the shape orientation.
void Orientation(TopAbs_Orientation theOrient) { myOrient = theOrient; }
//! Returns a shape similar to <me> with the
//! Returns a shape similar to <me> with the
//! orientation set to <Or>.
TopoDS_Shape Oriented(TopAbs_Orientation theOrient) const
{
@@ -217,8 +217,8 @@ public:
//! from the TopAbs package.
void Reverse() { myOrient = TopAbs::Reverse(myOrient); }
//! Returns a shape similar to <me> with the
//! orientation reversed, using the Reverse method
//! Returns a shape similar to <me> with the
//! orientation reversed, using the Reverse method
//! from the TopAbs package.
TopoDS_Shape Reversed() const
{
@@ -227,12 +227,12 @@ public:
return aShape;
}
//! Complements the orientation, using the Complement
//! Complements the orientation, using the Complement
//! method from the TopAbs package.
void Complement() { myOrient = TopAbs::Complement(myOrient); }
//! Returns a shape similar to <me> with the
//! orientation complemented, using the Complement
//! Returns a shape similar to <me> with the
//! orientation complemented, using the Complement
//! method from the TopAbs package.
TopoDS_Shape Complemented() const
{
@@ -245,7 +245,7 @@ public:
//! using the Compose method from the TopAbs package.
void Compose(TopAbs_Orientation theOrient) { myOrient = TopAbs::Compose(myOrient, theOrient); }
//! Returns a shape similar to <me> with the
//! Returns a shape similar to <me> with the
//! orientation composed with theOrient, using the
//! Compose method from the TopAbs package.
TopoDS_Shape Composed(TopAbs_Orientation theOrient) const
@@ -259,16 +259,16 @@ public:
//! @sa TopoDS_Iterator for accessing sub-shapes
Standard_Integer NbChildren() const { return myTShape.IsNull() ? 0 : myTShape->NbChildren(); }
//! Returns True if two shapes are partners, i.e. if
//! they share the same TShape. Locations and
//! Returns True if two shapes are partners, i.e. if
//! they share the same TShape. Locations and
//! Orientations may differ.
Standard_Boolean IsPartner(const TopoDS_Shape& theOther) const
{
return (myTShape == theOther.myTShape);
}
//! Returns True if two shapes are same, i.e. if they
//! share the same TShape with the same Locations.
//! Returns True if two shapes are same, i.e. if they
//! share the same TShape with the same Locations.
//! Orientations may differ.
Standard_Boolean IsSame(const TopoDS_Shape& theOther) const
{
@@ -276,7 +276,7 @@ public:
}
//! Returns True if two shapes are equal, i.e. if they
//! share the same TShape with the same Locations and
//! share the same TShape with the same Locations and
//! Orientations.
Standard_Boolean IsEqual(const TopoDS_Shape& theOther) const
{
@@ -291,13 +291,13 @@ public:
Standard_Boolean operator!=(const TopoDS_Shape& theOther) const { return IsNotEqual(theOther); }
//! Replace <me> by a new Shape with the same
//! Replace <me> by a new Shape with the same
//! Orientation and Location and a new TShape with the
//! same geometry and no sub-shapes.
void EmptyCopy() { myTShape = myTShape->EmptyCopy(); }
//! Returns a new Shape with the same Orientation and
//! Location and a new TShape with the same geometry
//! Returns a new Shape with the same Orientation and
//! Location and a new TShape with the same geometry
//! and no sub-shapes.
TopoDS_Shape EmptyCopied() const
{

2
src/ModelingData/TKBRep/TopoDS/TopoDS_TShape.hxx
View File

@@ -125,7 +125,7 @@ public:
//! VERTEX, EDGE, WIRE, FACE, ....
Standard_EXPORT virtual TopAbs_ShapeEnum ShapeType() const = 0;
//! Returns a copy of the TShape with no sub-shapes.
//! Returns a copy of the TShape with no sub-shapes.
Standard_EXPORT virtual Handle(TopoDS_TShape) EmptyCopy() const = 0;
//! Returns the number of direct sub-shapes (children).