Index: trunk/psLib/src/dataManip/psMinimize.h
===================================================================
--- trunk/psLib/src/dataManip/psMinimize.h	(revision 4162)
+++ trunk/psLib/src/dataManip/psMinimize.h	(revision 4243)
@@ -8,6 +8,6 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.43 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-08 23:40:45 $
+ *  @version $Revision: 1.44 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-14 02:54:12 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -37,4 +37,8 @@
 #include "psConstants.h"
 
+/** A psMinimization data structure.
+ *  
+ *  Contains numerical analysis parameters/values
+ */
 typedef struct
 {
@@ -47,7 +51,12 @@
 psMinimization;
 
-psMinimization *psMinimizationAlloc(psS32 maxIter,   ///< Number of minimization iterations to perform.
-                                    psF32 tol        ///< Requested error tolerance
-                                   );
+/** Allocates a psMinimization structure.
+ *  
+ *  @return psMinimization* :   a new psMinimization struct
+*/
+psMinimization *psMinimizationAlloc(
+    psS32 maxIter,                     ///< Number of minimization iterations to perform.
+    psF32 tol                          ///< Requested error tolerance
+);
 
 /** Derive a polynomial fit.
@@ -71,72 +80,156 @@
 );
 
-psSpline1D *psVectorFitSpline1D(psSpline1D *mySpline,     ///< The spline which will be generated.
-                                const psVector* x,        ///< Ordinates (or NULL to just use the indices)
-                                const psVector* y,        ///< Coordinates
-                                const psVector* yErr      ///< Errors in coordinates, or NULL
-                               );
-
-// XXX: Add Doxygen comments here.
+/** Derive a one-dimensional spline fit.
+ *    
+ *  Given a psSpline1D data structure and a set of x,y vectors, this routine generates
+ *  the linear splines which satisfy those data points.
+ *  
+ *  @return psSpline1D*:  the calculated one-dimensional splines
+ */
+psSpline1D *psVectorFitSpline1D(
+    psSpline1D *mySpline,              ///< The spline which will be generated.
+    const psVector* x,                 ///< Ordinates (or NULL to just use the indices)
+    const psVector* y,                 ///< Coordinates
+    const psVector* yErr               ///< Errors in coordinates, or NULL
+);
+
+/** Defines a Levenberg-Marquardt function of a collection of parameters evaluated at a given position.
+ *  
+ *  @return psF64:   a single floating-point value which is the value of the function given the parameters 
+ *      and coordinate vectors, along with the derivatives of the function with respect to each of the parameters.
+ */
 typedef
-psF64 (*psMinimizeLMChi2Func)(psVector *deriv,
-                              psVector *params,
-                              psVector *x);
-
-psBool psMinimizeLMChi2(psMinimization *min,
-                        psImage *covar,
-                        psVector *params,
-                        const psVector *paramMask,
-                        const psArray *x,
-                        const psVector *y,
-                        const psVector *yErr,
-                        psMinimizeLMChi2Func func);
-
-psBool p_psMinLM_GuessABP (psImage  *Alpha,
-                           psVector *Beta,
-                           psVector *Params,
-                           psImage  *alpha,
-                           psVector *beta,
-                           psVector *params,
-                           psF64 lambda);
-
-psF64 p_psMinLM_SetABX (psImage  *alpha,
-                        psVector *beta,
-                        psVector *params,
-                        const psArray  *x,
-                        const psVector *y,
-                        const psVector *dy,
-                        psMinimizeLMChi2Func func);
-
+psF64 (*psMinimizeLMChi2Func)(
+    psVector *deriv,                   ///< derivatives of the function
+    psVector *params,                  ///< the parameters used to evaluate the function
+    psVector *x                        ///< positions for evaluation
+);
+
+/** Fits a specified function based on the Levenberg-Marquardt method.
+ *  
+ *  @return psBool:   True unless an error occurred.
+ */
+psBool psMinimizeLMChi2(
+    psMinimization *min,               ///<
+    psImage *covar,                    ///<
+    psVector *params,                  ///<
+    const psVector *paramMask,         ///<
+    const psArray *x,                  ///<
+    const psVector *y,                 ///<
+    const psVector *yErr,              ///<
+    psMinimizeLMChi2Func func          ///<
+);
+
+/**
+ *  
+ * 
+ *  @return psBool:   True if 
+ */
+psBool p_psMinLM_GuessABP(
+    psImage  *Alpha,                   ///<
+    psVector *Beta,                    ///<
+    psVector *Params,                  ///<
+    psImage  *alpha,                   ///<
+    psVector *beta,                    ///<
+    psVector *params,                  ///<
+    psF64 lambda                       ///<
+);
+
+/**
+ *  
+ * 
+ *  @return psF64:    
+ */
+psF64 p_psMinLM_SetABX (
+    psImage  *alpha,                   ///<
+    psVector *beta,                    ///<
+    psVector *params,                  ///<
+    const psArray  *x,                 ///<
+    const psVector *y,                 ///<
+    const psVector *dy,                ///<
+    psMinimizeLMChi2Func func);        ///<
+
+/**
+ *  
+ *  
+ *  @return psF32:   
+*/
 typedef
-psF32 (*psMinimizePowellFunc)(const psVector *params,
-                              const psArray *coords);
-
-psBool psMinimizePowell(psMinimization *min,
-                        psVector *params,
-                        const psVector *paramMask,
-                        const psArray *coords,
-                        psMinimizePowellFunc func);
-
-psVector *psMinimizeLMChi2Gauss1D(psImage *deriv,
-                                  const psVector *params,
-                                  const psArray *coords);
-
-psVector *psMinimizePowellChi2Gauss1D(const psVector *params,
-                                      const psArray *coords);
-
+psF32 (*psMinimizePowellFunc)(
+    const psVector *params,            ///<
+    const psArray *coords              ///<
+);
+
+
+/**
+ *  
+ * 
+ *  @return psBool:   True if 
+ */
+psBool psMinimizePowell(
+    psMinimization *min,               ///<
+    psVector *params,                  ///<
+    const psVector *paramMask,         ///<
+    const psArray *coords,             ///<
+    psMinimizePowellFunc func          ///<
+);
+
+/**
+ *  
+ * 
+ *  @return psVector*:    
+ */
+psVector *psMinimizeLMChi2Gauss1D(
+    psImage *deriv,                    ///<
+    const psVector *params,            ///<
+    const psArray *coords              ///<
+);
+
+/**
+ *  
+ * 
+ *  @return psVector*:   
+ */
+psVector *psMinimizePowellChi2Gauss1D(
+    const psVector *params,            ///<
+    const psArray *coords              ///<
+);
+
+/**
+ *  
+ *  
+ *  
+*/
 typedef
-psVector *(*psMinimizeChi2PowellFunc)(const psVector *params,
-                                      const psArray *coords);
-
-psBool psMinimizeChi2Powell(psMinimization *min,
-                            psVector *params,
-                            const psVector *paramMask,
-                            const psArray *coords,
-                            const psVector *value,
-                            const psVector *error,
-                            psMinimizeChi2PowellFunc func);
-
-// XXX EAM : psGaussJordan provided as an alternate to LU Decomp for psMinimizeLMChi2
-bool psGaussJordan (psImage *a, psVector *b);
+psVector *(*psMinimizeChi2PowellFunc)(
+    const psVector *params,            ///<
+    const psArray *coords              ///<
+);
+
+
+/**
+ *  
+ * 
+ *  @return psBool:   True if 
+ */
+psBool psMinimizeChi2Powell(
+    psMinimization *min,               ///<
+    psVector *params,                  ///<
+    const psVector *paramMask,         ///<
+    const psArray *coords,             ///<
+    const psVector *value,             ///<
+    const psVector *error,             ///<
+    psMinimizeChi2PowellFunc func      ///<
+);
+
+/**
+ *  
+ * 
+ *  @return bool:   True if 
+ */
+bool psGaussJordan(
+    psImage *a,                        ///<
+    psVector *b                        ///<
+);
 
 /* \} */// End of MathGroup Functions