From 4e6cebbb431222a5d8fa3bc62d5de44c93c8a93e Mon Sep 17 00:00:00 2001
From: astrojhgu <astrojhgu@ed2142bd-67ad-457f-ba7c-d818d4011675>
Date: Sat, 22 Aug 2009 09:40:53 +0000
Subject: git-svn-id: file:///home/svn/opt_utilities@48
 ed2142bd-67ad-457f-ba7c-d818d4011675

---
 methods/gsl_simplex/gsl_simplex.hpp | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'methods/gsl_simplex/gsl_simplex.hpp')

diff --git a/methods/gsl_simplex/gsl_simplex.hpp b/methods/gsl_simplex/gsl_simplex.hpp
index 9c094b0..d2071c8 100644
--- a/methods/gsl_simplex/gsl_simplex.hpp
+++ b/methods/gsl_simplex/gsl_simplex.hpp
@@ -1,3 +1,7 @@
+/**
+   \file gsl_simplex.hpp
+ */
+
 #ifndef GSL_SIMPLEX_METHOD
 #define GSL_SIMPLEX_METHOD
 #include <core/optimizer.hpp>
@@ -8,14 +12,15 @@
 #include <cmath>
 #include <algorithm>
 #include <gsl_multimin.h>
-/*
- *
-*/
 #include <iostream>
 
 
 namespace opt_utilities
 {
+
+  /**
+     object function of the gsl simplex function
+   */
   template <typename rT,typename pT>
   double gsl_func_adapter(const gsl_vector* v,void* params)
   {
@@ -29,6 +34,11 @@ namespace opt_utilities
   }
 
 
+  /**
+     wrapper for the gsl simplex optimization method
+     \tparam return type of the object function
+     \tparam param type of the object function
+  */
   template <typename rT,typename pT>
   class gsl_simplex
     :public opt_method<rT,pT>
-- 
cgit v1.2.2