From: Michael Andreen <harv@ruin.nu>
Date: Mon, 13 Aug 2007 07:21:01 +0000 (+0000)
Subject: some comments
X-Git-Tag: v0.1~30
X-Git-Url: https://ruin.nu/git/?p=germs.git;a=commitdiff_plain;h=97b75639e059f35874dd8f71f86cb36f6ec4e4a4

some comments
---

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;