Fixes + comments.

schlangster · schlangster · commit bfc7d4a45efd · 2014-05-20T23:41:49.000+02:00
diff --git a/include/react/Algorithm.h b/include/react/Algorithm.h
@@ -37,7 +37,7 @@ template <typename D, typename ... TValues>
 class SignalPack;
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
-/// Iterate
+/// Iterate - Iteratively combines signal value with values from event stream
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 template
 <
@@ -77,7 +77,8 @@ template
     typename ... TDepValues,
     typename S = std::decay<V>::type
 >
-auto Iterate(const Events<D,E>& events, V&& init, SignalPack<D,TDepValues...> depPack, FIn&& func)
+auto Iterate(const Events<D,E>& events, V&& init,
+             const SignalPack<D,TDepValues...>& depPack, FIn&& func)
     -> Signal<D,S>
 {
     using REACT_IMPL::SyncedIterateNode;
@@ -118,7 +119,7 @@ auto Iterate(const Events<D,E>& events, V&& init, SignalPack<D,TDepValues...> de
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
-/// Hold
+/// Hold - Hold the most recent event in a signal
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 template
 <
@@ -137,7 +138,7 @@ auto Hold(const Events<D,T>& events, V&& init)
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
-/// Snapshot
+/// Snapshot - Sets signal value to value of other signal when event is received
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 template
 <
@@ -156,7 +157,7 @@ auto Snapshot(const Events<D,E>& trigger, const Signal<D,S>& target)
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
-/// Monitor
+/// Monitor - Emits value changes of target signal
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 template
 <
@@ -174,7 +175,7 @@ auto Monitor(const Signal<D,S>& target)
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
-/// Pulse
+/// Pulse - Emits value of target signal when event is received
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 template
 <
@@ -193,7 +194,7 @@ auto Pulse(const Events<D,E>& trigger, const Signal<D,S>& target)
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
-/// OnChanged
+/// OnChanged - Emits token when target signal was changed
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 template
 <
@@ -207,7 +208,7 @@ auto OnChanged(const Signal<D,S>& target)
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
-/// OnChangedTo
+/// OnChangedTo - Emits token when target signal was changed to value
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 template
 <
diff --git a/include/react/Observer.h b/include/react/Observer.h
@@ -164,7 +164,7 @@ template
     typename ... TDepValues
 >
 auto Observe(const Events<D,E>& subject,
-             SignalPack<D,TDepValues...> depPack, FIn&& func)
+             const SignalPack<D,TDepValues...>& depPack, FIn&& func)
     -> Observer<D>
 {
     using REACT_IMPL::IObserver;

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ template <typename D, typename ... TValues>`
`37`	`37`	`class SignalPack;`
`38`	`38`
`39`	`39`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`40`		`-/// Iterate`
	`40`	`+/// Iterate - Iteratively combines signal value with values from event stream`
`41`	`41`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`42`	`42`	`template`
`43`	`43`	`<`
`@@ -77,7 +77,8 @@ template`
`77`	`77`	`typename ... TDepValues,`
`78`	`78`	`typename S = std::decay<V>::type`
`79`	`79`	`>`
`80`		`-auto Iterate(const Events<D,E>& events, V&& init, SignalPack<D,TDepValues...> depPack, FIn&& func)`
	`80`	`+auto Iterate(const Events<D,E>& events, V&& init,`
	`81`	`+ const SignalPack<D,TDepValues...>& depPack, FIn&& func)`
`81`	`82`	`-> Signal<D,S>`
`82`	`83`	`{`
`83`	`84`	`using REACT_IMPL::SyncedIterateNode;`
`@@ -118,7 +119,7 @@ auto Iterate(const Events<D,E>& events, V&& init, SignalPack<D,TDepValues...> de`
`118`	`119`	`}`
`119`	`120`
`120`	`121`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`121`		`-/// Hold`
	`122`	`+/// Hold - Hold the most recent event in a signal`
`122`	`123`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`123`	`124`	`template`
`124`	`125`	`<`
`@@ -137,7 +138,7 @@ auto Hold(const Events<D,T>& events, V&& init)`
`137`	`138`	`}`
`138`	`139`
`139`	`140`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`140`		`-/// Snapshot`
	`141`	`+/// Snapshot - Sets signal value to value of other signal when event is received`
`141`	`142`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`142`	`143`	`template`
`143`	`144`	`<`
`@@ -156,7 +157,7 @@ auto Snapshot(const Events<D,E>& trigger, const Signal<D,S>& target)`
`156`	`157`	`}`
`157`	`158`
`158`	`159`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`159`		`-/// Monitor`
	`160`	`+/// Monitor - Emits value changes of target signal`
`160`	`161`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`161`	`162`	`template`
`162`	`163`	`<`
`@@ -174,7 +175,7 @@ auto Monitor(const Signal<D,S>& target)`
`174`	`175`	`}`
`175`	`176`
`176`	`177`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`177`		`-/// Pulse`
	`178`	`+/// Pulse - Emits value of target signal when event is received`
`178`	`179`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`179`	`180`	`template`
`180`	`181`	`<`
`@@ -193,7 +194,7 @@ auto Pulse(const Events<D,E>& trigger, const Signal<D,S>& target)`
`193`	`194`	`}`
`194`	`195`
`195`	`196`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`196`		`-/// OnChanged`
	`197`	`+/// OnChanged - Emits token when target signal was changed`
`197`	`198`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`198`	`199`	`template`
`199`	`200`	`<`
`@@ -207,7 +208,7 @@ auto OnChanged(const Signal<D,S>& target)`
`207`	`208`	`}`
`208`	`209`
`209`	`210`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`210`		`-/// OnChangedTo`
	`211`	`+/// OnChangedTo - Emits token when target signal was changed to value`
`211`	`212`	`///////////////////////////////////////////////////////////////////////////////////////////////////`
`212`	`213`	`template`
`213`	`214`	`<`
Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ template`
`164`	`164`	`typename ... TDepValues`
`165`	`165`	`>`
`166`	`166`	`auto Observe(const Events<D,E>& subject,`
`167`		`- SignalPack<D,TDepValues...> depPack, FIn&& func)`
	`167`	`+ const SignalPack<D,TDepValues...>& depPack, FIn&& func)`
`168`	`168`	`-> Observer<D>`
`169`	`169`	`{`
`170`	`170`	`using REACT_IMPL::IObserver;`