DOC: more doxygen documentation

diff --git a/src/genealgorithms.h b/src/genealgorithms.h
index a91f67ddcae2345497c24841ff93dc6d6d5ebf82..59e8f9caee921c452553829d3b1e66bedf32250b 100644 (file)
--- 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;
        }
        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;
        size_t first;

+       //!The end interval for this elementary interval

        size_t second;
        bool oriented;
 };
        size_t second;
        bool oriented;
 };


@@ -73,7 +75,9 @@ std::vector<Component> findComponents(const GeneOrder& go);
 std::vector<Interval> findIntervals(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);
 
  */
 std::vector<Interval> findIntervalsAtPoints(const std::vector<Interval>& intervals);
 

diff --git a/src/modelidentifier.h b/src/modelidentifier.h
index ee163e315d278d427ce646f8a52b29ec98052271..a725136bf565f2813b1c5e601ebcb6f523713b43 100644 (file)
--- a/src/modelidentifier.h
+++ b/src/modelidentifier.h
@@ -51,7 +51,7 @@ class ModelIdentifier{
                /**
                 * Identifies the model for a given gene order.
                 *
                /**
                 * 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);
 
                 */
                std::priority_queue<std::pair<double,Model> > identify(const GeneOrder& go);