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

View File

@@ -52,7 +52,7 @@ class Geom_Surface;
//! References :
//! . Generating the Bezier Points of B-spline curves and surfaces
//! (Wolfgang Bohm) CAGD volume 13 number 6 november 1981
//! . On NURBS: A Survey (Leslie Piegl) IEEE Computer Graphics and
//! . On NURBS: A Survey (Leslie Piegl) IEEE Computer Graphics and
//! Application January 1991
//! . Curve and surface construction using rational B-splines
//! (Leslie Piegl and Wayne Tiller) CAD Volume 19 number 9 november
@@ -67,12 +67,12 @@ public:
//! Convert a curve from Geom by an approximation method
//!
//! This method computes the arc of B-spline curve between the two
//! knots FromK1 and ToK2. If C is periodic the arc has the same
//! knots FromK1 and ToK2. If C is periodic the arc has the same
//! orientation as C if SameOrientation = Standard_True.
//! If C is not periodic SameOrientation is not used for the
//! If C is not periodic SameOrientation is not used for the
//! computation and C is oriented from the knot fromK1 to the knot toK2.
//! We just keep the local definition of C between the knots
//! FromK1 and ToK2. The returned B-spline curve has its first
//! FromK1 and ToK2. The returned B-spline curve has its first
//! and last knots with a multiplicity equal to degree + 1, where
//! degree is the polynomial degree of C.
//! The indexes of the knots FromK1 and ToK2 doesn't include the
@@ -94,7 +94,7 @@ public:
//! computation and C is oriented fromU1 toU2.
//! If U1 and U2 and two parametric values we consider that
//! U1 = U2 if Abs (U1 - U2) <= ParametricTolerance and
//! ParametricTolerance must be greater or equal to Resolution
//! ParametricTolerance must be greater or equal to Resolution
//! from package gp.
//!
//! Raised if FromU1 or ToU2 are out of the parametric bounds of the
@@ -204,19 +204,19 @@ public:
const Standard_Boolean SameOrientation = Standard_True);
//! This function converts a non infinite curve from
//! Geom into a B-spline curve. C must be an ellipse or a
//! circle or a trimmed conic or a trimmed line or a Bezier
//! curve or a trimmed Bezier curve or a BSpline curve or a
//! trimmed BSpline curve or an OffsetCurve. The returned B-spline is
//! not periodic except if C is a Circle or an Ellipse. If
//! the Parameterisation is QuasiAngular than the returned
//! curve is NOT periodic in case a periodic Geom_Circle or
//! Geom_Ellipse. For TgtThetaOver2_1 and TgtThetaOver2_2 the
//! method raises an exception in case of a periodic
//! Geom into a B-spline curve. C must be an ellipse or a
//! circle or a trimmed conic or a trimmed line or a Bezier
//! curve or a trimmed Bezier curve or a BSpline curve or a
//! trimmed BSpline curve or an OffsetCurve. The returned B-spline is
//! not periodic except if C is a Circle or an Ellipse. If
//! the Parameterisation is QuasiAngular than the returned
//! curve is NOT periodic in case a periodic Geom_Circle or
//! Geom_Ellipse. For TgtThetaOver2_1 and TgtThetaOver2_2 the
//! method raises an exception in case of a periodic
//! Geom_Circle or a Geom_Ellipse ParameterisationType applies
//! only if the curve is a Circle or an ellipse :
//! TgtThetaOver2, -- TgtThetaOver2_1, -- TgtThetaOver2_2, --
//! TgtThetaOver2_3, -- TgtThetaOver2_4,
//! only if the curve is a Circle or an ellipse:
//! TgtThetaOver2, TgtThetaOver2_1, TgtThetaOver2_2,
//! TgtThetaOver2_3, TgtThetaOver2_4,
//!
//! Purpose: this is the classical rational parameterisation
//! 2
@@ -232,9 +232,9 @@ public:
//!
//! t = tan (theta/2)
//!
//! with TgtThetaOver2 the routine will compute the number of spans
//! with TgtThetaOver2 the routine will compute the number of spans
//! using the rule num_spans = [ (ULast - UFirst) / 1.2 ] + 1
//! with TgtThetaOver2_N, N spans will be forced: an error will
//! with TgtThetaOver2_N, N spans will be forced: an error will
//! be raized if (ULast - UFirst) >= PI and N = 1,
//! ULast - UFirst >= 2 PI and N = 2
//!
@@ -289,7 +289,7 @@ public:
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0
@@ -304,10 +304,10 @@ public:
//! This Method concatenates C1 the ArrayOfCurves as far
//! as it is possible.
//! ArrayOfCurves[0..N-1]
//! ArrayOfToler contains the biggest tolerance of the two
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0
@@ -323,10 +323,10 @@ public:
//! This Method concatenates C1 the ArrayOfCurves as far
//! as it is possible.
//! ArrayOfCurves[0..N-1]
//! ArrayOfToler contains the biggest tolerance of the two
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! ClosedFlag indicates if the ArrayOfCurves is closed.
//! In this case ClosedTolerance contains the biggest tolerance
//! of the two points which are at the closure.
//! Otherwise its value is 0.0

View File

@@ -62,21 +62,21 @@ public:
//! Returns the BSpline curve resulting from the approximation algorithm.
Standard_EXPORT Handle(Geom_BSplineCurve) Curve() const;
//! returns Standard_True if the approximation has
//! been done within required tolerance
//! returns Standard_True if the approximation has
//! been done within required tolerance
Standard_EXPORT Standard_Boolean IsDone() const;
//! Returns Standard_True if the approximation did come out
//! with a result that is not NECESSARELY within the required tolerance
//! Returns Standard_True if the approximation did come out
//! with a result that is not NECESSARELY within the required tolerance
Standard_EXPORT Standard_Boolean HasResult() const;
//! Returns the greatest distance between a point on the
//! source conic and the BSpline curve resulting from the
//! approximation. (>0 when an approximation
//! has been done, 0 if no approximation)
//! has been done, 0 if no approximation)
Standard_EXPORT Standard_Real MaxError() const;
//! Print on the stream o information about the object
//! Print on the stream o information about the object
Standard_EXPORT void Dump(Standard_OStream& o) const;
protected:

View File

@@ -89,8 +89,8 @@ public:
//! This methode returns the bspline's knots associated to
//! the converted arcs
//! Raised if the length of Curves is not equal to
//! NbArcs + 1.
//! Raised if the length of Curves is not equal to
//! NbArcs + 1
Standard_EXPORT void Knots(TColStd_Array1OfReal& TKnots) const;
//! Returns the number of BezierCurve arcs.

View File

@@ -33,9 +33,9 @@ class Geom_BSplineSurface;
//! SplitBSplineSurface.
//! For a B-spline surface the discontinuities are localised at
//! the knot values. Between two knots values the B-spline is
//! infinitely continuously differentiable. For each parametric
//! infinitely continuously differentiable. For each parametric
//! direction at a knot of range index the continuity in this
//! direction is equal to : Degree - Mult (Index) where Degree
//! direction is equal to: Degree - Mult (Index) where Degree
//! is the degree of the basis B-spline functions and Mult the
//! multiplicity of the knot of range Index in the given direction.
//! If for your computation you need to have B-spline surface with a
@@ -125,7 +125,7 @@ public:
TColStd_Array1OfInteger& VSplit) const;
//! Returns the split knot of index UIndex
//! to the split knots table for the u parametric direction
//! to the split knots table for the u parametric direction
//! computed in this framework. The returned value is
//! an index in the knots table relative to the u
//! parametric direction of the BSpline surface analysed by this algorithm.
@@ -134,12 +134,12 @@ public:
//! this framework, the corresponding knot gives the
//! parameter of one of the bounding curves of the surface.
//! Exceptions
//! Standard_RangeError if UIndex is less than 1 or greater than the number
//! Standard_RangeError if UIndex is less than 1 or greater than the number
//! of split knots for the u parametric direction computed in this framework.
Standard_EXPORT Standard_Integer USplitValue(const Standard_Integer UIndex) const;
//! Returns the split knot of index VIndex
//! to the split knots table for the v parametric direction
//! to the split knots table for the v parametric direction
//! computed in this framework. The returned value is
//! an index in the knots table relative to the v
//! parametric direction of the BSpline surface analysed by this algorithm.
@@ -148,7 +148,7 @@ public:
//! this framework, the corresponding knot gives the
//! parameter of one of the bounding curves of the surface.
//! Exceptions
//! Standard_RangeError if VIndex is less than 1 or greater than the number
//! Standard_RangeError if VIndex is less than 1 or greater than the number
//! of split knots for the v parametric direction computed in this framework.
Standard_EXPORT Standard_Integer VSplitValue(const Standard_Integer VIndex) const;

View File

@@ -75,7 +75,7 @@ public:
//! Use the available interrogation functions to ascertain
//! the number of computed Bezier patches, and then to
//! construct each individual Bezier surface (or all Bezier surfaces).
//! Note: ParametricTolerance is not used. Raises DomainError
//! Note: ParametricTolerance is not used. Raises DomainError
//! if U1 or U2 or V1 or V2 are out of the parametric bounds
//! of the basis surface [FirstUKnotIndex, LastUKnotIndex] ,
//! [FirstVKnotIndex, LastVKnotIndex] The tolerance criterion is
@@ -143,14 +143,14 @@ public:
//! This methode returns the bspline's u-knots associated to
//! the converted Patches
//! Raised if the length of Curves is not equal to
//! NbUPatches + 1.
//! Raised if the length of Curves is not equal to
//! NbUPatches + 1
Standard_EXPORT void UKnots(TColStd_Array1OfReal& TKnots) const;
//! This methode returns the bspline's v-knots associated to
//! the converted Patches
//! Raised if the length of Curves is not equal to
//! NbVPatches + 1.
//! Raised if the length of Curves is not equal to
//! NbVPatches + 1
Standard_EXPORT void VKnots(TColStd_Array1OfReal& TKnots) const;
//! Returns the number of Bezier surfaces in the U direction.

View File

@@ -49,7 +49,7 @@
//! -----------------------
//! 3 | | | | |
//! -----------------------
//! UIndex [1, NbUPatches] Udirection
//! UIndex [1, NbUPatches] Udirection
//!
//! Warning! Patches must have compatible parametrization
class GeomConvert_CompBezierSurfacesToBSplineSurface
@@ -117,7 +117,7 @@ public:
//! Build an Ci uniform (Rational) BSpline surface
//! The highest Continuity Ci is imposed, like the
//! maximal deformation is lower than <Tolerance>.
//! Warning: The Continuity C0 is imposed without any check.
//! Warning: The Continuity C0 is imposed without any check.
Standard_EXPORT GeomConvert_CompBezierSurfacesToBSplineSurface(
const TColGeom_Array2OfBezierSurface& Beziers,
const Standard_Real Tolerance,
@@ -241,7 +241,7 @@ public:
//! direction of the BSpline surface whose data is computed in this framework.
const Handle(TColStd_HArray1OfReal)& UKnots() const;
//! Returns the degree for the u parametric
//! Returns the degree for the u parametric
//! direction of the BSpline surface whose data is computed in this framework.
Standard_Integer UDegree() const;
@@ -249,7 +249,7 @@ public:
//! direction of the BSpline surface whose data is computed in this framework.
const Handle(TColStd_HArray1OfReal)& VKnots() const;
//! Returns the degree for the v parametric
//! Returns the degree for the v parametric
//! direction of the BSpline surface whose data is computed in this framework.
Standard_Integer VDegree() const;