Removed a few doc warnings

shogun-toolbox · May 26, 2012 · 676b942 · 676b942
1 parent 817fb76
commit 676b942
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/src/shogun/kernel/Kernel.cpp b/src/shogun/kernel/Kernel.cpp
@@ -752,6 +752,7 @@ void CKernel::list_kernel()
 		ENUM_CASE(K_BESSEL)
 		ENUM_CASE(K_JENSENSHANNON)
 		ENUM_CASE(K_DIRECTOR)
+		ENUM_CASE(K_PRODUCT)
 	}
 
 	switch (get_feature_class())

diff --git a/src/shogun/machine/Machine.h b/src/shogun/machine/Machine.h
@@ -100,7 +100,11 @@ enum EProblemType
 	PT_MULTICLASS = 2
 };
 
-#define MACHINE_PROBLEM_TYPE(PT) inline virtual EProblemType get_machine_problem_type() const { return PT; }
+#define MACHINE_PROBLEM_TYPE(PT) \
+	/** returns default problem type machine solves \
+	 * @return problem type\
+	 */ \
+	virtual EProblemType get_machine_problem_type() const { return PT; }
 
 /** @brief A generic learning machine interface.
  *
@@ -147,9 +151,13 @@ class CMachine : public CSGObject
 		 */
 		virtual CLabels* apply(CFeatures* data=NULL);
 
+		/** apply machine to data in means of binary classification problem */
 		virtual CBinaryLabels* apply_binary(CFeatures* data=NULL);
+		/** apply machine to data in means of regression problem */
 		virtual CRegressionLabels* apply_regression(CFeatures* data=NULL);
+		/** apply machine to data in means of multiclass classification problem */
 		virtual CMulticlassLabels* apply_multiclass(CFeatures* data=NULL);
+
 		/** set labels
 		 *
 		 * @param lab labels

diff --git a/src/shogun/transfer/domain_adaptation/DomainAdaptationMulticlassLibLinear.h b/src/shogun/transfer/domain_adaptation/DomainAdaptationMulticlassLibLinear.h
@@ -48,13 +48,31 @@ class CDomainAdaptationMulticlassLibLinear : public CMulticlassLibLinear
 			return "DomainAdaptationMulticlassLibLinear";
 		}
 
+		/** getter for source bias 
+		 * @return source bias
+		 */
 		float64_t get_source_bias() const;
+		/** setter for source bias
+		 * @param source_bias source bias
+		 */
 		void set_source_bias(float64_t source_bias);
 
+		/** getter for train factor
+		 * @return train factor
+		 */
 		float64_t get_train_factor() const;
+		/** setter for train factor
+		 * @param train_factor train factor
+		 */
 		void set_train_factor(float64_t train_factor);
 
+		/** getter for source machine
+		 * @return source machine
+		 */
 		CLinearMulticlassMachine* get_source_machine() const;
+		/** setter for source machine
+		 * @param source_machine source machine
+		 */
 		void set_source_machine(CLinearMulticlassMachine* source_machine);
 
 protected: