A few doc fixes

shogun-toolbox · Aug 12, 2012 · 5598224 · 5598224
1 parent 5206ce1
commit 5598224
Show file tree

Hide file tree

Showing 14 changed files with 33 additions and 14 deletions.
diff --git a/src/shogun/classifier/svm/OnlineSVMSGD.h b/src/shogun/classifier/svm/OnlineSVMSGD.h
@@ -33,6 +33,7 @@ namespace shogun
 class COnlineSVMSGD : public COnlineLinearMachine
 {
 	public:
+		/** returns type of problem machine solves */
 		MACHINE_PROBLEM_TYPE(PT_BINARY);
 
 		/** default constructor  */

diff --git a/src/shogun/kernel/GaussianKernel.h b/src/shogun/kernel/GaussianKernel.h
@@ -132,9 +132,9 @@ class CGaussianKernel: public CDotKernel
 
 		/** return derivative with respect to specified parameter
 		 * 
-		 * @param  param the parameter
+		 * @param param the parameter
 		 * @param obj the object that owns the parameter
-		 * @index index the index of the element if parameter is a vector
+		 * @param index index the index of the element if parameter is a vector
 		 *
 		 * @return gradient with respect to parameter
 		 */

diff --git a/src/shogun/lib/IndexBlockRelation.h b/src/shogun/lib/IndexBlockRelation.h
@@ -16,13 +16,15 @@
 namespace shogun
 {
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 enum EIndexBlockRelationType
 {
 	GROUP,
 	TREE
 };
+#endif
 
-/** @brief
+/** @brief class IndexBlockRelation
  *
  */
 class CIndexBlockRelation : public CSGObject
@@ -47,6 +49,7 @@ class CIndexBlockRelation : public CSGObject
 
 protected:
 
+	/** check list of blocks */
 	bool check_blocks_list(CList* blocks);
 
 };

diff --git a/src/shogun/lib/IndexBlockTree.h b/src/shogun/lib/IndexBlockTree.h
@@ -53,15 +53,20 @@ class CIndexBlockTree : public CIndexBlockRelation
 	 */
 	virtual SGVector<index_t> get_SLEP_ind();
 
+	/** returns information about blocks in
+	 * SLEP "G" format
+	 */
 	virtual SGVector<float64_t> get_SLEP_G();
 
 	/** returns information about blocks relations
 	 * in SLEP "ind_t" format
 	 */
 	virtual SGVector<float64_t> get_SLEP_ind_t() const;
 
+	/** returns relation type */
 	virtual EIndexBlockRelationType get_relation_type() const { return TREE; }
 
+	/** whether relation is general, i.e. not well ordered */
 	bool is_general() const;
 
 	/** get name */

diff --git a/src/shogun/machine/Machine.h b/src/shogun/machine/Machine.h
@@ -275,8 +275,8 @@ class CMachine : public CSGObject
 		/** @return whether this machine is locked */
 		bool is_data_locked() const { return m_data_locked; }
 
-		//TODO change to pure virtual
-		inline virtual EProblemType get_machine_problem_type() const
+		/** returns type of problem machine solves */
+		virtual EProblemType get_machine_problem_type() const
 		{
 			SG_NOTIMPLEMENTED;
 			return PT_BINARY;

diff --git a/src/shogun/modelselection/ModelSelection.h b/src/shogun/modelselection/ModelSelection.h
@@ -33,7 +33,7 @@ class CModelSelection: public CSGObject
 public:
 	/** constructor
 	 * @param model_parameters parameter tree with model parameters to optimize
-	 * @param cross_validation cross-validation instance to use for evaluation
+	 * @param machine_eval machine evaluation instance to use for evaluation
 	 * of a certain combination of parameters
 	 */
 	CModelSelection(CModelSelectionParameters* model_parameters,

diff --git a/src/shogun/modelselection/ModelSelectionParameters.h b/src/shogun/modelselection/ModelSelectionParameters.h
@@ -126,7 +126,7 @@ class CModelSelectionParameters: public CSGObject
 	 * The choice of values may be random. If not, the lowest possible
 	 * values are chosen.
 	 *
-	 * @param bool Is our choice random?
+	 * @param rand is our choice random?
 	 *
 	 * @return parameter tree of random parameter values.
 	 */

diff --git a/src/shogun/modelselection/ParameterCombination.h b/src/shogun/modelselection/ParameterCombination.h
@@ -266,7 +266,9 @@ friend class CModelSelectionParameters;
 	void init();
 
 protected:
+	/** parameter */
 	Parameter* m_param;
+	/** child nodes */
 	CDynamicObjectArray* m_child_nodes;
 };
 }

diff --git a/src/shogun/multiclass/tree/ConditionalProbabilityTree.cpp b/src/shogun/multiclass/tree/ConditionalProbabilityTree.cpp
@@ -143,7 +143,7 @@ bool CConditionalProbabilityTree::train_machine(CFeatures* data)
 void CConditionalProbabilityTree::print_tree()
 {
 	if (m_root)
-		m_root->debug_print(ConditionalProbabilityTreeNodeData::print);
+		m_root->debug_print(ConditionalProbabilityTreeNodeData::print_data);
 	else
 		printf("Empty Tree\n");
 }

diff --git a/src/shogun/multiclass/tree/ConditionalProbabilityTreeNodeData.h b/src/shogun/multiclass/tree/ConditionalProbabilityTreeNodeData.h
@@ -21,7 +21,7 @@ struct ConditionalProbabilityTreeNodeData
 
 	ConditionalProbabilityTreeNodeData():label(-1), p_right(0) {}
 
-	static void print(const ConditionalProbabilityTreeNodeData &data)
+	static void print_data(const ConditionalProbabilityTreeNodeData &data)
 	{
 		SG_SPRINT("label=%d\n", data.label);
 	}

diff --git a/src/shogun/regression/gp/ExactInferenceMethod.h b/src/shogun/regression/gp/ExactInferenceMethod.h
@@ -26,14 +26,14 @@ namespace shogun
  *  /f]
  *
  *	L is the cholesky decomposition of K, the covariance matrix, plus
- *	a diagonal matrix with entries $\sigma$, the observation noise.
+ *	a diagonal matrix with entries \f$\sigma\f$, the observation noise.
  *
  *  /f[
  *  	\boldsymbol{\alpha} = L^{T} \backslash(L \backslash \boldsymbol{y}})
  *  /f]
  *
- *  Where L is the matrix mentioned above, $\boldsymbol{y}$ are the labels, and
- *  $\backslash$ is an operator ($x = A \backslash B$ means Ax=B.)
+ *  Where \f$L\f$ is the matrix mentioned above, \f$\boldsymbol{y}\f$ are the labels, and
+ *  \f$\backslash\f$ is an operator (\f$x = A \backslash B\f$ means \f$Ax=B\f$.)
  *
  *
  *

diff --git a/src/shogun/regression/svr/LibLinearRegression.h b/src/shogun/regression/svr/LibLinearRegression.h
@@ -49,11 +49,13 @@ class CLibLinearRegression : public CLinearMachine
 		/** destructor */
 		virtual ~CLibLinearRegression();
 
+		/** returns regression type */
 		inline LIBLINEAR_REGRESSION_TYPE get_liblinear_regression_type()
 		{
 			return m_liblinear_regression_type;
 		}
 
+		/** sets regression type */
 		inline void set_liblinear_regression_type(LIBLINEAR_REGRESSION_TYPE st)
 		{
 			m_liblinear_regression_type=st;

diff --git a/src/shogun/ui/GUIClassifier.cpp b/src/shogun/ui/GUIClassifier.cpp
@@ -228,12 +228,12 @@ bool CGUIClassifier::new_classifier(char* name, int32_t d, int32_t from_d)
 		SG_INFO("created SVRlibsvm object\n") ;
 	}
 #ifdef HAVE_LAPACK
-	else if (strcmp(name, "KRR")==0)
+	else if (strcmp(name, "KernelRidgeRegression")==0)
 	{
 		SG_UNREF(classifier);
 		classifier=new CKernelRidgeRegression(krr_tau, ui->ui_kernel->get_kernel(),
 			ui->ui_labels->get_train_labels());
-		SG_INFO("created KRR object %p\n", classifier);
+		SG_INFO("created KernelRidgeRegression object %p\n", classifier);
 	}
 #endif //HAVE_LAPACK
 	else if (strcmp(name,"PERCEPTRON")==0)

diff --git a/src/shogun/ui/GUILabels.h b/src/shogun/ui/GUILabels.h
@@ -57,6 +57,12 @@ class CGUILabels : public CSGObject
 		 */
 		bool save(char* param);
 
+		/** infer labels from array 
+		 *
+		 * @param lab array
+		 * @param len length of array
+		 * @return labels
+		 */
 		CLabels* infer_labels(float64_t* lab, int32_t len);
 
 		/** @return object name */