Add simple doc for SGObject's typedefs

shogun-toolbox · Jan 3, 2018 · 34490ad · 34490ad
1 parent b32e658
commit 34490ad
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/shogun/base/SGObject.h b/src/shogun/base/SGObject.h
@@ -120,10 +120,13 @@ template <class T> class SGStringList;
 class CSGObject
 {
 public:
+	/** Definition of observed subject */
 	typedef rxcpp::subjects::subject<ObservedValue> SGSubject;
+	/** Definition of observable */
 	typedef rxcpp::observable<ObservedValue,
 		                      rxcpp::dynamic_observable<ObservedValue>>
 		SGObservable;
+	/** Definition of subscriber */
 	typedef rxcpp::subscriber<
 		ObservedValue, rxcpp::observer<ObservedValue, void, void, void, void>>
 		SGSubscriber;