Improve comments and documentation.

[genetic.git] / src / selection / roulette.h

diff --git a/src/selection/roulette.h b/src/selection/roulette.h
index 7f2d2401cd9f58c00e8a2f149099183d429d4e3b..6db71efbd38491dd7259db4f919521a963270c19 100644 (file)
--- a/src/selection/roulette.h
+++ b/src/selection/roulette.h
@@ -21,7 +21,14 @@ namespace genetic {
         template < typename _Chromosome >
         class Roulette : public Selection<_Chromosome> {
         public:
+            /**
+             * Parent Selection class
+             */
             typedef Selection<_Chromosome> BaseType;
+
+            /**
+             * Value type returned by the Fitness function
+             */
             typedef typename BaseType::FitnessValueType FitnessValueType;
         protected:
             /**
@@ -92,7 +99,7 @@ namespace genetic {
              *
              * @param normalizedFitness multimap containing normalized Fitness
              *      as a key and its Chromosome as the value
-             * @return new Generation of Chromosome's that passed the selection
+             * @return new Generation of Chromosome's that passed the Selection
              */
             Generation<_Chromosome> spinRoulette(
                 multimap<FitnessValueType, _Chromosome> normalizedFitness) {
@@ -155,6 +162,8 @@ namespace genetic {
 
             /**
              * Draws new Generation using Roulette method
+             *
+             * @return new Generation of Chromosome's that passed the Selection
              */
             Generation<_Chromosome> do_draw() {
                 multimap<FitnessValueType, _Chromosome> normalizedFitness;