Add simple doc for watch_param

shogun-toolbox · Jan 3, 2018 · ee3aa74 · ee3aa74
1 parent dd97dba
commit ee3aa74
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/shogun/base/SGObject.h b/src/shogun/base/SGObject.h
@@ -489,6 +489,12 @@ class CSGObject
 		create_parameter(tag, AnyParameter(erase_type(value)));
 	}
 
+	/** Puts a pointer to some parameter into the parameter map.
+	 *
+	 * @param name name of the parameter
+	 * @param value pointer to the parameter value
+	 * @param properties properties of the parameter (e.g. if model selection is supported)
+	 */
 	template <typename T>
 	void watch_param(
 		const std::string& name, T* value, AnyParameterProperties properties)