0026595: Lost some comments in OCCT-code after cdl elimination

[occt.git] / src / IntCurveSurface / IntCurveSurface_TheHCurveTool.hxx

diff --git a/src/IntCurveSurface/IntCurveSurface_TheHCurveTool.hxx b/src/IntCurveSurface/IntCurveSurface_TheHCurveTool.hxx
index cc773c4..ed954b5 100644 (file)
--- a/src/IntCurveSurface/IntCurveSurface_TheHCurveTool.hxx
+++ b/src/IntCurveSurface/IntCurveSurface_TheHCurveTool.hxx
@@ -59,8 +59,15 @@ public:
   
     static GeomAbs_Shape Continuity (const Handle(Adaptor3d_HCurve)& C);
   
+  //! Returns  the number  of  intervals for  continuity
+  //! <S>. May be one if Continuity(myclass) >= <S>
     static Standard_Integer NbIntervals (const Handle(Adaptor3d_HCurve)& C, const GeomAbs_Shape S);
   
+  //! Stores in <T> the  parameters bounding the intervals
+  //! of continuity <S>.
+  //!
+  //! The array must provide  enough room to  accomodate
+  //! for the parameters. i.e. T.Length() > NbIntervals()
     static void Intervals (const Handle(Adaptor3d_HCurve)& C, TColStd_Array1OfReal& T, const GeomAbs_Shape S);
   
     static Standard_Boolean IsClosed (const Handle(Adaptor3d_HCurve)& C);
@@ -69,20 +76,47 @@ public:
   
     static Standard_Real Period (const Handle(Adaptor3d_HCurve)& C);
   
+  //! Computes the point of parameter U on the curve.
     static gp_Pnt Value (const Handle(Adaptor3d_HCurve)& C, const Standard_Real U);
   
+  //! Computes the point of parameter U on the curve.
     static void D0 (const Handle(Adaptor3d_HCurve)& C, const Standard_Real U, gp_Pnt& P);
   
+  //! Computes the point of parameter U on the curve with its
+  //! first derivative.
+  //! Raised if the continuity of the current interval
+  //! is not C1.
     static void D1 (const Handle(Adaptor3d_HCurve)& C, const Standard_Real U, gp_Pnt& P, gp_Vec& V);
   
+
+  //! Returns the point P of parameter U, the first and second
+  //! derivatives V1 and V2.
+  //! Raised if the continuity of the current interval
+  //! is not C2.
     static void D2 (const Handle(Adaptor3d_HCurve)& C, const Standard_Real U, gp_Pnt& P, gp_Vec& V1, gp_Vec& V2);
   
+
+  //! Returns the point P of parameter U, the first, the second
+  //! and the third derivative.
+  //! Raised if the continuity of the current interval
+  //! is not C3.
     static void D3 (const Handle(Adaptor3d_HCurve)& C, const Standard_Real U, gp_Pnt& P, gp_Vec& V1, gp_Vec& V2, gp_Vec& V3);
   
+
+  //! The returned vector gives the value of the derivative for the
+  //! order of derivation N.
+  //! Raised if the continuity of the current interval
+  //! is not CN.
+  //! Raised if N < 1.
     static gp_Vec DN (const Handle(Adaptor3d_HCurve)& C, const Standard_Real U, const Standard_Integer N);
   
+  //! Returns the parametric  resolution corresponding
+  //! to the real space resolution <R3d>.
     static Standard_Real Resolution (const Handle(Adaptor3d_HCurve)& C, const Standard_Real R3d);
   
+  //! Returns  the  type of the   curve  in the  current
+  //! interval :   Line,   Circle,   Ellipse, Hyperbola,
+  //! Parabola, BezierCurve, BSplineCurve, OtherCurve.
     static GeomAbs_CurveType GetType (const Handle(Adaptor3d_HCurve)& C);
   
     static gp_Lin Line (const Handle(Adaptor3d_HCurve)& C);