Yet another warnings removal

shogun-toolbox · Aug 20, 2011 · 569d85e · 569d85e
1 parent 2ca6531
commit 569d85e
Show file tree

Hide file tree

Showing 19 changed files with 38 additions and 4 deletions.
diff --git a/src/shogun/base/SGObject.h b/src/shogun/base/SGObject.h
@@ -62,6 +62,7 @@ class CSerializableFile;
  * End of macros for registering parameters/model selection parameters
  ******************************************************************************/
 
+/** model selection availability */
 enum EModelSelectionAvailability {
 	MS_NOT_AVAILABLE=0, MS_AVAILABLE
 };

diff --git a/src/shogun/base/class_list.h b/src/shogun/base/class_list.h
@@ -16,6 +16,10 @@
 namespace shogun {
 	class CSGObject;
 
+	/** new shogun serializable
+	 * @param serializable_name
+	 * @param generic
+	 */
 	CSGObject* new_sgserializable(const char* sgserializable_name,
 										EPrimitiveType generic);
 }

diff --git a/src/shogun/base/init.h b/src/shogun/base/init.h
@@ -38,6 +38,7 @@ void init_shogun(void (*print_message)(FILE* target, const char* str) = NULL,
 		void (*print_error)(FILE* target, const char* str) = NULL,
 		void (*cancel_computations)(bool &delayed, bool &immediately)=NULL);
 
+/** init shogun with defaults */
 void init_shogun_with_defaults();
 
 /** This function must be called when one stops using libshogun. It will

diff --git a/src/shogun/distance/Distance.h b/src/shogun/distance/Distance.h
@@ -29,6 +29,7 @@ class CFeatures;
 enum EFeatureType;
 enum EFeatureClass;
 
+/** type of distance */
 enum EDistanceType
 {
 	D_UNKNOWN = 0,

diff --git a/src/shogun/evaluation/ContingencyTableEvaluation.h b/src/shogun/evaluation/ContingencyTableEvaluation.h
@@ -21,6 +21,7 @@ namespace shogun
 
 class CLabels;
 
+/** type of measure */
 enum EContingencyTableMeasureType
 {
 	ACCURACY = 0,

diff --git a/src/shogun/io/SGIO.h b/src/shogun/io/SGIO.h
@@ -28,6 +28,7 @@
 namespace shogun
 {
 	class SGIO;
+	/** shogun IO */
 	extern SGIO* sg_io;
 }
 

diff --git a/src/shogun/kernel/BesselKernel.h b/src/shogun/kernel/BesselKernel.h
@@ -25,9 +25,9 @@ class CDistance;
  * k(x, y) = \frac{J_{v}( \| x-y \|/\tau)}{ \| x-y \| ^ {-nv} }
  * \f]
  * Where:
- * 		J_{v} is the Bessel funcion with order v,
- * 		\tau is the kernel width, and
- * 		n is the kernel degree.
+ * 		\f$J_{v}\f$ is the Bessel funcion with order \f$v\f$,
+ * 		\f$\tau\f$ is the kernel width, and
+ * 		\f$n\f$ is the kernel degree.
  * */
 class CBesselKernel: public CDistanceKernel
 {

diff --git a/src/shogun/kernel/Kernel.h b/src/shogun/kernel/Kernel.h
@@ -113,6 +113,7 @@ enum EKernelType
 	K_BESSEL = 460,
 };
 
+/** kernel property */
 enum EKernelProperty
 {
 	KP_NONE = 0,

diff --git a/src/shogun/kernel/WaveletKernel.h b/src/shogun/kernel/WaveletKernel.h
@@ -20,11 +20,16 @@ namespace shogun
 /** the class WaveletKernel
  *
  * It is defined as
+ *
  * \f[
  * k({\bf x},({\bf x'})= \prod_{i=0}^{l}h(\frac{(x-c)}{a})\cdot h(\frac{(x'-c)}{a})
  * \f]
- * Where h(x) is the mother wavelet function
+ *
+ * Where \f$h(x)\f$ is the mother wavelet function
+ *
+ * \f[
  * h({\bf x}=cos(1.75*x)\cdot exp(\frac{(-x^2){2})
+ * \f]
  * 
  */
 class CWaveletKernel: public CDotKernel

diff --git a/src/shogun/kernel/WeightedDegreeStringKernel.h b/src/shogun/kernel/WeightedDegreeStringKernel.h
@@ -21,6 +21,7 @@
 namespace shogun
 {
 
+/** WD kernel type */
 enum EWDKernType
 {
 	E_WD=0,

diff --git a/src/shogun/lib/Compressor.h b/src/shogun/lib/Compressor.h
@@ -22,6 +22,7 @@
 
 namespace shogun
 {
+	/** compression type */
 	enum E_COMPRESSION_TYPE
 	{
 		UNCOMPRESSED,

diff --git a/src/shogun/lib/DataType.h b/src/shogun/lib/DataType.h
@@ -21,6 +21,7 @@ namespace shogun
 
 template<class T> class CCache;
 
+/** index */
 typedef int32_t index_t;
 
 /** shogun vector */

diff --git a/src/shogun/modelselection/ModelSelectionParameters.h b/src/shogun/modelselection/ModelSelectionParameters.h
@@ -19,6 +19,7 @@ namespace shogun
 
 class CParameterCombination;
 
+/** type of range */
 enum ERangeType
 {
 	R_LINEAR, R_EXP, R_LOG

diff --git a/src/shogun/regression/Regression.h b/src/shogun/regression/Regression.h
@@ -13,6 +13,7 @@
 
 namespace shogun
 {
+	/// type of regressor
 	enum ERegressionType
 	{
 		RT_NONE = 0,

diff --git a/src/shogun/ui/GUIClassifier.h b/src/shogun/ui/GUIClassifier.h
@@ -20,6 +20,7 @@ namespace shogun
 {
 class CSGInterface;
 
+/** gui classifier */
 class CGUIClassifier : public CSGObject
 {
 	public:

diff --git a/src/shogun/ui/GUIHMM.h b/src/shogun/ui/GUIHMM.h
@@ -21,6 +21,7 @@ namespace shogun
 {
 class CSGInterface;
 
+/** gui HMM */
 class CGUIHMM : public CSGObject
 {
 	public:

diff --git a/src/shogun/ui/GUIMath.h b/src/shogun/ui/GUIMath.h
@@ -18,6 +18,7 @@ namespace shogun
 {
 class CSGInterface;
 
+/** gui math */
 class CGUIMath : public CSGObject
 {
 	public:

diff --git a/src/shogun/ui/GUITime.h b/src/shogun/ui/GUITime.h
@@ -19,6 +19,7 @@ namespace shogun
 {
 class CSGInterface;
 
+/** gui time */
 class CGUITime : public CSGObject
 {
 	public:

diff --git a/src/shogun/ui/SGInterface.h b/src/shogun/ui/SGInterface.h
@@ -32,6 +32,7 @@ namespace shogun
  */
 enum IFType
 {
+	/// undefined
 	UNDEFINED,
 
 	///simple scalar/string types
@@ -86,16 +87,24 @@ enum IFType
 	ATTR_STRUCT
 };
 
+/** objective enumerate */
 enum E_WHICH_OBJ
 {
+	/// svm primal task
 	SVM_PRIMAL,
+	/// svm dual task
 	SVM_DUAL,
+	/// mkl primal task
 	MKL_PRIMAL,
+	/// mkl dual task
 	MKL_DUAL,
+	/// mkl relative duality gap
 	MKL_RELATIVE_DUALITY_GAP,
+	/// mkl absolute duality gap
 	MKL_ABSOLUTE_DUALITY_GAP
 };
 
+/** shogun interface */
 class CSGInterface : public CSGObject
 {
 	public:
@@ -1111,6 +1120,7 @@ class CSGInterface : public CSGObject
 		char* m_legacy_strptr;
 };
 
+/** sg interface ptr typedef */
 typedef bool (CSGInterface::*CSGInterfacePtr)();
 
 typedef struct {