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

[occt.git] / src / GeomLProp / GeomLProp_SLProps.hxx

diff --git a/src/GeomLProp/GeomLProp_SLProps.hxx b/src/GeomLProp/GeomLProp_SLProps.hxx
index cc0ca81..3817b1d 100644 (file)
--- a/src/GeomLProp/GeomLProp_SLProps.hxx
+++ b/src/GeomLProp/GeomLProp_SLProps.hxx
@@ -47,52 +47,101 @@ public:
   DEFINE_STANDARD_ALLOC
 
   
+  //! Initializes the local properties of the surface <S>
+  //! for the parameter values (<U>, <V>).
+  //! The current point and the derivatives are
+  //! computed at the same time, which allows an
+  //! optimization of the computation time.
+  //! <N> indicates the maximum number of derivations to
+  //! be done (0, 1, or 2). For example, to compute
+  //! only the tangent, N should be equal to 1.
+  //! <Resolution> is the linear tolerance (it is used to test
+  //! if a vector is null).
   Standard_EXPORT GeomLProp_SLProps(const Handle(Geom_Surface)& S, const Standard_Real U, const Standard_Real V, const Standard_Integer N, const Standard_Real Resolution);
   
+  //! idem as previous constructor but without setting the value
+  //! of parameters <U> and <V>.
   Standard_EXPORT GeomLProp_SLProps(const Handle(Geom_Surface)& S, const Standard_Integer N, const Standard_Real Resolution);
   
+  //! idem as previous constructor but without setting the value
+  //! of parameters <U> and <V> and the surface.
+  //! the surface can have an empty constructor.
   Standard_EXPORT GeomLProp_SLProps(const Standard_Integer N, const Standard_Real Resolution);
   
+  //! Initializes the local properties of the surface S
+  //! for the new surface.
   Standard_EXPORT void SetSurface (const Handle(Geom_Surface)& S);
   
+  //! Initializes the local properties of the surface S
+  //! for the new parameter values (<U>, <V>).
   Standard_EXPORT void SetParameters (const Standard_Real U, const Standard_Real V);
   
+  //! Returns the point.
   Standard_EXPORT const gp_Pnt& Value() const;
   
+  //! Returns the first U derivative.
+  //! The derivative is computed if it has not been yet.
   Standard_EXPORT const gp_Vec& D1U();
   
+  //! Returns the first V derivative.
+  //! The derivative is computed if it has not been yet.
   Standard_EXPORT const gp_Vec& D1V();
   
+  //! Returns the second U derivatives
+  //! The derivative is computed if it has not been yet.
   Standard_EXPORT const gp_Vec& D2U();
   
+  //! Returns the second V derivative.
+  //! The derivative is computed if it has not been yet.
   Standard_EXPORT const gp_Vec& D2V();
   
+  //! Returns the second UV cross-derivative.
+  //! The derivative is computed if it has not been yet.
   Standard_EXPORT const gp_Vec& DUV();
   
+  //! returns True if the U tangent is defined.
+  //! For example, the tangent is not defined if the
+  //! two first U derivatives are null.
   Standard_EXPORT Standard_Boolean IsTangentUDefined();
   
+  //! Returns the tangent direction <D> on the iso-V.
   Standard_EXPORT void TangentU (gp_Dir& D);
   
+  //! returns if the V tangent is defined.
+  //! For example, the tangent is not defined if the
+  //! two first V derivatives are null.
   Standard_EXPORT Standard_Boolean IsTangentVDefined();
   
+  //! Returns the tangent direction <D> on the iso-V.
   Standard_EXPORT void TangentV (gp_Dir& D);
   
+  //! Tells if the normal is defined.
   Standard_EXPORT Standard_Boolean IsNormalDefined();
   
+  //! Returns the normal direction.
   Standard_EXPORT const gp_Dir& Normal();
   
+  //! returns True if the curvature is defined.
   Standard_EXPORT Standard_Boolean IsCurvatureDefined();
   
+  //! returns True if the point is umbilic (i.e. if the
+  //! curvature is constant).
   Standard_EXPORT Standard_Boolean IsUmbilic();
   
+  //! Returns the maximum curvature
   Standard_EXPORT Standard_Real MaxCurvature();
   
+  //! Returns the minimum curvature
   Standard_EXPORT Standard_Real MinCurvature();
   
+  //! Returns the direction of the maximum and minimum curvature
+  //! <MaxD> and <MinD>
   Standard_EXPORT void CurvatureDirections (gp_Dir& MaxD, gp_Dir& MinD);
   
+  //! Returns the mean curvature.
   Standard_EXPORT Standard_Real MeanCurvature();
   
+  //! Returns the Gaussian curvature
   Standard_EXPORT Standard_Real GaussianCurvature();