Added more doxygen documentation

[germs.git] / src / model.h

diff --git a/src/model.h b/src/model.h
index 8bc41d4bcf73da0bf9b4c1d366360ccce00b8f0e..4c5f46a8005956dd523cd4edabcf04aa1b2b23b9 100644 (file)
--- a/src/model.h
+++ b/src/model.h
@@ -22,6 +22,7 @@
 #define __MODEL_H__
 
 #include <tr1/memory>
+#include <string>
 
 class SortAction;
 class GeneOrder;
@@ -48,11 +49,21 @@ class Model{
                Model(Models::ModelImpl* model);
 
                /**
+                * Gives the score for the action on a given gene order.
+                * A better match for this model gives a higher score.
                 */
                double score(const SortAction& sa, const GeneOrder& go) const;
 
+               /**
+                * The name for the model used.
+                */
                const char* name() const;
 
+               /**
+                * Creates a model from a name.
+                */
+               static Model modelFactory(const std::string& name);
+
        private:
                ModelPointer _impl;