dox for bounders

edo/src/edoBounder.h

@@ -30,8 +30,11 @@ 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 >
 {

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 >
 {

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 >
 {

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 >
 {

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 >
 {