From c5dacd450bc5d8f889a48957a2e2494890e86c2a Mon Sep 17 00:00:00 2001 From: Steven Kirk Date: Sun, 27 Mar 2016 23:47:52 +0200 Subject: [PATCH] GetObservable documentation. --- src/Perspex.Base/PerspexObjectExtensions.cs | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/Perspex.Base/PerspexObjectExtensions.cs b/src/Perspex.Base/PerspexObjectExtensions.cs index fcb4e8dc32..6e23a470ae 100644 --- a/src/Perspex.Base/PerspexObjectExtensions.cs +++ b/src/Perspex.Base/PerspexObjectExtensions.cs @@ -21,7 +21,10 @@ namespace Perspex /// /// The object. /// The property. - /// An observable. + /// + /// An observable which fires immediately with the current value of the property on the + /// object and subsequently each time the property value changes. + /// public static IObservable GetObservable(this IPerspexObject o, PerspexProperty property) { Contract.Requires(o != null); @@ -56,7 +59,10 @@ namespace Perspex /// The object. /// The property type. /// The property. - /// An observable. + /// + /// An observable which fires immediately with the current value of the property on the + /// object and subsequently each time the property value changes. + /// public static IObservable GetObservable(this IPerspexObject o, PerspexProperty property) { Contract.Requires(o != null); @@ -73,7 +79,8 @@ namespace Perspex /// The property. /// /// An observable which when subscribed pushes the old and new values of the property each - /// time it is changed. + /// time it is changed. Note that the observable returned from this method does not fire + /// with the current value of the property immediately. /// public static IObservable> GetObservableWithHistory( this IPerspexObject o,