more documentation

diff --git a/src/geneorder.h b/src/geneorder.h
index a4b7aaa0ae51a7567c450a7f87655627c0639ab4..4659e0efee62ca5194a3505b75d868bfe865c416 100644 (file)
--- a/src/geneorder.h
+++ b/src/geneorder.h
@@ -27,7 +27,13 @@
 #include "misc.h"
 
 /**
- * Stores a gene order permutation and ensures that all genes are present and not duplicated.
+ * Stores a gene order permutation and ensures that all genes are present 
+ * and not duplicated.
+ *
+ * It has limited support for acting as an STL container, but still maintaining
+ * the invariant of a permutation starting with 0 and ending with n, with all
+ * genes present.
+ *
  * \author Michael Andreen
 */
 class GeneOrder{