[FIX] docstring
authorXavier Morel <xmo@openerp.com>
Fri, 1 Mar 2013 10:22:23 +0000 (11:22 +0100)
committerXavier Morel <xmo@openerp.com>
Fri, 1 Mar 2013 10:22:23 +0000 (11:22 +0100)
bzr revid: xmo@openerp.com-20130301102223-htb9cteh5rjmex38

addons/web/static/src/js/corelib.js

index bb74369..bfde707 100644 (file)
@@ -232,13 +232,17 @@ instance.web.ParentedMixin = {
         Utility method to only execute asynchronous actions if the current
         object has not been destroyed.
 
-        @param {Promise} promise The promise representing the asynchronous action.
-        @param {bool} reject Defaults to false. If true, the returned promise will be
-            rejected with no arguments if the current object is destroyed. If false,
-            the returned promise will never be resolved nor rejected.
-        @returns {Promise} A promise that will mirror the given promise if everything goes
-            fine but will either be rejected with no arguments or never resolved if the
-            current object is destroyed.
+        @param {$.Deferred} promise The promise representing the asynchronous
+                                    action.
+        @param {bool} [reject=false] If true, the returned promise will be
+                                     rejected with no arguments if the current
+                                     object is destroyed. If false, the
+                                     returned promise will never be resolved
+                                     or rejected.
+        @returns {$.Deferred} A promise that will mirror the given promise if
+                              everything goes fine but will either be rejected
+                              with no arguments or never resolved if the
+                              current object is destroyed.
     */
     alive: function(promise, reject) {
         var def = $.Deferred();