Documentation - Fix whitespaces and typos (#819)

- 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
@@ -31,13 +31,13 @@ class TopoDS_Face;
class BRepOffset
{
public:
//! returns the Offset surface computed from the
//! returns the Offset surface computed from the
//! surface <Surface> at an OffsetDistance <Offset>.
//!
//! If possible, this method returns the real type of
//! If possible, this method returns the real type of
//! the surface ( e.g. An Offset of a plane is a plane).
//!
//! If no particular case is detected, the returned
//! If no particular case is detected, the returned
//! surface will have the Type Geom_OffsetSurface.
//! Parameter allowC0 is then passed as last argument to
//! constructor of Geom_OffsetSurface.
@@ -77,7 +77,7 @@ public: //! @name Results
const ChFiDS_TypeOfConcavity theType,
TopTools_ListOfShape& theL) const;
//! set in <Edges> all the Edges of <Shape> which are
//! set in <Edges> all the Edges of <Shape> which are
//! tangent to <Edge> at the vertex <Vertex>.
Standard_EXPORT void TangentEdges(const TopoDS_Edge& theEdge,
const TopoDS_Vertex& theVertex,
@@ -74,7 +74,7 @@ public:
//! Changes the flag allowing the linearization
Standard_EXPORT void AllowLinearization(const Standard_Boolean theIsAllowed);
//! Add Closing Faces, <F> has to be in the initial
//! Add Closing Faces, <F> has to be in the initial
//! shape S.
Standard_EXPORT void AddFace(const TopoDS_Face& F);
@@ -125,7 +125,7 @@ public:
Standard_EXPORT const TopoDS_Shape& GetBadShape() const;
public: //! @name History methods
//! Returns the list of shapes generated from the shape <S>.
//! Returns the list of shapes generated from the shape <S>.
Standard_EXPORT const TopTools_ListOfShape& Generated(const TopoDS_Shape& theS);
//! Returns the list of shapes modified from the shape <S>.
@@ -52,18 +52,18 @@ public:
const Standard_Boolean OffsetOutside = Standard_True,
const GeomAbs_JoinType JoinType = GeomAbs_Arc);
//! This method will be called when you want to share
//! the edges soon generated from an other face.
//! e.g. when two faces are tangents the common edge
//! This method will be called when you want to share
//! the edges soon generated from an other face.
//! e.g. when two faces are tangents the common edge
//! will generate only one edge ( no pipe).
//!
//! The Map will be fill as follow:
//! The Map will be fill as follow:
//!
//! Created(E) = E'
//! with: E = an edge of <Face>
//! E' = the image of E in the offsetting of
//! another face sharing E with a
//! continuity at least G1
//! with:
//! E = an edge of <Face>
//! E' = the image of E in the offsetting of another
//! face sharing E with a continuity at least G1
Standard_EXPORT BRepOffset_Offset(const TopoDS_Face& Face,
const Standard_Real Offset,
const TopTools_DataMapOfShapeShape& Created,
@@ -2045,7 +2045,7 @@ static void ExtentEdge(const TopoDS_Face& F,
Standard_Real f, l;
Handle(Geom2d_Curve) C2d = BRep_Tool::CurveOnSurface(E, F, f, l);
// calcul point cible . ie point d'intersection du prolongement tangent et des bords.
// calcul point cible. ie point d'intersection du prolongement tangent et des bords.
gp_Pnt2d P;
gp_Vec2d Tang;
C2d->D1(CE.FirstParameter(), P, Tang);
@@ -158,18 +158,18 @@ public:
//! the non-empty constructor or the Init function.
Standard_EXPORT const TopoDS_Shape& ProblematicShape() const;
//! Returns an error status when an error has occurred
//! (Face, Edge or Vertex recomputation problem).
//! Returns an error status when an error has occurred
//! (Face, Edge or Vertex recomputation problem).
//! Otherwise returns Draft_NoError. The method may be
//! called if AddDone returns Standard_False, or when
//! called if AddDone returns Standard_False, or when
//! IsDone returns Standard_False.
Standard_EXPORT Draft_ErrorStatus Status() const;
//! Returns all the faces which have been added
//! Returns all the faces which have been added
//! together with the face <F>.
Standard_EXPORT const TopTools_ListOfShape& ConnectedFaces(const TopoDS_Face& F) const;
//! Returns all the faces on which a modification has
//! Returns all the faces on which a modification has
//! been given.
Standard_EXPORT const TopTools_ListOfShape& ModifiedFaces() const;
@@ -179,12 +179,12 @@ public:
Standard_EXPORT void CorrectWires();
//! Returns the list of shapes generated from the
//! Returns the list of shapes generated from the
//! shape <S>.
Standard_EXPORT virtual const TopTools_ListOfShape& Generated(const TopoDS_Shape& S)
Standard_OVERRIDE;
//! Returns the list of shapes modified from the shape
//! Returns the list of shapes modified from the shape
//! <S>.
Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& S)
Standard_OVERRIDE;
@@ -144,7 +144,7 @@ public:
Standard_EXPORT Standard_Boolean IsModified(const TopoDS_Shape& shape) const;
//! Gives a modifieded shape
//! Raises NoSuchObject if shape has not been modified
//! Raises NoSuchObject if shape has not been modified
Standard_EXPORT const TopoDS_Shape& Modified(const TopoDS_Shape& shape) const;
//! Dump properties of resulting shape.
@@ -88,7 +88,7 @@ public:
//! draft along the wire.
Standard_EXPORT TopoDS_Shell Shell() const;
//! Returns the list of shapes generated from the
//! Returns the list of shapes generated from the
//! shape <S>.
Standard_EXPORT virtual const TopTools_ListOfShape& Generated(const TopoDS_Shape& S)
Standard_OVERRIDE;
@@ -45,8 +45,8 @@ class TopoDS_Shape;
//! (which lies in infinite number of planes).
//!
//! The profile is defined in a Referential R. The position of
//! the profile at the current point of the spine is given by
//! confusing R and the local referential given by ( D0, D1
//! the profile at the current point of the spine is given by
//! confusing R and the local referential given by (D0, D1
//! and the normal of the Spine).
//!
//! The coordinate system is determined by theIsAxeProf argument:
@@ -102,8 +102,8 @@ public:
Standard_EXPORT virtual void Build(
const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;
//! Returns the shapes created from a subshape
//! <SpineShape> of the spine and a subshape
//! Returns the shapes created from a subshape
//! <SpineShape> of the spine and a subshape
//! <ProfShape> on the profile.
Standard_EXPORT const TopTools_ListOfShape& GeneratedShapes(const TopoDS_Shape& SpineShape,
const TopoDS_Shape& ProfShape) const;
@@ -111,7 +111,7 @@ public:
//! Return the face Top if <Solid> is True in the constructor.
Standard_EXPORT const TopoDS_Shape& Top() const;
//! Return the face Bottom if <Solid> is True in the constructor.
//! Return the face Bottom if <Solid> is True in the constructor.
Standard_EXPORT const TopoDS_Shape& Bottom() const;
protected:
@@ -71,7 +71,7 @@ public:
Standard_EXPORT virtual void Build(
const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;
//! Returns the TopoDS Shape of the bottom of the prism.
//! Returns the TopoDS Shape of the bottom of the prism.
Standard_EXPORT TopoDS_Shape FirstShape() Standard_OVERRIDE;
//! Returns the TopoDS Shape of the top of the prism.
@@ -172,7 +172,7 @@ public:
//! shape, i.e. has a definition for the wire section Profile.
Standard_EXPORT Standard_Boolean IsReady() const;
//! Get a status, when Simulate or Build failed. It can be
//! Get a status, when Simulate or Build failed. It can be
//! BRepBuilderAPI_PipeDone,
//! BRepBuilderAPI_PipeNotDone,
//! BRepBuilderAPI_PlaneNotIntersectGuide,
@@ -247,7 +247,7 @@ public:
//! they are returned in the list Result.
//! This gives a rapid preview of the resulting shape,
//! which will be obtained using the settings you have provided.
//! Raises NotDone if <me> it is not Ready
//! Raises NotDone if <me> it is not Ready
Standard_EXPORT void Simulate(const Standard_Integer NumberOfSection,
TopTools_ListOfShape& Result);
@@ -259,7 +259,7 @@ public:
//! If a propfile is not closed returns False
Standard_EXPORT Standard_Boolean MakeSolid();
//! Returns the TopoDS Shape of the bottom of the sweep.
//! Returns the TopoDS Shape of the bottom of the sweep.
Standard_EXPORT virtual TopoDS_Shape FirstShape() Standard_OVERRIDE;
//! Returns the TopoDS Shape of the top of the sweep.
@@ -52,7 +52,7 @@ public:
//! <S>: Shape to be rounded
//! <Radius>: radius of the fillet
//! <Tol>: Tol3d used in approximations
//! <NUBS>: if true, generate only NUBS surfaces,
//! <NUBS>: if true, generate only NUBS surfaces,
//! if false, generate analytical surfaces if possible
Standard_EXPORT BiTgte_Blend(const TopoDS_Shape& S,
const Standard_Real Radius,
@@ -67,7 +67,7 @@ public:
//! Clear all the Fields.
Standard_EXPORT void Clear();
//! Set two faces of <myShape> on which the Sphere
//! Set two faces of <myShape> on which the Sphere
//! must roll.
Standard_EXPORT void SetFaces(const TopoDS_Face& F1, const TopoDS_Face& F2);
@@ -99,7 +99,7 @@ public:
//! set in <LC> all the center lines
Standard_EXPORT void CenterLines(TopTools_ListOfShape& LC) const;
//! returns the surface generated by the centerline.
//! returns the surface generated by the centerline.
//! <CenterLine> may be
//! - an edge : generate a pipe.
//! - a vertex : generate a sphere.
@@ -107,7 +107,7 @@ public:
//! no surface.
Standard_EXPORT Handle(Geom_Surface) Surface(const TopoDS_Shape& CenterLine) const;
//! returns the face generated by the centerline.
//! returns the face generated by the centerline.
//! <CenterLine> may be
//! - an edge : generate a pipe.
//! - a vertex : generate a sphere.
@@ -143,8 +143,8 @@ public:
//! on the Fillet
Standard_EXPORT Handle(Geom2d_Curve) PCurve1OnFillet(const Standard_Integer Index) const;
//! gives the PCurve associated to CurveOnShape2(Index)
//! on the support face
//! gives the PCurve associated to CurveOnShape2(Index)
//! on the support face
//! Warning: returns a Null Handle if SupportShape2 is not a Face
Standard_EXPORT Handle(Geom2d_Curve) PCurveOnFace2(const Standard_Integer Index) const;
@@ -154,7 +154,7 @@ public:
Standard_EXPORT Standard_Integer NbBranches();
//! Set in <From>,<To> the indices of the faces of
//! Set in <From>,<To> the indices of the faces of
//! the branche <Index>.
//!
//! i.e: Branche<Index> = Face(From) + Face(From+1) + ..+ Face(To)
@@ -175,7 +175,7 @@ private:
Standard_EXPORT void ComputeShape();
//! Computes the intersections with <Face> and all the
//! OffsetFaces stored in <myMapSF>. Returns <True>
//! OffsetFaces stored in <myMapSF>. Returns <True>
//! if an intersections ends on a boundary of a Face.
Standard_EXPORT Standard_Boolean Intersect(const TopoDS_Shape& Init,
const TopoDS_Face& Face,
@@ -40,7 +40,7 @@ class Geom_BSplineCurve;
DEFINE_STANDARD_HANDLE(BiTgte_CurveOnEdge, Adaptor3d_Curve)
//! private class used to create a filler rolling on
//! private class used to create a filler rolling on
//! an edge.
class BiTgte_CurveOnEdge : public Adaptor3d_Curve
{
@@ -61,20 +61,20 @@ public:
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
//! Returns the number of intervals for continuity
//! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
//! 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()
Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
//! Returns a curve equivalent of <me> between
//! parameters <First> and <Last>. <Tol> is used to
//! Returns a curve equivalent of <me> between
//! parameters <First> and <Last>. <Tol> is used to
//! test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor3d_Curve) Trim(const Standard_Real First,
@@ -126,12 +126,12 @@ public:
Standard_EXPORT gp_Vec 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 <R3d>.
Standard_EXPORT Standard_Real Resolution(const Standard_Real R3d) const Standard_OVERRIDE;
//! 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.
Standard_EXPORT GeomAbs_CurveType GetType() const Standard_OVERRIDE;
@@ -40,7 +40,7 @@ class Geom_BSplineCurve;
DEFINE_STANDARD_HANDLE(BiTgte_CurveOnVertex, Adaptor3d_Curve)
//! private class used to create a filler rolling on
//! private class used to create a filler rolling on
//! an edge.
class BiTgte_CurveOnVertex : public Adaptor3d_Curve
{
@@ -58,20 +58,20 @@ public:
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
//! Returns the number of intervals for continuity
//! Returns the number of intervals for continuity
//! <S>. May be one if Continuity(me) >= <S>
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
//! 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()
Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
const GeomAbs_Shape S) const Standard_OVERRIDE;
//! Returns a curve equivalent of <me> between
//! parameters <First> and <Last>. <Tol> is used to
//! Returns a curve equivalent of <me> between
//! parameters <First> and <Last>. <Tol> is used to
//! test for 3d points confusion.
//! If <First> >= <Last>
Standard_EXPORT Handle(Adaptor3d_Curve) Trim(const Standard_Real First,
@@ -123,12 +123,12 @@ public:
Standard_EXPORT gp_Vec 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 <R3d>.
Standard_EXPORT Standard_Real Resolution(const Standard_Real R3d) const Standard_OVERRIDE;
//! 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.
Standard_EXPORT GeomAbs_CurveType GetType() const Standard_OVERRIDE;
@@ -30,9 +30,9 @@ class Draft
public:
DEFINE_STANDARD_ALLOC
//! Returns the draft angle of the face <F> using the
//! direction <Direction>. The method is valid for :
//! - Plane faces,
//! Returns the draft angle of the face <F> using the
//! direction <Direction>. The method is valid for :
//! - Plane faces,
//! - Cylindrical or conical faces, when the direction
//! of the axis of the surface is colinear with the
//! direction.
@@ -56,10 +56,10 @@ public:
//! Changes the basis shape and resets.
Standard_EXPORT void Init(const TopoDS_Shape& S);
//! Adds the face F and propagates the draft
//! modification to its neighbour faces if they are
//! Adds the face F and propagates the draft
//! modification to its neighbour faces if they are
//! tangent. If an error occurs, will return False and
//! ProblematicShape will return the "bad" face.
//! ProblematicShape will return the "bad" face.
Standard_EXPORT Standard_Boolean Add(const TopoDS_Face& F,
const gp_Dir& Direction,
const Standard_Real Angle,
@@ -67,51 +67,51 @@ public:
const Standard_Boolean Flag = Standard_True);
//! Removes the face F and the neighbour faces if they
//! are tangent. It will be necessary to call this
//! method if the method Add returns Standard_False,
//! are tangent. It will be necessary to call this
//! method if the method Add returns Standard_False,
//! to unset ProblematicFace.
Standard_EXPORT void Remove(const TopoDS_Face& F);
//! Performs the draft angle modification and sets the
//! value returned by the method IsDone. If an error
//! occurs, IsDone will return Standard_False, and an
//! error status will be given by the method Error,
//! and the shape on which the problem appeared will
//! value returned by the method IsDone. If an error
//! occurs, IsDone will return Standard_False, and an
//! error status will be given by the method Error,
//! and the shape on which the problem appeared will
//! be given by ProblematicShape
Standard_EXPORT void Perform();
//! Returns True if Perform has been successfully
//! Returns True if Perform has been successfully
//! called. Otherwise more information can be obtained
//! using the methods Error() and ProblematicShape().
Standard_EXPORT Standard_Boolean IsDone() const;
Standard_EXPORT Draft_ErrorStatus Error() const;
//! Returns the shape (Face, Edge or Vertex) on which
//! Returns the shape (Face, Edge or Vertex) on which
//! an error occurred.
Standard_EXPORT const TopoDS_Shape& ProblematicShape() const;
//! Returns all the faces which have been added
//! Returns all the faces which have been added
//! together with the face <F>.
Standard_EXPORT const TopTools_ListOfShape& ConnectedFaces(const TopoDS_Face& F);
//! Returns all the faces on which a modification has
//! Returns all the faces on which a modification has
//! been given.
Standard_EXPORT const TopTools_ListOfShape& ModifiedFaces();
//! Returns Standard_True if the face <F> has been
//! modified. In this case, <S> is the new geometric
//! support of the face, <L> the new location,<Tol>
//! the new tolerance.<RevWires> has to be set to
//! Standard_True when the modification reverses the
//! 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. Here
//! Returns Standard_True if the face <F> has been
//! modified. In this case, <S> is the new geometric
//! support of the face, <L> the new location, <Tol>
//! the new tolerance.<RevWires> has to be set to
//! Standard_True when the modification reverses the
//! 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. Here
//! it will be set to Standard_False.
//!
//! Otherwise, returns Standard_False, and <S>, <L>,
//! <Tol> , <RevWires> ,<RevFace> are not significant.
//! Otherwise, returns Standard_False, and <S>, <L>,
//! <Tol> , <RevWires> ,<RevFace> are not significant.
Standard_EXPORT Standard_Boolean NewSurface(const TopoDS_Face& F,
Handle(Geom_Surface)& S,
TopLoc_Location& L,
@@ -119,35 +119,35 @@ public:
Standard_Boolean& RevWires,
Standard_Boolean& RevFace) Standard_OVERRIDE;
//! Returns Standard_True if the edge <E> has been
//! modified. In this case, <C> is the new geometric
//! support of the edge, <L> the new location, <Tol>
//! the new tolerance. Otherwise, returns
//! Standard_False, and <C>, <L>, <Tol> are not
//! Returns Standard_True if the edge <E> has been
//! modified. In this case, <C> is the new geometric
//! support of the edge, <L> the new location, <Tol>
//! the new tolerance. Otherwise, returns
//! Standard_False, and <C>, <L>, <Tol> are not
//! significant.
Standard_EXPORT Standard_Boolean NewCurve(const TopoDS_Edge& E,
Handle(Geom_Curve)& C,
TopLoc_Location& L,
Standard_Real& Tol) Standard_OVERRIDE;
//! Returns Standard_True if the vertex <V> has been
//! modified. In this case, <P> is the new geometric
//! support of the vertex, <Tol> the new tolerance.
//! Otherwise, returns Standard_False, and <P>, <Tol>
//! Returns Standard_True if the vertex <V> has been
//! modified. In this case, <P> is the new geometric
//! support of the vertex, <Tol> the new tolerance.
//! Otherwise, returns Standard_False, and <P>, <Tol>
//! are not significant.
Standard_EXPORT Standard_Boolean NewPoint(const TopoDS_Vertex& V,
gp_Pnt& P,
Standard_Real& Tol) Standard_OVERRIDE;
//! Returns Standard_True if the edge <E> has a new
//! Returns Standard_True if the edge <E> has a new
//! curve on surface on the face <F>.In this case, <C>
//! is the new geometric support of the edge, <L> the
//! is the new geometric support of the edge, <L> the
//! new location, <Tol> the new tolerance.
//!
//! Otherwise, returns Standard_False, and <C>, <L>,
//! Otherwise, returns Standard_False, and <C>, <L>,
//! <Tol> are not significant.
//!
//! <NewE> is the new edge created from <E>. <NewF>
//! <NewE> is the new edge created from <E>. <NewF>
//! is the new face created from <F>. They may be useful.
Standard_EXPORT Standard_Boolean NewCurve2d(const TopoDS_Edge& E,
const TopoDS_Face& F,
@@ -156,21 +156,21 @@ public:
Handle(Geom2d_Curve)& C,
Standard_Real& Tol) Standard_OVERRIDE;
//! Returns Standard_True if the Vertex <V> has a new
//! parameter on the edge <E>. In this case, <P> is
//! the parameter, <Tol> the new tolerance.
//! Otherwise, returns Standard_False, and <P>, <Tol>
//! Returns Standard_True if the Vertex <V> has a new
//! parameter on the edge <E>. In this case, <P> is
//! the parameter, <Tol> the new tolerance.
//! Otherwise, returns Standard_False, and <P>, <Tol>
//! are not significant.
Standard_EXPORT Standard_Boolean NewParameter(const TopoDS_Vertex& V,
const TopoDS_Edge& E,
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,