refs #5633 #5634. Documentation.

mantidproject · Jul 23, 2012 · 3b1821e · 3b1821e
1 parent e708079
commit 3b1821e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/Code/Mantid/Framework/CurveFitting/src/ProductLinearExp.cpp b/Code/Mantid/Framework/CurveFitting/src/ProductLinearExp.cpp
@@ -32,6 +32,12 @@ namespace Mantid
     {
     }
 
+    /**
+    Calculate the 1D function derivatives.
+    @param out : Jacobian to set derivates on.
+    @param xValues : Domain x-values.
+    @param nData : Number of elements.
+    */
     void ProductLinearExp::functionDeriv1D(API::Jacobian* out, const double* xValues, const size_t nData)
     {
       const double A0 = getParameter("A0");
@@ -52,6 +58,12 @@ namespace Mantid
       }
     }
 
+    /**
+    Evaluate the 1D function
+    @param out : Out values.
+    @param xValues : Domain x-values.
+    @param nData : Number of elements.
+    */
     void ProductLinearExp::function1D(double* out, const double* xValues, const size_t nData) const
     {
       const double A0 = getParameter("A0");

diff --git a/Code/Mantid/Framework/CurveFitting/src/ProductQuadraticExp.cpp b/Code/Mantid/Framework/CurveFitting/src/ProductQuadraticExp.cpp
@@ -23,6 +23,12 @@ namespace Mantid
     {
     }
 
+    /**
+    Calculate the 1D function derivatives.
+    @param out : Jacobian to set derivates on.
+    @param xValues : Domain x-values.
+    @param nData : Number of elements.
+    */
     void ProductQuadraticExp::functionDeriv1D(API::Jacobian* out, const double* xValues, const size_t nData)
     {
       const double A0 = getParameter("A0");
@@ -45,6 +51,12 @@ namespace Mantid
       }
     }
 
+    /**
+    Evaluate the 1D function
+    @param out : Out values.
+    @param xValues : Domain x-values.
+    @param nData : Number of elements.
+    */
     void ProductQuadraticExp::function1D(double* out, const double* xValues, const size_t nData) const
     {
       const double A0 = getParameter("A0");