fix doxygen documentation related errors

shogun-toolbox · Apr 19, 2012 · 723ccd1 · 723ccd1
1 parent 9815db6
commit 723ccd1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/src/shogun/kernel/LocalAlignmentStringKernel.h b/src/shogun/kernel/LocalAlignmentStringKernel.h
@@ -16,7 +16,9 @@
 
 namespace shogun
 {
-const int32_t LOGSUM_TBL=10000;      /* span of the logsum table */
+
+/** span of the logsum table */
+const int32_t LOGSUM_TBL=10000;      
 
 /** @brief The LocalAlignmentString kernel compares two sequences through all
  * possible local alignments between the two sequences.

diff --git a/src/shogun/regression/KernelRidgeRegression.h b/src/shogun/regression/KernelRidgeRegression.h
@@ -57,20 +57,25 @@ class CKernelRidgeRegression : public CKernelMachine
 		/** default constructor */
 		CKernelRidgeRegression();
 
+		/** which training method to use for KRR */
 		enum ETrainingType
 		{
+			/// via pseudo inverse
 			PINV=1,
-			GS=2,
+			/// or gauss-seidel iterative method
+			GS=2
 		};
 
 		/** constructor
 		 *
 		 * @param tau regularization constant tau
 		 * @param k kernel
 		 * @param lab labels
-		 * @m method to use for training PINV (pseudo inverse by default)
+		 * @param m method to use for training PINV (pseudo inverse by default)
 		 */
 		CKernelRidgeRegression(float64_t tau, CKernel* k, CLabels* lab, ETrainingType m=PINV);
+
+		/** default destructor */
 		virtual ~CKernelRidgeRegression() {}
 
 		/** set regularization constant