diff options
| author | Xavier Morel <xmo@openerp.com> | 2013-03-01 11:22:23 +0100 |
|---|---|---|
| committer | Xavier Morel <xmo@openerp.com> | 2013-03-01 11:22:23 +0100 |
| commit | ed9841844103ec6de21d8e42d121c695b74a42ca (patch) | |
| tree | 8ab61c6d6a9f8880ae8636d2dfb272a514b7914e /addons/web/static/src/js/corelib.js | |
| parent | ecd14f2181f06966eefd7a3f9c4e399830c6518a (diff) | |
[FIX] docstring
bzr revid: xmo@openerp.com-20130301102223-htb9cteh5rjmex38
Diffstat (limited to 'addons/web/static/src/js/corelib.js')
| -rw-r--r-- | addons/web/static/src/js/corelib.js | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/addons/web/static/src/js/corelib.js b/addons/web/static/src/js/corelib.js index bb74369989d..bfde707312c 100644 --- a/addons/web/static/src/js/corelib.js +++ b/addons/web/static/src/js/corelib.js @@ -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(); |
