Filled in some doc to avoid warnings

shogun-toolbox · Aug 10, 2012 · 7bb72c9 · 7bb72c9
1 parent 356cfcf
commit 7bb72c9
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 18 deletions.
diff --git a/src/shogun/base/SGObject.h b/src/shogun/base/SGObject.h
@@ -408,7 +408,7 @@ class CSGObject
 	 */
 	virtual void save_serializable_post() throw (ShogunException);
 
-	/*Updates the hash of current parameter combination.
+	/** Updates the hash of current parameter combination.
 	 *
 	 * @return bool if parameter combination has changed since last
 	 * update.
@@ -476,7 +476,7 @@ class CSGObject
 	/** map for different parameter versions */
 	ParameterMap* m_parameter_map;
 
-	/*Hash of parameter values*/
+	/** * * * * * * * Hash of parameter values*/
 	uint32_t m_hash;
 
 private:

diff --git a/src/shogun/features/SparseFeatures.h b/src/shogun/features/SparseFeatures.h
@@ -346,7 +346,6 @@ template <class ST> class CSparseFeatures : public CDotFeatures
 		 *
 		 * possible with subset
 		 *
-		 * @param vec feature vector to free
 		 * @param num index of vector in cache
 		 */
 		void free_feature_vector(int32_t num);

diff --git a/src/shogun/kernel/CombinedKernel.h b/src/shogun/kernel/CombinedKernel.h
@@ -384,9 +384,9 @@ class CCombinedKernel : public CKernel
 
 		/** return derivative with respect to specified parameter
 		 *
-		 * @param  param the parameter
+		 * @param param the parameter
 		 * @param obj the object that owns the parameter
-		 * @index index the index of the element if parameter is a vector
+		 * @param index index the index of the element if parameter is a vector
 		 *
 		 * @return gradient with respect to parameter
 		 */

diff --git a/src/shogun/lib/SGReferencedData.h b/src/shogun/lib/SGReferencedData.h
@@ -16,10 +16,13 @@
 #include <pthread.h>
 #endif
 
+/** refcount structure */
 struct refcount_t 
 {
+	/** reference count */
 	int32_t rc;
 #ifdef HAVE_PTHREAD
+	/** lock for thread safety */
 	PTHREAD_LOCK_T lock;
 #endif
 };

diff --git a/src/shogun/lib/SGVector.h b/src/shogun/lib/SGVector.h
@@ -472,6 +472,7 @@ template<class T> class SGVector : public SGReferencedData
 			const T* vector, int32_t n, const char* name="vector",
 			const char* prefix="");
 
+		/// display vector (useful for debugging)
 		static void display_vector(
 			const SGVector<T>, const char* name="vector",
 			const char* prefix="");
@@ -510,6 +511,7 @@ template<class T> class SGVector : public SGReferencedData
 				return data[i] < data[j];
 			}
 
+			/** data */
 			const T* data;
 		};
 		/** get sorted index.

diff --git a/src/shogun/modelselection/ModelSelectionOutput.h b/src/shogun/modelselection/ModelSelectionOutput.h
@@ -31,20 +31,30 @@ class CModelSelectionOutput: public CSGObject
 	/** destructor */
 	virtual ~CModelSelectionOutput();
 
+	/** get name */
 	virtual const char* get_name() const { return "ModelSelectionOutput"; }
 
+	/** output train indices */
 	void output_train_indices(SGVector<index_t> indices);
+	/** output test indices */
 	void output_test_indices(SGVector<index_t> indices);
+	/** output trained machine */
 	void output_trained_machine(CMachine* machine);
+	/** output test result */
 	void output_test_result(CLabels* results);
+	/** output test true result */
 	void output_test_true_result(CLabels* results);
+	/** output evaluate result */
 	void output_evaluate_result(float64_t result);
 
+	/** add custom evaluation */
 	void add_custom_evaluation(CEvaluation* evaluation);
+	/** output custom evaluations */
 	void output_custom_evaluations(CLabels* results, CLabels* truth);
 
 protected:
 
+	/** custom evaluations */
 	CDynamicObjectArray* m_custom_evaluations;
 
 };

diff --git a/src/shogun/modelselection/ParameterCombination.h b/src/shogun/modelselection/ParameterCombination.h
@@ -118,6 +118,7 @@ friend class CModelSelectionParameters;
 	 * @param name Name of parameter
 	 * @param value value to be set
 	 * @param parent The CSObject that directly holds this parameter
+	 * @param index index
 	 *
 	 * @return bool true if value successfully set.
 	 */
@@ -205,7 +206,7 @@ friend class CModelSelectionParameters;
 	 *
 	 * @param sets set of sets of CParameterCombination instances which
 	 * represent the trees to be multiplied
-	 * @new_root this new root is put in front of all products
+	 * @param new_root this new root is put in front of all products
 	 * @return set of trees with the given root as root and all combinations
 	 * of the trees in the sets as children
 	 */

diff --git a/src/shogun/modelselection/RandomSearchModelSelection.h b/src/shogun/modelselection/RandomSearchModelSelection.h
@@ -31,9 +31,9 @@ class CRandomSearchModelSelection: public CModelSelection
 	CRandomSearchModelSelection();
 
 	/** constructor
-	 * @param model_parameters
-	 * @param cross_validation
-	 * @param ratio
+	 * @param model_parameters model parameters to use
+	 * @param machine_eval machine to use
+	 * @param ratio ratio in range [0,1]
 	 */
 	CRandomSearchModelSelection(CModelSelectionParameters* model_parameters,
 			CMachineEvaluation* machine_eval, float64_t ratio);

diff --git a/src/shogun/transfer/multitask/MultitaskClusteredLogisticRegression.h b/src/shogun/transfer/multitask/MultitaskClusteredLogisticRegression.h
@@ -35,8 +35,8 @@ class CMultitaskClusteredLogisticRegression : public CMultitaskLogisticRegressio
 		 * @param rho2 rho2 regularization coefficient
 		 * @param training_data training features
 		 * @param training_labels training labels
-		 * @param task_relation task relation
-		 * @param num_cluster number of task clusters
+		 * @param task_group task group
+		 * @param num_clusters number of task clusters
 		 */
 		CMultitaskClusteredLogisticRegression(
 		     float64_t rho1, float64_t rho2, CDotFeatures* training_data, 

diff --git a/src/shogun/transfer/multitask/MultitaskL1L2LogisticRegression.h b/src/shogun/transfer/multitask/MultitaskL1L2LogisticRegression.h
@@ -34,7 +34,7 @@ class CMultitaskL1L2LogisticRegression : public CMultitaskLogisticRegression
 		 * @param rho2 rho2 regularization coefficient of L2 term
 		 * @param training_data training features
 		 * @param training_labels training labels
-		 * @param task_relation task relation
+		 * @param task_group task group
 		 */
 		CMultitaskL1L2LogisticRegression(
 		     float64_t rho1, float64_t rho2, CDotFeatures* training_data, 
@@ -49,7 +49,7 @@ class CMultitaskL1L2LogisticRegression : public CMultitaskLogisticRegression
 		void set_rho1(float64_t rho1); 
 
 		/** get rho1 regularization coefficient
-		 * @param rho1 value
+		 * @return rho1 value
 		 */
 		float64_t get_rho1() const; 
 

diff --git a/src/shogun/transfer/multitask/MultitaskLinearMachine.h b/src/shogun/transfer/multitask/MultitaskLinearMachine.h
@@ -34,7 +34,6 @@ class CMultitaskLinearMachine : public CLinearMachine
 
 		/** constructor
 		 *
-		 * @param z regularization coefficient
 		 * @param training_data training features
 		 * @param training_labels training labels
 		 * @param task_relation task relation
@@ -86,13 +85,13 @@ class CMultitaskLinearMachine : public CLinearMachine
 		 */
 		virtual float64_t get_bias();
 
-		/** getter for task tree
-		 * @return task tree
+		/** getter for task relation
+		 * @return task relation
 		 */
 		CTaskRelation* get_task_relation() const;
 
-		/** setter for task tree
-		 * @param task_tree task tree
+		/** setter for task relation
+		 * @param task_relation task relation
 		 */
 		void set_task_relation(CTaskRelation* task_relation);