Merge pull request #696 from iglesias/master

A few warnings fixed
shogun-toolbox · Aug 8, 2012 · ac8c5ba · ac8c5ba
2 parents f342b7d + 8c1eeea
commit ac8c5ba
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 13 deletions.
diff --git a/src/shogun/base/DynArray.h b/src/shogun/base/DynArray.h
@@ -382,17 +382,17 @@ template <class T> class DynArray
 		 *
 		 * @param p_array new array
 		 * @param p_num_elements last element index + 1
-		 * @param array_size number of elements in array
+		 * @param p_array_size number of elements in array
 		 * @param p_free_array if array must be freed
 		 * @param p_copy_array if array must be copied
 		 */
 		inline void set_array(T* p_array, int32_t p_num_elements,
-							  int32_t p_array_size, bool p_free_array, bool copy_array)
+				int32_t p_array_size, bool p_free_array, bool p_copy_array)
 		{
 			if (array!=NULL && free_array)
 				SG_FREE(array);
 
-			if (copy_array)
+			if (p_copy_array)
 			{
 				if (use_sg_mallocs)
 					array=SG_MALLOC(T, p_array_size);
@@ -412,7 +412,7 @@ template <class T> class DynArray
 		 *
 		 * @param p_array new array
 		 * @param p_num_elements last element index + 1
-		 * @param array_size number of elements in array
+		 * @param p_array_size number of elements in array
 		 */
 		inline void set_array(const T* p_array, int32_t p_num_elements,
 							  int32_t p_array_size)

diff --git a/src/shogun/labels/StructuredLabels.h b/src/shogun/labels/StructuredLabels.h
@@ -19,6 +19,7 @@
 
 namespace shogun {
 
+/** @brief Base class of the labels used in Structured Output (SO) problems */
 class CStructuredLabels : public CLabels
 {
 

diff --git a/src/shogun/lib/DynamicArray.h b/src/shogun/lib/DynamicArray.h
@@ -51,9 +51,9 @@ template <class T> class CDynamicArray :public CSGObject
 
 		/** constructor
 		 *
-		 * @param dim1 dimension 1
-		 * @param dim2 dimension 2
-		 * @param dim3 dimension 3
+		 * @param p_dim1_size dimension 1
+		 * @param p_dim2_size dimension 2
+		 * @param p_dim3_size dimension 3
 		 */
 		CDynamicArray(int32_t p_dim1_size, int32_t p_dim2_size=1, int32_t p_dim3_size=1)
 		: CSGObject(), m_array(p_dim1_size*p_dim2_size*p_dim3_size), name("Array")
@@ -368,7 +368,7 @@ template <class T> class CDynamicArray :public CSGObject
 		/** insert array element at index
 		 *
 		 * @param e element to insert
-		 * @param indx index
+		 * @param index index
 		 * @return if setting was successful
 		 */
 		inline bool insert_element(T e, int32_t index)
@@ -389,7 +389,7 @@ template <class T> class CDynamicArray :public CSGObject
 		/** STD VECTOR compatible. Append array element to the end
 		 *  of array.
 		 *
-		 * @param element element to append
+		 * @param e element to append
 		 */
 		inline void push_back(T e)
 		{ m_array.push_back(e); }

diff --git a/src/shogun/lib/DynamicObjectArray.h b/src/shogun/lib/DynamicObjectArray.h
@@ -313,7 +313,7 @@ class CDynamicObjectArray : public CSGObject
 		/** STD VECTOR compatible. Append array element to the end
 		 *  of array.
 		 *
-		 * @param element element to append
+		 * @param e element to append
 		 */
 		inline void push_back(CSGObject* e)
 		{
@@ -347,7 +347,7 @@ class CDynamicObjectArray : public CSGObject
 		/** find first occurence of array element and return its index
 		 * or -1 if not available
 		 *
-		 * @param element element to search for
+		 * @param elem element to search for
 		 * @return index of element or -1
 		 */
 		inline int32_t find_element(CSGObject* elem) const

diff --git a/src/shogun/lib/StructuredData.h b/src/shogun/lib/StructuredData.h
@@ -17,6 +17,7 @@
 namespace shogun
 {
 
+/** @brief Base class of the components of StructuredLabels */
 class CStructuredData : public CSGObject
 {
 

diff --git a/src/shogun/structure/MulticlassModel.h b/src/shogun/structure/MulticlassModel.h
@@ -65,7 +65,6 @@ class CMulticlassModel : public CStructuredModel
 
 		/** computes \f$ \Delta(y_{\text{true}}, y_{\text{pred}}) \f$
 		 *
-		 * @param labels true labels
 		 * @param ytrue_idx index of the true label in labels
 		 * @param ypred the predicted label
 		 *

diff --git a/src/shogun/structure/StructuredModel.h b/src/shogun/structure/StructuredModel.h
@@ -147,7 +147,6 @@ class CStructuredModel : public CSGObject
 
 		/** computes \f$ \Delta(y_{\text{true}}, y_{\text{pred}}) \f$
 		 *
-		 * @param labels true labels
 		 * @param ytrue_idx index of the true label in labels
 		 * @param ypred the predicted label
 		 *