Updating VSDoc and associated files

Author: mattpodwysocki

lib/rx.jquery-vsdoc.js

@@ -25,8 +25,10 @@
         proto = $.fn;
 
     $.Deferred.prototype.toObservable = function () {
+		/// <summary>Converts a jQuery Deferred object to an Observable sequence.</summary>
+		/// <returns>An Observable sequenced defined from the jQuery Deferred object.</returns>		
         var subject = new asyncSubject();
-        parent.done(function () {
+        this.done(function () {
             subject.onNext(slice.call(arguments));
             subject.onCompleted();
         }).fail(function () {
@@ -36,6 +38,8 @@
     };
 
     observableProto.toDeferred = function () {
+		/// <summary>Converts an existing Observable sequence to a jQuery Deferred object.</summary>
+		/// <returns>A jQuery Deferred object</returns>
         var deferred = $.Deferred();
         this.subscribe(function (value) {
             deferred.resolve(value);
@@ -159,27 +163,73 @@
 		return this.bindAsObservable('scroll', eventData);
 	};		
 	proto.selectAsObservable = function(eventData) {
+		/// <summary>
+		///     Bind an event handler to the "select" JavaScript event, or trigger that event on an element as an Observable sequence.
+		///     &#10;1 - selectAsObservable() 
+		///     &#10;2 - selectAsObservable(eventData) 
+		/// </summary>
+		/// <param name="data" type="Object">
+		///     A map of data that will be passed to the event handler.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		return this.bindAsObservable('select', eventData);
 	};	
 	proto.submitAsObservable = function(eventData) {
+		/// <summary>
+		///     Bind an event handler to the "submit" JavaScript event, or trigger that event on an element as an Observable sequence.
+		///     &#10;1 - submitAsObservable() 
+		///     &#10;2 - submitAsObservable(eventData) 
+		/// </summary>
+		/// <param name="data" type="Object">
+		///     A map of data that will be passed to the event handler.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		return this.bindAsObservable('submit', eventData);
 	};
 	proto.unloadAsObservable = function(eventData) {
+		/// <summary>
+		///     Bind an event handler to the "unload" JavaScript event as an Observable sequence.
+		///     &#10;1 - unloadAsObservable() 
+		///     &#10;2 - unloadAsObservable(eventData)
+		/// </summary>
+		/// <param name="data" type="Object">
+		///     A map of data that will be passed to the event handler.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		return this.bindAsObservable('unload', eventData);
 	};	
-    proto.oneAsObservable = function(eventType, eventData) {
+    proto.oneAsObservable = function(types, selector, data) {
+		/// <summary>
+		///     Attach a handler to an event for the elements as an Observable sequence.. The Observer onNext handler is executed at most once per element.
+		///     &#10;1 - oneAsObservable(events, data) 
+		///     &#10;2 - oneAsObservable(events, selector, data) 
+		/// </summary>
+		/// <param name="types" type="String">
+		///     One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
+		/// </param>
+		/// <param name="selector" type="String">
+		///     A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
+		/// </param>
+		/// <param name="data" type="Anything">
+		///     Data to be passed to the handler in event.data when an event is triggered.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		var parent = this;
         return observableCreateWithDisposable(function(observer) {
 			var handler = function(eventObject) {
-				parent.unbind(eventType, handler);
+				parent.off(types, selector, data, handler);
                 observer.onNext(eventObject);
 				observer.onCompleted();			
             };
-            parent.bind(eventType, eventData, handler);
+            parent.on(types, selector, data, handler);
             return dispoableEmpty;
         });
     };
     proto.readyAsObservable = function() {
+		/// <summary>
+		///     Specify a function to execute when the DOM is fully loaded as an Observable sequence.
+		/// </summary>
+		/// <returns>An Observable sequence</returns>
 		var parent = this;
         return observableCreateWithDisposable(function(observer) {
 			var handler = function(eventObject) {
@@ -189,15 +239,41 @@
             return dispoableEmpty;
         });
     };	
-    proto.hideAsObservable = function(duration) {
+    proto.hideAsObservable = function(duration, easing) {
+		/// <summary>
+		///     Hide the matched elements as an Observable sequence.
+		///     &#10;1 - hideAsObservable() 
+		///     &#10;2 - hideAsObservable(duration) 
+		///     &#10;3 - hideAsObservable(duration, easing)
+		/// </summary>
+		/// <param name="speed" type="Number">
+		///     A string or number determining how long the animation will run.
+		/// </param>
+		/// <param name="easing" type="String">
+		///     A string indicating which easing function to use for the transition.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		var subject = new asyncSubject();
-        this.hide(duration, function() {
+        this.hide(duration, easing, function() {
             subject.onNext(this);
             subject.onCompleted();
         });
         return subject;
     };
-    proto.showAsObservable = function(duration) {
+    proto.showAsObservable = function(duration, easing) {
+		/// <summary>
+		///     Display the matched elements as an Observable sequence.
+		///     &#10;1 - showAsObservable() 
+		///     &#10;2 - showAsObservable(duration) 
+		///     &#10;3 - showAsObservable(duration, easing)
+		/// </summary>
+		/// <param name="speed" type="Number">
+		///     A string or number determining how long the animation will run.
+		/// </param>
+		/// <param name="easing" type="String">
+		///     A string indicating which easing function to use for the transition.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		var subject = new asyncSubject();
         this.show(duration, function() {
             subject.onNext(this);
@@ -206,38 +282,101 @@
         return subject;
     };
     proto.animateAsObservable = function(properties, duration, easing) {
+		/// <summary>
+		///     Perform a custom animation of a set of CSS properties as an Observable sequence.
+		///     &#10;1 - animate(properties, duration, easing) 
+		/// </summary>
+		/// <param name="prop" type="Object">
+		///     A map of CSS properties that the animation will move toward.
+		/// </param>
+		/// <param name="speed" type="Number">
+		///     A string or number determining how long the animation will run.
+		/// </param>
+		/// <param name="easing" type="String">
+		///     A string indicating which easing function to use for the transition.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		var subject = new asyncSubject();
         this.animate(properties, duration, easing, function() {
             subject.onNext(this);
             subject.onCompleted();
         });
         return subject;
     };
-    proto.fadeInAsObservable = function(duration) {
+    proto.fadeInAsObservable = function(duration, easing) {
+		/// <summary>
+		///     Display the matched elements by fading them to opaque as an Observable sequence.
+		///     &#10;1 - fadeInAsObservable(duration) 
+		///     &#10;2 - fadeInAsObservable(duration, easing)
+		/// </summary>
+		/// <param name="speed" type="Number">
+		///     A string or number determining how long the animation will run.
+		/// </param>
+		/// <param name="easing" type="String">
+		///     A string indicating which easing function to use for the transition.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		var subject = new asyncSubject();
-        this.fadeIn(duration, function() {
+        this.fadeIn(duration, easing, function() {
             subject.onNext(this);
             subject.onCompleted();
         });
         return subject;
     };
-    proto.fadeToAsObservable = function(duration, opacity) {
+    proto.fadeToAsObservable = function(duration, opacity, easing) {
+		/// <summary>
+		///     Adjust the opacity of the matched elements as an Observable sequence.
+		///     &#10;1 - fadeToAsObservable(duration, opacity) 
+		///     &#10;2 - fadeToAsObservable(duration, opacity, easing)
+		/// </summary>
+		/// <param name="speed" type="Number">
+		///     A string or number determining how long the animation will run.
+		/// </param>
+		/// <param name="to" type="Number">
+		///     A number between 0 and 1 denoting the target opacity.
+		/// </param>
+		/// <param name="easing" type="String">
+		///     A string indicating which easing function to use for the transition.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		var subject = new asyncSubject();
-        this.fadeTo(duration, opacity, function() {
+        this.fadeTo(duration, opacity, easing, function() {
             subject.onNext(this);
             subject.onCompleted();
         });
         return subject;
     };
-    proto.fadeOutAsObservable = function(duration) {
+    proto.fadeOutAsObservable = function(duration, easing) {
+		/// <summary>
+		///     Hide the matched elements by fading them to transparent.
+		///     &#10;1 - fadeOutAsObservable(duration) 
+		///     &#10;2 - fadeOutAsObservable(duration, easing)
+		/// </summary>
+		/// <param name="speed" type="Number">
+		///     A string or number determining how long the animation will run.
+		/// </param>
+		/// <param name="easing" type="String">
+		///     A string indicating which easing function to use for the transition.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
 		var subject = new asyncSubject();
-        this.fadeOut(duration, function() {
+        this.fadeOut(duration, easing, function() {
             subject.onNext(this);
             subject.onCompleted();
         });
         return subject;
     };
     proto.fadeToggleAsObservable = function(duration, easing) {
+		/// <summary>
+		///     Display or hide the matched elements by animating their opacity as an Observable sequence.
+		/// </summary>
+		/// <param name="speed" type="Number">
+		///     A string or number determining how long the animation will run.
+		/// </param>
+		/// <param name="easing" type="String">
+		///     A string indicating which easing function to use for the transition.
+		/// </param>
+		/// <returns>An Observable sequence</returns>
         var subject = new asyncSubject();
         this.fadeToggle(duration, easing, function() {
             subject.onNext(this);

lib/rx.jquery.js

@@ -167,15 +167,15 @@
 	proto.unloadAsObservable = function(eventData) {
 		return this.bindAsObservable('unload', eventData);
 	};	
-    proto.oneAsObservable = function(eventType, eventData) {
+    proto.oneAsObservable = function(types, selector, data) {
 		var parent = this;
         return observableCreateWithDisposable(function(observer) {
 			var handler = function(eventObject) {
-				parent.unbind(eventType, handler);
+				parent.off(types, selector, data, handler);
                 observer.onNext(eventObject);
 				observer.onCompleted();			
             };
-            parent.bind(eventType, eventData, handler);
+            parent.on(types, selector, data, handler);
             return dispoableEmpty;
         });
     };
@@ -197,7 +197,7 @@
         });
         return subject;
     };
-    proto.showAsObservable = function(duration) {
+    proto.showAsObservable = function(duration, easing) {
 		var subject = new asyncSubject();
         this.show(duration, function() {
             subject.onNext(this);
@@ -213,25 +213,25 @@
         });
         return subject;
     };
-    proto.fadeInAsObservable = function(duration) {
+    proto.fadeInAsObservable = function(duration, easing) {
 		var subject = new asyncSubject();
-        this.fadeIn(duration, function() {
+        this.fadeIn(duration, easing, function() {
             subject.onNext(this);
             subject.onCompleted();
         });
         return subject;
     };
-    proto.fadeToAsObservable = function(duration, opacity) {
+    proto.fadeToAsObservable = function(duration, opacity, easing) {
 		var subject = new asyncSubject();
-        this.fadeTo(duration, opacity, function() {
+        this.fadeTo(duration, opacity, easing, function() {
             subject.onNext(this);
             subject.onCompleted();
         });
         return subject;
     };
-    proto.fadeOutAsObservable = function(duration) {
+    proto.fadeOutAsObservable = function(duration, easing) {
 		var subject = new asyncSubject();
-        this.fadeOut(duration, function() {
+        this.fadeOut(duration, easing, function() {
             subject.onNext(this);
             subject.onCompleted();
         });