some comments

[germs.git] / src / model.h

diff --git a/src/model.h b/src/model.h
index 9ebcb23818960d722bbee289a5c299849000330d..8bc41d4bcf73da0bf9b4c1d366360ccce00b8f0e 100644 (file)
--- a/src/model.h
+++ b/src/model.h
@@ -22,22 +22,36 @@
 #define __MODEL_H__
 
 #include <tr1/memory>
-#include <string>
 
 class SortAction;
+class GeneOrder;
+
 namespace Models {
        class ModelImpl;
 }
 
+/**
+ * Abstraction of a model.
+ * 
+ * Handles scoring of specific actions on gene orders.
+ */
 class Model{
        public:
                typedef std::tr1::shared_ptr<Models::ModelImpl> ModelPointer;
 
+               /**
+                * Constructs a new model.
+                *
+                * \param model The actual model implementation. This model takes 
+                *      ownership of the new allocated implementation and will delete it.
+                */
                Model(Models::ModelImpl* model);
 
-               double score(const SortAction& sa) const;
+               /**
+                */
+               double score(const SortAction& sa, const GeneOrder& go) const;
 
-               std::string name() const;
+               const char* name() const;
 
        private:
                ModelPointer _impl;