some comments

[germs.git] / src / model.h

diff --git a/src/model.h b/src/model.h
index 52e4d747c4b6eb0677e18805cc30230244e6102f..8bc41d4bcf73da0bf9b4c1d366360ccce00b8f0e 100644 (file)
--- a/src/model.h
+++ b/src/model.h
@@ -30,12 +30,25 @@ 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 GeneOrder& go) const;
 
                const char* name() const;