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

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

diff --git a/src/Extrema/Extrema_LocEPCOfLocateExtPC2d.hxx b/src/Extrema/Extrema_LocEPCOfLocateExtPC2d.hxx
index 8861730..27c5ae0 100644 (file)
--- a/src/Extrema/Extrema_LocEPCOfLocateExtPC2d.hxx
+++ b/src/Extrema/Extrema_LocEPCOfLocateExtPC2d.hxx
@@ -46,20 +46,47 @@ public:
   
   Standard_EXPORT Extrema_LocEPCOfLocateExtPC2d();
   
+  //! Calculates the distance with a close point.
+  //! The close point is defined by the parameter value
+  //! U0.
+  //! The function F(u)=distance(P,C(u)) has an extremum
+  //! when g(u)=dF/du=0. The algorithm searchs a zero
+  //! near the close point.
+  //! TolU is used to decide to stop the iterations.
+  //! At the nth iteration, the criteria is:
+  //! abs(Un - Un-1) < TolU.
   Standard_EXPORT Extrema_LocEPCOfLocateExtPC2d(const gp_Pnt2d& P, const Adaptor2d_Curve2d& C, const Standard_Real U0, const Standard_Real TolU);
   
+  //! Calculates the distance with a close point.
+  //! The close point is defined by the parameter value
+  //! U0.
+  //! The function F(u)=distance(P,C(u)) has an extremum
+  //! when g(u)=dF/du=0. The algorithm searchs a zero
+  //! near the close point.
+  //! Zeros are searched between Umin et Usup.
+  //! TolU is used to decide to stop the iterations.
+  //! At the nth iteration, the criteria is:
+  //! abs(Un - Un-1) < TolU.
   Standard_EXPORT Extrema_LocEPCOfLocateExtPC2d(const gp_Pnt2d& P, const Adaptor2d_Curve2d& C, const Standard_Real U0, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU);
   
+  //! sets the fields of the algorithm.
   Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU);
   
+  //! the algorithm is done with the point P.
+  //! An exception is raised if the fields have not
+  //! been initialized.
   Standard_EXPORT void Perform (const gp_Pnt2d& P, const Standard_Real U0);
   
+  //! Returns True if the distance is found.
   Standard_EXPORT Standard_Boolean IsDone() const;
   
+  //! Returns the value of the extremum square distance.
   Standard_EXPORT Standard_Real SquareDistance() const;
   
+  //! Returns True if the extremum distance is a minimum.
   Standard_EXPORT Standard_Boolean IsMin() const;
   
+  //! Returns the point of the extremum distance.
   Standard_EXPORT const Extrema_POnCurv2d& Point() const;