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

[occt.git] / src / AppDef / AppDef_MyGradientbisOfBSplineCompute.hxx

diff --git a/src/AppDef/AppDef_MyGradientbisOfBSplineCompute.hxx b/src/AppDef/AppDef_MyGradientbisOfBSplineCompute.hxx
index d405251..2606608 100644 (file)
--- a/src/AppDef/AppDef_MyGradientbisOfBSplineCompute.hxx
+++ b/src/AppDef/AppDef_MyGradientbisOfBSplineCompute.hxx
@@ -46,18 +46,37 @@ public:
   DEFINE_STANDARD_ALLOC
 
   
+  //! Tries to minimize the sum (square(||Qui - Bi*Pi||))
+  //! where Pui describe the approximating Bezier curves'Poles
+  //! and Qi the MultiLine points with a parameter ui.
+  //! In this algorithm, the parameters ui are the unknowns.
+  //! The tolerance required on this sum is given by Tol.
+  //! The desired degree of the resulting curve is Deg.
   Standard_EXPORT AppDef_MyGradientbisOfBSplineCompute(const AppDef_MultiLine& SSP, const Standard_Integer FirstPoint, const Standard_Integer LastPoint, const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints, math_Vector& Parameters, const Standard_Integer Deg, const Standard_Real Tol3d, const Standard_Real Tol2d, const Standard_Integer NbIterations = 200);
   
+  //! returns True if all has been correctly done.
   Standard_EXPORT Standard_Boolean IsDone() const;
   
+  //! returns all the Bezier curves approximating the
+  //! MultiLine SSP after minimization of the parameter.
   Standard_EXPORT AppParCurves_MultiCurve Value() const;
   
+  //! returns the difference between the old and the new
+  //! approximation.
+  //! An exception is raised if NotDone.
+  //! An exception is raised if Index<1 or Index>NbParameters.
   Standard_EXPORT Standard_Real Error (const Standard_Integer Index) const;
   
+  //! returns the maximum difference between the old and the
+  //! new approximation.
   Standard_EXPORT Standard_Real MaxError3d() const;
   
+  //! returns the maximum difference between the old and the
+  //! new approximation.
   Standard_EXPORT Standard_Real MaxError2d() const;
   
+  //! returns the average error between the old and the
+  //! new approximation.
   Standard_EXPORT Standard_Real AverageError() const;