X-Git-Url: https://ruin.nu/git/?a=blobdiff_plain;f=src%2Fmodel.h;h=8bc41d4bcf73da0bf9b4c1d366360ccce00b8f0e;hb=97b75639e059f35874dd8f71f86cb36f6ec4e4a4;hp=52e4d747c4b6eb0677e18805cc30230244e6102f;hpb=d7c119fefaf9cce07974afbefb4b6a017689a961;p=germs.git

diff --git a/src/model.h b/src/model.h
index 52e4d74..8bc41d4 100644
--- 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;