From 7f6c591a6bc693090411f6a31ff87979fba76ff4 Mon Sep 17 00:00:00 2001
From: nojhan <nojhan@gmail.com>
Date: Mon, 12 Sep 2011 16:05:18 +0200
Subject: [PATCH] dox for bounders

---
 edo/src/edoBounder.h        | 13 ++++++++-----
 edo/src/edoBounderBound.h   |  6 ++++--
 edo/src/edoBounderNo.h      |  6 ++++--
 edo/src/edoBounderRng.h     |  7 +++++--
 edo/src/edoBounderUniform.h |  7 +++++--
 5 files changed, 26 insertions(+), 13 deletions(-)

diff --git a/edo/src/edoBounder.h b/edo/src/edoBounder.h
index 0ab5f275..8291cffc 100644
--- a/edo/src/edoBounder.h
+++ b/edo/src/edoBounder.h
@@ -30,17 +30,20 @@ Authors:
 
 #include <eoFunctor.h>
 
-//! edoBounder< EOT >
-
+/** The interface of a set of classes that modifies a solution so as to respect
+ * a given set of bounds (typically an hypercube).
+ *
+ * @ingroup Bounders
+ */
 template < typename EOT >
 class edoBounder : public eoUF< EOT&, void >
 {
 public:
     edoBounder( EOT min = EOT(1, 0), EOT max = EOT(1, 0) )
-	: _min(min), _max(max)
+        : _min(min), _max(max)
     {
-	assert(_min.size() > 0);
-	assert(_min.size() == _max.size());
+        assert(_min.size() > 0);
+        assert(_min.size() == _max.size());
     }
 
     // virtual void operator()( EOT& ) = 0 (provided by eoUF< A1, R >)
diff --git a/edo/src/edoBounderBound.h b/edo/src/edoBounderBound.h
index 31a4e586..88865a52 100644
--- a/edo/src/edoBounderBound.h
+++ b/edo/src/edoBounderBound.h
@@ -30,8 +30,10 @@ Authors:
 
 #include "edoBounder.h"
 
-//! edoBounderBound< EOT >
-
+/** A bounder that correct an incorrect variable by setting it to the min/max
+ *
+ * @ingroup Bounders
+ */
 template < typename EOT >
 class edoBounderBound : public edoBounder< EOT >
 {
diff --git a/edo/src/edoBounderNo.h b/edo/src/edoBounderNo.h
index f0e45454..31b4b499 100644
--- a/edo/src/edoBounderNo.h
+++ b/edo/src/edoBounderNo.h
@@ -30,8 +30,10 @@ Authors:
 
 #include "edoBounder.h"
 
-//! edoBounderNo< EOT >
-
+/** A bounder that does nothing.
+ *
+ * @ingroup Bounders
+ */
 template < typename EOT >
 class edoBounderNo : public edoBounder< EOT >
 {
diff --git a/edo/src/edoBounderRng.h b/edo/src/edoBounderRng.h
index 2501a212..2db937a2 100644
--- a/edo/src/edoBounderRng.h
+++ b/edo/src/edoBounderRng.h
@@ -30,8 +30,11 @@ Authors:
 
 #include "edoBounder.h"
 
-//! edoBounderRng< EOT >
-
+/** A bounder that randomly draw new values for variables going out bounds, 
+ * using an eoRng to do so.
+ *
+ * @ingroup Bounders
+ */
 template < typename EOT >
 class edoBounderRng : public edoBounder< EOT >
 {
diff --git a/edo/src/edoBounderUniform.h b/edo/src/edoBounderUniform.h
index 6501a481..886221a7 100644
--- a/edo/src/edoBounderUniform.h
+++ b/edo/src/edoBounderUniform.h
@@ -29,8 +29,11 @@ Authors:
 
 #include "edoBounder.h"
 
-//! edoBounderUniform< EOT >
-
+/** A bounder that randomly draw new values for variables going out bounds,
+ * in a given uniform distribution.
+ *
+ * @ingroup Bounders
+ */
 template < typename EOT >
 class edoBounderUniform : public edoBounder< EOT >
 {