Documentation - Fix whitespaces and typos (#824)

- 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
@@ -136,13 +136,13 @@ public:
//! Add the edges of <W> to the current wire.
Standard_EXPORT void Add(const TopoDS_Wire& W);
//! Adds the edges of <L> to the current wire. The
//! edges are not to be consecutive. But they are to
//! be all connected geometrically or topologically.
//! If some of them are not connected the Status give
//! Adds the edges of <L> to the current wire. The
//! edges are not to be consecutive. But they are to
//! be all connected geometrically or topologically.
//! If some of them are not connected the Status give
//! DisconnectedWire but the "Maker" is Done() and you
//! can get the partial result. (ie connected to the
//! first edgeof the list <L>)
//! can get the partial result.
//! (i.e. connected to the first edgeof the list <L>)
Standard_EXPORT void Add(const TopTools_ListOfShape& L);
//! Returns true if this algorithm contains a valid wire.
@@ -55,7 +55,7 @@ public:
{
}
//! This constructor is used when the solution of distance is on an Edge.
//! This constructor is used when the solution of distance is on an Edge.
//! The different initialized fields are:
//! @param theDist the distance
//! @param thePoint the solution point
@@ -76,7 +76,7 @@ public:
{
}
//! This constructor is used when the solution of distance is in a Face.
//! This constructor is used when the solution of distance is in a Face.
//! The different initialized fields are:
//! @param theDist the distance
//! @param thePoint the solution point
@@ -25,25 +25,25 @@
class Geom_Surface;
class TopoDS_Shape;
//! Provides an algorithm to find a Surface through a
//! Provides an algorithm to find a Surface through a
//! set of edges.
//!
//! The edges of the shape given as argument are
//! explored if they are not coplanar at the required
//! tolerance the method Found returns false.
//! The edges of the shape given as argument are
//! explored if they are not coplanar at the required
//! tolerance the method Found returns false.
//!
//! If a null tolerance is given the max of the edges
//! If a null tolerance is given the max of the edges
//! tolerances is used.
//!
//! The method Tolerance returns the true distance of
//! The method Tolerance returns the true distance of
//! the edges to the Surface.
//!
//! The method Surface returns the Surface if found.
//!
//! The method Existed returns returns True if the
//! The method Existed returns True if the
//! Surface was already attached to some of the edges.
//!
//! When Existed returns True the Surface may have a
//! When Existed returns True the Surface may have a
//! location given by the Location method.
class BRepLib_FindSurface
{
@@ -52,26 +52,26 @@ public:
Standard_EXPORT BRepLib_FindSurface();
//! Computes the Surface from the edges of <S> with the
//! Computes the Surface from the edges of <S> with the
//! given tolerance.
//! if <OnlyPlane> is true, the computed surface will be
//! a plane. If it is not possible to find a plane, the
//! flag NotDone will be set.
//! If <OnlyClosed> is true, then S should be a wire
//! and the existing surface, on which wire S is not
//! If <OnlyClosed> is true, then S should be a wire
//! and the existing surface, on which wire S is not
//! closed in 2D, will be ignored.
Standard_EXPORT BRepLib_FindSurface(const TopoDS_Shape& S,
const Standard_Real Tol = -1,
const Standard_Boolean OnlyPlane = Standard_False,
const Standard_Boolean OnlyClosed = Standard_False);
//! Computes the Surface from the edges of <S> with the
//! Computes the Surface from the edges of <S> with the
//! given tolerance.
//! if <OnlyPlane> is true, the computed surface will be
//! a plane. If it is not possible to find a plane, the
//! flag NotDone will be set.
//! If <OnlyClosed> is true, then S should be a wire
//! and the existing surface, on which wire S is not
//! If <OnlyClosed> is true, then S should be a wire
//! and the existing surface, on which wire S is not
//! closed in 2D, will be ignored.
Standard_EXPORT void Init(const TopoDS_Shape& S,
const Standard_Real Tol = -1,
@@ -31,13 +31,13 @@
class TopoDS_Vertex;
class TopoDS_Edge;
//! This class can detect vertices in a face that can
//! This class can detect vertices in a face that can
//! be considered useless and then perform the fuse of
//! the edges and remove the useless vertices. By
//! useles vertices, we mean :
//! * vertices that have exactly two connex edges
//! the edges and remove the useless vertices. By
//! useles vertices, we mean:
//! * vertices that have exactly two connex edges
//! * the edges connex to the vertex must have
//! exactly the same 2 connex faces .
//! exactly the same 2 connex faces.
//! * The edges connex to the vertex must have the
//! same geometric support.
class BRepLib_FuseEdges
@@ -45,7 +45,7 @@ class BRepLib_FuseEdges
public:
DEFINE_STANDARD_ALLOC
//! Initialise members and build construction of map
//! Initialise members and build construction of map
//! of ancestors.
Standard_EXPORT BRepLib_FuseEdges(const TopoDS_Shape& theShape,
const Standard_Boolean PerformNow = Standard_False);
@@ -54,18 +54,18 @@ public:
Standard_EXPORT void AvoidEdges(const TopTools_IndexedMapOfShape& theMapEdg);
//! set mode to enable concatenation G1 BSpline edges in one
//! End Modified by IFV 19.04.07
//! End Modified by IFV 19.04.07
Standard_EXPORT void SetConcatBSpl(const Standard_Boolean theConcatBSpl = Standard_True);
//! returns all the list of edges to be fused
//! returns all the list of edges to be fused
//! each list of the map represent a set of connex edges
//! that can be fused.
Standard_EXPORT void Edges(TopTools_DataMapOfIntegerListOfShape& theMapLstEdg);
//! returns all the fused edges. each integer entry in
//! the map corresponds to the integer in the
//! DataMapOfIntegerListOfShape we get in method
//! Edges. That is to say, to the list of edges in
//! the map corresponds to the integer in the
//! DataMapOfIntegerListOfShape we get in method
//! Edges. That is to say, to the list of edges in
//! theMapLstEdg(i) corresponds the resulting edge theMapEdge(i)
Standard_EXPORT void ResultEdges(TopTools_DataMapOfIntegerShape& theMapEdg);
@@ -79,7 +79,7 @@ public:
//! returns the number of vertices candidate to be removed
Standard_EXPORT Standard_Integer NbVertices();
//! Using map of list of connex edges, fuse each list to
//! Using map of list of connex edges, fuse each list to
//! one edge and then update myShape
Standard_EXPORT void Perform();
@@ -88,7 +88,7 @@ private:
//! Build the all the lists of edges that are to be fused
Standard_EXPORT void BuildListEdges();
//! Build result fused edges according to the list
//! Build result fused edges according to the list
//! builtin BuildLisEdges
Standard_EXPORT void BuildListResultEdges();
@@ -37,34 +37,34 @@ class TopoDS_Edge;
//! Provides methods to build edges.
//!
//! The methods have the following syntax, where
//! The methods have the following syntax, where
//! TheCurve is one of Lin, Circ, ...
//!
//! Create(C : TheCurve)
//!
//! Makes an edge on the whole curve. Add vertices
//! Makes an edge on the whole curve. Add vertices
//! on finite curves.
//!
//! Create(C : TheCurve; p1,p2 : Real)
//!
//! Make an edge on the curve between parameters p1
//! Make an edge on the curve between parameters p1
//! and p2. if p2 < p1 the edge will be REVERSED. If
//! p1 or p2 is infinite the curve will be open in
//! that direction. Vertices are created for finite
//! p1 or p2 is infinite the curve will be open in
//! that direction. Vertices are created for finite
//! values of p1 and p2.
//!
//! Create(C : TheCurve; P1, P2 : Pnt from gp)
//!
//! Make an edge on the curve between the points P1
//! and P2. The points are projected on the curve
//! and the previous method is used. An error is
//! Make an edge on the curve between the points P1
//! and P2. The points are projected on the curve
//! and the previous method is used. An error is
//! raised if the points are not on the curve.
//!
//! Create(C : TheCurve; V1, V2 : Vertex from TopoDS)
//!
//! Make an edge on the curve between the vertices
//! V1 and V2. Same as the previous but no vertices
//! are created. If a vertex is Null the curve will
//! Make an edge on the curve between the vertices
//! V1 and V2. Same as the previous but no vertices
//! are created. If a vertex is Null the curve will
//! be open in this direction.
class BRepLib_MakeEdge : public BRepLib_MakeShape
{
@@ -35,34 +35,34 @@ class TopoDS_Edge;
//! Provides methods to build edges.
//!
//! The methods have the following syntax, where
//! The methods have the following syntax, where
//! TheCurve is one of Lin2d, Circ2d, ...
//!
//! Create(C : TheCurve)
//!
//! Makes an edge on the whole curve. Add vertices
//! Makes an edge on the whole curve. Add vertices
//! on finite curves.
//!
//! Create(C : TheCurve; p1,p2 : Real)
//!
//! Make an edge on the curve between parameters p1
//! Make an edge on the curve between parameters p1
//! and p2. if p2 < p1 the edge will be REVERSED. If
//! p1 or p2 is infinite the curve will be open in
//! that direction. Vertices are created for finite
//! p1 or p2 is infinite the curve will be open in
//! that direction. Vertices are created for finite
//! values of p1 and p2.
//!
//! Create(C : TheCurve; P1, P2 : Pnt2d from gp)
//!
//! Make an edge on the curve between the points P1
//! and P2. The points are projected on the curve
//! and the previous method is used. An error is
//! Make an edge on the curve between the points P1
//! and P2. The points are projected on the curve
//! and the previous method is used. An error is
//! raised if the points are not on the curve.
//!
//! Create(C : TheCurve; V1, V2 : Vertex from TopoDS)
//!
//! Make an edge on the curve between the vertices
//! V1 and V2. Same as the previous but no vertices
//! are created. If a vertex is Null the curve will
//! Make an edge on the curve between the vertices
//! V1 and V2. Same as the previous but no vertices
//! are created. If a vertex is Null the curve will
//! be open in this direction.
class BRepLib_MakeEdge2d : public BRepLib_MakeShape
{
@@ -34,26 +34,26 @@ class TopoDS_Wire;
//! Provides methods to build wires.
//!
//! A wire may be built :
//! A wire may be built:
//!
//! * From a single edge.
//!
//! * From a wire and an edge.
//!
//! - A new wire is created with the edges of the
//! - A new wire is created with the edges of the
//! wire + the edge.
//!
//! - If the edge is not connected to the wire the
//! flag NotDone is set and the method Wire will
//! - If the edge is not connected to the wire the
//! flag NotDone is set and the method Wire will
//! raise an error.
//!
//! - The connection may be :
//! - The connection may be:
//!
//! . Through an existing vertex. The edge is shared.
//!
//! . Through a geometric coincidence of vertices.
//! The edge is copied and the vertices from the
//! edge are replaced by the vertices from the
//! The edge is copied and the vertices from the
//! edge are replaced by the vertices from the
//! wire.
//!
//! . The new edge and the connection vertices are
@@ -61,7 +61,7 @@ class TopoDS_Wire;
//!
//! * From 2, 3, 4 edges.
//!
//! - A wire is created from the first edge, the
//! - A wire is created from the first edge, the
//! following edges are added.
//!
//! * From many edges.
@@ -113,7 +113,7 @@ public:
Standard_EXPORT void Add(const TopoDS_Wire& W);
//! Add the edges of <L> to the current wire.
//! The edges are not to be consecutive. But they are
//! The edges are not to be consecutive. But they are
//! to be all connected geometrically or topologically.
Standard_EXPORT void Add(const TopTools_ListOfShape& L);
@@ -41,8 +41,8 @@ class MAT_Arc;
//!
//! If the set of lines contains closed lines:
//! ------------------------------------------
//! These lines cut the plane in areas.
//! One map can be computed for each area.
//! These lines cut the plane in areas.
//! One map can be computed for each area.
//!
//! Bisecting locus computes a map in an area.
//! The area is defined by a side (MAT_Left,MAT_Right)
@@ -52,7 +52,7 @@ class MAT_Arc;
//! --------------------------------------------
//! the map recovers all the plane.
//!
//! Warning: Assume the orientation of the closed lines are
//! Warning: Assume the orientation of the closed lines are
//! compatible.
//!
//! Assume the explo contains only lines located in the
@@ -61,12 +61,12 @@ class MAT_Arc;
//! Assume a line don't cross itself or an other line.
//!
//! Remark:
//! the curves coming from the explorer can be
//! decomposed in different parts. It the case for the
//! the curves coming from the explorer can be
//! decomposed in different parts. It the case for the
//! curves other than circles or lines.
//!
//! The map of bisecting locus is described by a graph.
//! - The BasicsElements correspond to elements on
//! The map of bisecting locus is described by a graph.
//! - The BasicsElements correspond to elements on
//! the figure described by the Explorer from BRepMAT2d.
//! - The Arcs correspond to the bisectors.
//! - The Nodes are the extremities of the arcs.
@@ -115,12 +115,12 @@ public:
//! Returns the geometry linked to the <BasicElt>.
Standard_EXPORT Handle(Geom2d_Geometry) GeomElt(const Handle(MAT_BasicElt)& aBasicElt) const;
//! Returns the geometry of type <gp> linked to
//! Returns the geometry of type <gp> linked to
//! the <Node>.
Standard_EXPORT gp_Pnt2d GeomElt(const Handle(MAT_Node)& aNode) const;
//! Returns the geometry of type <Bissec>
//! linked to the arc <ARC>.
//! Returns the geometry of type <Bissec>
//! linked to the arc <ARC>.
//! <Reverse> is False when the FirstNode of <anArc>
//! correspond to the first point of geometry.
Standard_EXPORT Bisector_Bisec GeomBis(const Handle(MAT_Arc)& anArc,
@@ -50,11 +50,11 @@ public:
//! Returns the Number of contours.
Standard_EXPORT Standard_Integer NumberOfContours() const;
//! Returns the Number of Curves in the Contour number
//! Returns the Number of Curves in the Contour number
//! <IndexContour>.
Standard_EXPORT Standard_Integer NumberOfCurves(const Standard_Integer IndexContour) const;
//! Initialisation of an Iterator on the curves of
//! Initialisation of an Iterator on the curves of
//! the Contour number <IndexContour>.
Standard_EXPORT void Init(const Standard_Integer IndexContour);
@@ -83,7 +83,7 @@ public:
protected:
private:
//! Construction from a set of curves from Geom2d.
//! Assume the orientation of the closed lines are
//! Assume the orientation of the closed lines are
//! compatible. (ie if A is in B, the orientation of A and B
//! has to be different.
//!
@@ -98,7 +98,7 @@ private:
//! afirst point of a curve in a contour is equal to the last
//! point of the precedent curve.
//!
//! No control of this rules is done in the construction
//! No control of this rules is done in the construction
//! of the explorer
Standard_EXPORT void Add(const TopoDS_Wire& Spine,
const TopoDS_Face& aFace,
@@ -57,7 +57,7 @@ public:
//! raises if <S> is not an edge or a vertex.
Standard_EXPORT void Init(const TopoDS_Shape& S);
//! Returns True if there is a current BasicElt.
//! Returns True if there is a current BasicElt.
Standard_EXPORT Standard_Boolean More();
//! Proceed to the next BasicElt.
@@ -68,7 +68,7 @@ public:
//! segment L and the loaded face.
//!
//! PInf is the smallest parameter on the line
//! PSup is the highest parameter on the line
//! PSup is the highest parameter on the line
//!
//! For an infinite line PInf and PSup can be
//! +/- RealLast.
@@ -50,7 +50,7 @@ public:
//! segment L and the loaded shape.
//!
//! PInf is the smallest parameter on the line
//! PSup is the highest parameter on the line
//! PSup is the highest parameter on the line
//!
//! For an infinite line PInf and PSup can be
//! +/- RealLast.
@@ -60,7 +60,7 @@ public:
//! segment L and the loaded shape.
//!
//! PInf is the smallest parameter on the line
//! PSup is the highest parameter on the line
//! PSup is the highest parameter on the line
//!
//! For an infinite line PInf and PSup can be
//! +/- RealLast.
@@ -27,8 +27,8 @@ class MAT_Arc;
class MAT_BasicElt;
DEFINE_STANDARD_HANDLE(MAT_BasicElt, Standard_Transient)
//! A BasicELt is associated to each elementary
//! constituent of the figure.
//! A BasicELt is associated to each elementary
//! constituent of the figure.
class MAT_BasicElt : public Standard_Transient
{
@@ -75,22 +75,22 @@ public:
//! Return the number of infinites nodes of <me>.
Standard_EXPORT Standard_Integer NumberOfInfiniteNodes() const;
//! Merge two BasicElts. The End of the BasicElt Elt1
//! of IndexElt1 becomes The End of the BasicElt Elt2
//! of IndexElt2. Elt2 is replaced in the arcs by
//! Merge two BasicElts. The End of the BasicElt Elt1
//! of IndexElt1 becomes The End of the BasicElt Elt2
//! of IndexElt2. Elt2 is replaced in the arcs by
//! Elt1, Elt2 is eliminated.
//!
//! <MergeArc1> is True if the fusion of the BasicElts =>
//! a fusion of two Arcs which separated the same elements.
//! In this case <GeomIndexArc1> and <GeomIndexArc2> are the
//! Geometric Index of this arcs.
//! <MergeArc1> is True if the fusion of the BasicElts =>
//! a fusion of two Arcs which separated the same elements.
//! In this case <GeomIndexArc1> and <GeomIndexArc2> are the
//! Geometric Index of this arcs.
//!
//! If the BasicElt corresponds to a close line ,
//! If the BasicElt corresponds to a close line,
//! the StartArc and the EndArc of Elt1 can separate the same
//! elements .
//! elements.
//! In this case there is a fusion of this arcs, <MergeArc2>
//! is true and <GeomIndexArc3> and <GeomIndexArc4> are the
//! Geometric Index of this arcs.
//! is true and <GeomIndexArc3> and <GeomIndexArc4> are the
//! Geometric Index of this arcs.
Standard_EXPORT void FusionOfBasicElts(const Standard_Integer IndexElt1,
const Standard_Integer IndexElt2,
Standard_Boolean& MergeArc1,
@@ -112,8 +112,8 @@ public:
protected:
private:
//! Merge two Arcs. the second node of <Arc2> becomes
//! the first node of <Arc1>. Update of the first
//! Merge two Arcs. the second node of <Arc2> becomes
//! the first node of <Arc1>. Update of the first
//! node and the neighbours of <Arc1>.
//! <Arc2> is eliminated.
Standard_EXPORT void FusionOfArcs(const Handle(MAT_Arc)& Arc1, const Handle(MAT_Arc)& Arc2);
@@ -49,7 +49,7 @@ public:
//! Returns in <S> the Arcs linked to <me>.
Standard_EXPORT void LinkedArcs(MAT_SequenceOfArc& S) const;
//! Returns in <S> the BasicElts equidistant
//! Returns in <S> the BasicElts equidistant
//! to <me>.
Standard_EXPORT void NearElts(MAT_SequenceOfBasicElt& S) const;
@@ -50,8 +50,8 @@ public:
//! Return the number Of Arcs On the frontier of <me>.
Standard_EXPORT Standard_Integer NumberOfArcs() const;
//! Return the Arc number <Index> on the frontier.
//! of <me>.
//! Return the Arc number <Index> on the frontier.
//! of <me>.
Standard_EXPORT Handle(MAT_Arc) ArcOnFrontier(const Standard_Integer Index) const;
//! Return TRUE if <me> is not empty .
@@ -27,8 +27,8 @@
class MAT2d_Connexion;
DEFINE_STANDARD_HANDLE(MAT2d_Connexion, Standard_Transient)
//! A Connexion links two lines of items in a set
//! of lines. It s contains two points and their paramatric
//! A Connexion links two lines of items in a set
//! of lines. It contains two points and their paramatric
//! definitions on the lines.
//! The items can be points or curves.
class MAT2d_Connexion : public Standard_Transient
@@ -93,7 +93,7 @@ public:
Standard_EXPORT void Distance(const Standard_Real aDistance);
//! Returns the reverse connexion of <me>.
//! the firstpoint is the secondpoint.
//! the firstpoint is the secondpoint.
//! the secondpoint is the firstpoint.
Standard_EXPORT Handle(MAT2d_Connexion) Reverse() const;
@@ -28,13 +28,13 @@
#include <MAT2d_SequenceOfSequenceOfGeometry.hxx>
class MAT2d_Connexion;
//! MiniPath computes a path to link all the lines in
//! a set of lines. The path is described as a set of
//! MiniPath computes a path to link all the lines in
//! a set of lines. The path is described as a set of
//! connexions.
//!
//! The set of connexions can be seen as an arbitrary Tree.
//! The node of the tree are the lines. The arcs of the
//! tree are the connexions. The ancestror of a line is
//! The set of connexions can be seen as an arbitrary Tree.
//! The node of the tree are the lines. The arcs of the
//! tree are the connexions. The ancestror of a line is
//! the connexion which ends on it. The children of a line
//! are the connexions which start on it.
//!
@@ -48,10 +48,10 @@ public:
Standard_EXPORT MAT2d_MiniPath();
//! Computes the path to link the lines in <Figure>.
//! the path starts on the line of index <IndStart>
//! <Sense> = True if the Circuit turns in the
//! trigonometric sense.
//! Computes the path to link the lines in <Figure>.
//! the path starts on the line of index <IndStart>
//! <Sense> = True if the Circuit turns in the
//! trigonometric sense.
Standard_EXPORT void Perform(const MAT2d_SequenceOfSequenceOfGeometry& Figure,
const Standard_Integer IndStart,
const Standard_Boolean Sense);
@@ -70,24 +70,24 @@ public:
//! E->F, F->E, E->A.
Standard_EXPORT void RunOnConnexions();
//! Returns the sequence of connexions corresponding to
//! the path.
//! Returns the sequence of connexions corresponding to
//! the path.
Standard_EXPORT const MAT2d_SequenceOfConnexion& Path() const;
//! Returns <True> if there is one Connexion which starts
//! on line designed by <Index>.
Standard_EXPORT Standard_Boolean IsConnexionsFrom(const Standard_Integer Index) const;
//! Returns the connexions which start on line
//! designed by <Index>.
//! Returns the connexions which start on line
//! designed by <Index>.
Standard_EXPORT MAT2d_SequenceOfConnexion& ConnexionsFrom(const Standard_Integer Index);
//! Returns <True> if the line designed by <Index> is
//! the root.
Standard_EXPORT Standard_Boolean IsRoot(const Standard_Integer Index) const;
//! Returns the connexion which ends on line
//! designed by <Index>.
//! Returns the connexion which ends on line
//! designed by <Index>.
Standard_EXPORT Handle(MAT2d_Connexion) Father(const Standard_Integer Index);
protected:
@@ -62,7 +62,7 @@ public:
Standard_EXPORT Standard_Real ToleranceOfConfusion() const;
//! Creates the point at the origin of the bisector between
//! anitem and the previous item.
//! anitem and the previous item.
//! dist is the distance from the FirstPoint to <anitem>.
//! Returns the index of this point in <theGeomPnts>.
Standard_EXPORT Standard_Integer FirstPoint(const Standard_Integer anitem, Standard_Real& dist);
@@ -100,10 +100,10 @@ public:
Standard_EXPORT Standard_Boolean TrimBisector(const Handle(MAT_Bisector)& abisector,
const Standard_Integer apoint);
//! Computes the point of intersection between the
//! bisectors defined by <bisectorone> and
//! Computes the point of intersection between the
//! bisectors defined by <bisectorone> and
//! <bisectortwo> .
//! If this point exists, <intpnt> is its index
//! If this point exists, <intpnt> is its index
//! in <theGeomPnts> and Return the distance of the point
//! from the bisector else Return <RealLast>.
Standard_EXPORT Standard_Real IntersectBisector(const Handle(MAT_Bisector)& bisectorone,
@@ -130,7 +130,7 @@ public:
//! Returns the point of index <Index> in the <theGeomPnts>.
Standard_EXPORT const gp_Pnt2d& GeomPnt(const Standard_Integer Index) const;
//! Returns the vector of index <Index> in the
//! Returns the vector of index <Index> in the
//! <theGeomVecs>.
Standard_EXPORT const gp_Vec2d& GeomVec(const Standard_Integer Index) const;