fix documentation

shogun-toolbox · Oct 14, 2011 · 85b2e68 · 85b2e68
1 parent 87344b7
commit 85b2e68
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/src/shogun/converter/Converter.h b/src/shogun/converter/Converter.h
@@ -24,13 +24,16 @@ namespace shogun
 class CConverter : public CSGObject
 {
 public:
-	/* constructor */
+	/** constructor */
 	CConverter() : CSGObject() {};
-	/* destructor */
+
+	/** destructor */
 	virtual ~CConverter() {};
-	/* get name */
+
+	/** get name */
 	virtual const char* get_name() const { return "Converter"; }
-	/* applies to the given data, returning converted features 
+
+	/** applies to the given data, returning converted features 
 	 * (e.g. dense embedding of string features)
 	 * @param features features to convert
 	 * @return converted features

diff --git a/src/shogun/preprocessor/DimensionReductionPreprocessor.h b/src/shogun/preprocessor/DimensionReductionPreprocessor.h
@@ -31,13 +31,17 @@ class CDimensionReductionPreprocessor: public CSimplePreprocessor<float64_t>
 {
 public:
 
-	/* constructor */
+	/** default constructor */
 	CDimensionReductionPreprocessor();
 
-	/* constructor */
+	/** convenience constructor converting any embeddingconverter into a
+	 * dimensionreduction preprocessor
+	 *
+	 * @param converter embedding converter
+	 */
 	CDimensionReductionPreprocessor(CEmbeddingConverter* converter);
 
-	/* destructor */
+	/** destructor */
 	virtual ~CDimensionReductionPreprocessor();
 
 	/** init