git-svn-id: file:///home/svn/opt_utilities@52 ed2142bd-67ad-457f-ba7c-d818d4011675

19 files changed, 30 insertions, 30 deletions

diff --git a/core/fitter.hpp b/core/fitter.hpp
index 2dff97b..119c930 100644
--- a/core/fitter.hpp
+++ b/core/fitter.hpp
@@ -26,7 +26,7 @@ namespace opt_utilities
 

 

   /**

-     representing a single data point

+     \brief representing a single data point

      \tparam Ty the type of y

      \tparam Tx the type of x

    */

@@ -217,7 +217,7 @@ namespace opt_utilities
   };

 

   /**

-     virtual class representing a set of data

+     \brief virtual class representing a set of data

      \tparam Ty type of y

      \tparam Tx type of x

    */  

@@ -302,7 +302,7 @@ namespace opt_utilities
   

 

   /**

-     the information of a model parameter

+     \brief the information of a model parameter

      \tparam Tp type of model param type

      \tparam Tstr the type of string type used

    */

@@ -441,7 +441,7 @@ namespace opt_utilities
 

 

   /**

-     virtual class representing a model

+     \brief virtual class representing a model

      \tparam Ty the type of the returned value of the model

      \tparam Tx the type of the self-var

      \tparam Tp the type of the model param

@@ -910,7 +910,7 @@ namespace opt_utilities
 

 

   /**

-     class to perform the model fitting

+     \brief class to perform the model fitting

      \tparam Ty the type of the model return type

      \tparam Tx the type of the model self-var

      \tparam Tp the type of the model param

@@ -1477,7 +1477,7 @@ namespace opt_utilities
 

 

   /**

-     virtual class representing a statistic

+     \brief virtual class representing a statistic

      \tparam Ty the type of the model return type

      \tparam Tx the type of the model self-var

      \tparam Tp the type of the model param

@@ -1606,7 +1606,7 @@ namespace opt_utilities
 

 

   /**

-     Used to modify the parameter, e.g., freezing, bind

+     \brief Used to modify the parameter, e.g., freezing, bind

      \tparam Ty the type of the model return type

      \tparam Tx the type of the model self-var

      \tparam Tp the type of the model param

diff --git a/core/num_diff.hpp b/core/num_diff.hpp
index a6d9659..d6db632 100644
--- a/core/num_diff.hpp
+++ b/core/num_diff.hpp
@@ -16,7 +16,7 @@ namespace opt_utilities
 {
 
   /**
-     differentiable function
+     \brief differentiable function
      \tparam rT the return type
      \tparam the parameter type
    */
diff --git a/core/opt_exception.hpp b/core/opt_exception.hpp
index 4413da7..458ff87 100644
--- a/core/opt_exception.hpp
+++ b/core/opt_exception.hpp
@@ -9,7 +9,7 @@
 namespace opt_utilities
 {
   /**
-     the root class of exception used in opt_utilities
+     \brief the root class of exception used in opt_utilities
    */
   class opt_exception
     :public std::exception
diff --git a/core/opt_traits.hpp b/core/opt_traits.hpp
index 7c2638a..c660208 100644
--- a/core/opt_traits.hpp
+++ b/core/opt_traits.hpp
@@ -19,7 +19,7 @@ namespace opt_utilities
   }
   
   /**
-     Trait class, in which the types of elements in an array are defined
+     \brief Trait class, in which the types of elements in an array are defined
      \tparam the type of the array object
    */
   template <typename T>
@@ -34,7 +34,7 @@ namespace opt_utilities
 
   
   /**
-     The return type trait of some certain data types.
+     \brief The return type trait of some certain data types.
   */
   template <typename T>
   class return_type_trait
diff --git a/core/optimizer.hpp b/core/optimizer.hpp
index 2381da0..6b146cf 100644
--- a/core/optimizer.hpp
+++ b/core/optimizer.hpp
@@ -33,7 +33,7 @@ namespace opt_utilities
   class opt_method;
 
   /**
-     Virtual class representing an object function.
+     \brief Virtual class representing an object function.
      \tparam rT the return type
      \tparam pT the self-varible type
    */
@@ -104,7 +104,7 @@ namespace opt_utilities
   
 
   /**
-     virtual class representing optimization methods
+     \brief virtual class representing optimization methods
      \tparam rT the return type
      \tparam pT the self-varible type
    */
@@ -234,7 +234,7 @@ namespace opt_utilities
   
   
   /**
-     The manager for performing the manager
+     \brief The manager for performing the manager
      \tparam rT the return type
      \tparam pT the self-varible type
   */
diff --git a/data_sets/default_data_set.hpp b/data_sets/default_data_set.hpp
index 7d63fb9..2df7668 100644
--- a/data_sets/default_data_set.hpp
+++ b/data_sets/default_data_set.hpp
@@ -12,7 +12,7 @@ namespace opt_utilities
 {
 
   /**
-     default implement of the data set
+     \brief default implement of the data set
      \tparam Ty type of y
      \tparam Tx type of x
    */
diff --git a/data_sets/sorted_data_set.hpp b/data_sets/sorted_data_set.hpp
index 868f293..1416d68 100644
--- a/data_sets/sorted_data_set.hpp
+++ b/data_sets/sorted_data_set.hpp
@@ -20,7 +20,7 @@ namespace opt_utilities
 
 
   /**
-     automatically sorting data set
+     \brief automatically sorting data set
      \tparam Ty type of y
      \tparam Tx type of x
    */
diff --git a/methods/aga/aga.hpp b/methods/aga/aga.hpp
index 81c53df..f87d215 100644
--- a/methods/aga/aga.hpp
+++ b/methods/aga/aga.hpp
@@ -1,6 +1,6 @@
 /**
    \file aga.hpp
-   asexual genetic algorithm method
+   \brief asexual genetic algorithm method
 */
 
 #ifndef AGA_METHOD
@@ -44,7 +44,7 @@ namespace opt_utilities
 
 
   /**
-     Implement of the asexual genetic algorithm
+     \brief Implement of the asexual genetic algorithm
      2009A&A...501.1259C
      http://adsabs.harvard.edu/abs/2009arXiv0905.3712C
      \tparam rT return type of the object function
diff --git a/methods/gsl_simplex/gsl_simplex.hpp b/methods/gsl_simplex/gsl_simplex.hpp
index d2071c8..4b9295f 100644
--- a/methods/gsl_simplex/gsl_simplex.hpp
+++ b/methods/gsl_simplex/gsl_simplex.hpp
@@ -19,7 +19,7 @@ namespace opt_utilities
 {
 
   /**
-     object function of the gsl simplex function
+     \brief object function of the gsl simplex function
    */
   template <typename rT,typename pT>
   double gsl_func_adapter(const gsl_vector* v,void* params)
@@ -35,7 +35,7 @@ namespace opt_utilities
 
 
   /**
-     wrapper for the gsl simplex optimization method
+     \brief wrapper for the gsl simplex optimization method
      \tparam return type of the object function
      \tparam param type of the object function
   */
diff --git a/methods/powell/powell_method.hpp b/methods/powell/powell_method.hpp
index 6bb6519..eb5c498 100644
--- a/methods/powell/powell_method.hpp
+++ b/methods/powell/powell_method.hpp
@@ -16,7 +16,7 @@
 namespace opt_utilities
 {
   /**
-     Impliment of an optimization method
+     \brief Impliment of an optimization method
      \tparam rT return type of the object function
      \tparam pT parameter type of the object function
    */
diff --git a/misc/bootstrap.hpp b/misc/bootstrap.hpp
index 492ff9f..c6a399d 100644
--- a/misc/bootstrap.hpp
+++ b/misc/bootstrap.hpp
@@ -17,7 +17,7 @@ namespace opt_utilities
 {
 
   /**
-     using bootstrap method to estimate confidence interval
+     \brief using bootstrap method to estimate confidence interval
      \tparam Ty the return type of a model
      \tparam Tx the type of self-var
      \tparam Tp the type of model parameters
diff --git a/samples/a.dat b/sample_data/a.dat
index ea2ff04..ea2ff04 100644
--- a/samples/a.dat
+++ b/sample_data/a.dat
diff --git a/samples/bpl.dat b/sample_data/bpl.dat
index f7e9490..f7e9490 100644
--- a/samples/bpl.dat
+++ b/sample_data/bpl.dat
diff --git a/samples/gauss.dat b/sample_data/gauss.dat
index 4130e1b..4130e1b 100644
--- a/samples/gauss.dat
+++ b/sample_data/gauss.dat
diff --git a/samples/gauss2.dat b/sample_data/gauss2.dat
index defb230..defb230 100644
--- a/samples/gauss2.dat
+++ b/sample_data/gauss2.dat
diff --git a/samples/powerlaw.dat b/sample_data/powerlaw.dat
index ef67d32..ef67d32 100644
--- a/samples/powerlaw.dat
+++ b/sample_data/powerlaw.dat
diff --git a/statistics/chisq.hpp b/statistics/chisq.hpp
index 7c38b4e..3dff92d 100644
--- a/statistics/chisq.hpp
+++ b/statistics/chisq.hpp
@@ -14,7 +14,7 @@ namespace opt_utilities
 {

 

   /**

-     chi-square statistic

+     \brief chi-square statistic

      \tparam Ty the return type of model

      \tparam Tx the type of the self-var

      \tparam Tp the type of model parameter

diff --git a/statistics/cstat.hpp b/statistics/cstat.hpp
index 45e2920..ef1fa12 100644
--- a/statistics/cstat.hpp
+++ b/statistics/cstat.hpp
@@ -12,7 +12,7 @@ namespace opt_utilities
 {

 

   /**

-     c-statistic, max-likelihood method

+     \brief c-statistic, max-likelihood method

      \tparam Ty the return type of model

      \tparam Tx the type of the self-var

      \tparam Tp the type of model parameter

diff --git a/statistics/leastsq.hpp b/statistics/leastsq.hpp
index 6ac0adc..146a069 100644
--- a/statistics/leastsq.hpp
+++ b/statistics/leastsq.hpp
@@ -14,12 +14,12 @@ namespace opt_utilities
 {

 

    /**

-     least-square statistic

-     \tparam Ty the return type of model

-     \tparam Tx the type of the self-var

-     \tparam Tp the type of model parameter

-     \tparam Ts the type of the statistic

-     \tparam Tstr the type of the string used

+      \brief least-square statistic

+      \tparam Ty the return type of model

+      \tparam Tx the type of the self-var

+      \tparam Tp the type of model parameter

+      \tparam Ts the type of the statistic

+      \tparam Tstr the type of the string used

    */

   template<typename Ty,typename Tx,typename Tp,typename Ts,typename Tstr>

   class leastsq