fix various documentations and thus doxygen warnings

shogun-toolbox · Apr 19, 2012 · 519d74a · 519d74a
1 parent c58a034
commit 519d74a
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/src/shogun/classifier/NearestCentroid.h b/src/shogun/classifier/NearestCentroid.h
@@ -40,7 +40,7 @@ class CNearestCentroid : public CDistanceMachine{
 
 	/** constructor
 	 *
-	 * @param d distance
+	 * @param distance distance
 	 * @param trainlab labels for training
 	 */
 	CNearestCentroid(CDistance* distance, CLabels* trainlab);
@@ -108,4 +108,4 @@ class CNearestCentroid : public CDistanceMachine{
 
 }
 
-#endif
+#endif
diff --git a/src/shogun/distance/Distance.h b/src/shogun/distance/Distance.h
@@ -237,7 +237,7 @@ class CDistance : public CSGObject
 		 * @param lhs features of right-hand side
 		 * @return replaced left-hand side features
 		 */
-		CFeatures* replace_lhs(CFeatures* rhs);
+		CFeatures* replace_lhs(CFeatures* lhs);
 
 		/** remove lhs and rhs from distance */
 		virtual void remove_lhs_and_rhs();

diff --git a/src/shogun/lib/List.h b/src/shogun/lib/List.h
@@ -520,6 +520,7 @@ class CList : public CSGObject
 			last = prev;
 		}
 
+		/** print all elements of the list */
 		void print_list()
 		{
 			CListElement* c=first;

diff --git a/src/shogun/regression/KernelRidgeRegression.h b/src/shogun/regression/KernelRidgeRegression.h
@@ -68,6 +68,7 @@ class CKernelRidgeRegression : public CKernelMachine
 		 * @param tau regularization constant tau
 		 * @param k kernel
 		 * @param lab labels
+		 * @m method to use for training PINV (pseudo inverse by default)
 		 */
 		CKernelRidgeRegression(float64_t tau, CKernel* k, CLabels* lab, ETrainingType m=PINV);
 		virtual ~CKernelRidgeRegression() {}
@@ -78,9 +79,9 @@ class CKernelRidgeRegression : public CKernelMachine
 		 */
 		inline void set_tau(float64_t tau) { m_tau = tau; };
 
-		/** set precision
+		/** set convergence precision for gauss seidel method
 		 *
-		 * @param tau new tau
+		 * @param epsilon new epsilon
 		 */
 		inline void set_epsilon(float64_t epsilon) { m_epsilon = epsilon; }