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

[occt.git] / src / Extrema / Extrema_ECC.hxx

diff --git a/src/Extrema/Extrema_ECC.hxx b/src/Extrema/Extrema_ECC.hxx
index c3f1b52..0147465 100644 (file)
--- a/src/Extrema/Extrema_ECC.hxx
+++ b/src/Extrema/Extrema_ECC.hxx
@@ -46,12 +46,23 @@ public:
   DEFINE_STANDARD_ALLOC
 
   
+  //! Calculates all the distances as above
+  //! between Uinf and Usup for C1 and  between Vinf and Vsup
+  //! for C2.
   Standard_EXPORT Extrema_ECC();
   
+  //! It calculates all the distances.
+  //! The function F(u,v)=distance(C1(u),C2(v)) has an
+  //! extremum when gradient(f)=0. The algorithm uses
+  //! Evtushenko's global optimization solver.
   Standard_EXPORT Extrema_ECC(const Adaptor3d_Curve& C1, const Adaptor3d_Curve& C2);
   
+  //! Calculates all the distances as above
+  //! between Uinf and Usup for C1 and  between Vinf and Vsup
+  //! for C2.
   Standard_EXPORT Extrema_ECC(const Adaptor3d_Curve& C1, const Adaptor3d_Curve& C2, const Standard_Real Uinf, const Standard_Real Usup, const Standard_Real Vinf, const Standard_Real Vsup);
   
+  //! Set params in case of empty constructor is usage.
   Standard_EXPORT void SetParams (const Adaptor3d_Curve& C1, const Adaptor3d_Curve& C2, const Standard_Real Uinf, const Standard_Real Usup, const Standard_Real Vinf, const Standard_Real Vsup);
   
   Standard_EXPORT void SetTolerance (const Standard_Real Tol);
@@ -62,16 +73,23 @@ public:
   //! Get flag for single extrema computation. Works on parametric solver only.
   Standard_EXPORT Standard_Boolean GetSingleSolutionFlag () const;
 
+  //! Performs calculations.
   Standard_EXPORT void Perform();
   
+  //! Returns True if the distances are found.
   Standard_EXPORT Standard_Boolean IsDone() const;
   
+  //! Returns state of myParallel flag.
   Standard_EXPORT Standard_Boolean IsParallel() const;
   
+  //! Returns the number of extremum distances.
   Standard_EXPORT Standard_Integer NbExt() const;
   
+  //! Returns the value of the Nth square extremum distance.
   Standard_EXPORT Standard_Real SquareDistance (const Standard_Integer N = 1) const;
   
+  //! Returns the points of the Nth extremum distance.
+  //! P1 is on the first curve, P2 on the second one.
   Standard_EXPORT void Points (const Standard_Integer N, Extrema_POnCurv& P1, Extrema_POnCurv& P2) const;