From ca651f2fd25147f88dbb27a27bc79bedcd9e4c81 Mon Sep 17 00:00:00 2001
From: Michael Andreen <harv@ruin.nu>
Date: Wed, 29 Aug 2007 06:18:34 +0000
Subject: [PATCH] DOC: more doxygen documentation

---
 src/genealgorithms.h  | 6 +++++-
 src/modelidentifier.h | 2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/genealgorithms.h b/src/genealgorithms.h
index a91f67d..59e8f9c 100644
--- a/src/genealgorithms.h
+++ b/src/genealgorithms.h
@@ -35,7 +35,9 @@ struct Interval{
 	bool operator==(const Interval& i){
 		return first == i.first && second == i.second && oriented == i.oriented;
 	}
+	//!The start index for this elementary interval
 	size_t first;
+	//!The end interval for this elementary interval
 	size_t second;
 	bool oriented;
 };
@@ -73,7 +75,9 @@ std::vector<Component> findComponents(const GeneOrder& go);
 std::vector<Interval> findIntervals(const GeneOrder& go);
 
 /**
- * Creates a list with the intervals at each point.
+ * Creates a list with the intervals at each point. The first and second members
+ * of the returned Intervals are elementary intervals that start, or end, at the
+ * specific point.
  */
 std::vector<Interval> findIntervalsAtPoints(const std::vector<Interval>& intervals);
 
diff --git a/src/modelidentifier.h b/src/modelidentifier.h
index ee163e3..a725136 100644
--- a/src/modelidentifier.h
+++ b/src/modelidentifier.h
@@ -51,7 +51,7 @@ class ModelIdentifier{
 		/**
 		 * Identifies the model for a given gene order.
 		 *
-		 * \returns a map with the model as key and the score between -1 and 1
+		 * \returns a priority_queue with the model as key and the score between -1 and 1
 		 */
 		std::priority_queue<std::pair<double,Model> > identify(const GeneOrder& go);
 
-- 
2.39.2