Improve comments and documentation.

[genetic.git] / src / chromosome.h

diff --git a/src/chromosome.h b/src/chromosome.h
index e197f169be2a649d5427cb13f0264b25269c547d..7399ea45959607575d476c741b316b49913efb41 100644 (file)
--- a/src/chromosome.h
+++ b/src/chromosome.h
@@ -14,6 +14,9 @@ namespace genetic {
     template < typename _Gene >
     class Chromosome {
     public:
+        /**
+         * Type representing Chromosome Gene
+         */
         typedef _Gene GeneType;
     protected:
         /**
@@ -27,6 +30,11 @@ namespace genetic {
          */
         Chromosome() {}
 
+        /**
+         * Class constructor. Initializes Chromosome with the given Gene's
+         *
+         * @param genes vector containing Genes to use in Chromosome
+         */
         Chromosome(vector<_Gene> genes) {
             this->genes = genes;
         }
@@ -36,11 +44,20 @@ namespace genetic {
             : genes(chromosome.get()) {
         }
 
-        Chromosome& operator=(const Chromosome& chromosome){
+        /**
+         * Copy operator.
+         *
+         * @param chromosome Chromosome from which the Genes should be copied.
+         * @return Chromosome instance containing copied Genes
+         */
+        Chromosome& operator=(const Chromosome& chromosome) {
             this->genes = chromosome.get();
             return *this;
         }
 
+        /**
+         * Allows read-only access to Chromosome Genes
+         */
         vector<_Gene> get() const {
             return this->genes;
         }