diff options
| author | Peter Bacon Darwin | 2014-02-22 13:07:19 +0000 | 
|---|---|---|
| committer | Peter Bacon Darwin | 2014-02-22 13:07:19 +0000 | 
| commit | f296e2ee12bb60f9ff988d2be4fbe9ec7c5dc42f (patch) | |
| tree | 518a6da50dd051bab4b65d2e2a39bdf7461e24cd /src | |
| parent | f4a121f6c2fab44d63e64824bbb31253b9f66bbf (diff) | |
| download | angular.js-f296e2ee12bb60f9ff988d2be4fbe9ec7c5dc42f.tar.bz2 | |
docs($animate): change @param to use valid types
`{jQuery/jqLite element}` is not a valid jsdoc type and breaks when being
parsed causing the documentation to look wrong.  This commit changes all
such param tags to use `DOMElement` instead, which is what is used for
similar params in `$compile` and `angular.element`.
Diffstat (limited to 'src')
| -rw-r--r-- | src/ng/animate.js | 20 | ||||
| -rw-r--r-- | src/ngAnimate/animate.js | 20 | 
2 files changed, 20 insertions, 20 deletions
| diff --git a/src/ng/animate.js b/src/ng/animate.js index d438b169..130e61e7 100644 --- a/src/ng/animate.js +++ b/src/ng/animate.js @@ -109,10 +109,10 @@ var $AnimateProvider = ['$provide', function($provide) {         * @function         * @description Inserts the element into the DOM either after the `after` element or within         *   the `parent` element. Once complete, the done() callback will be fired (if provided). -       * @param {jQuery/jqLite element} element the element which will be inserted into the DOM -       * @param {jQuery/jqLite element} parent the parent element which will append the element as +       * @param {DOMElement} element the element which will be inserted into the DOM +       * @param {DOMElement} parent the parent element which will append the element as         *   a child (if the after element is not present) -       * @param {jQuery/jqLite element} after the sibling element which will append the element +       * @param {DOMElement} after the sibling element which will append the element         *   after itself         * @param {function=} done callback function that will be called after the element has been         *   inserted into the DOM @@ -136,7 +136,7 @@ var $AnimateProvider = ['$provide', function($provide) {         * @function         * @description Removes the element from the DOM. Once complete, the done() callback will be         *   fired (if provided). -       * @param {jQuery/jqLite element} element the element which will be removed from the DOM +       * @param {DOMElement} element the element which will be removed from the DOM         * @param {function=} done callback function that will be called after the element has been         *   removed from the DOM         */ @@ -154,11 +154,11 @@ var $AnimateProvider = ['$provide', function($provide) {         * either after the `after` element or inside of the `parent` element. Once complete, the         * done() callback will be fired (if provided).         * -       * @param {jQuery/jqLite element} element the element which will be moved around within the +       * @param {DOMElement} element the element which will be moved around within the         *   DOM -       * @param {jQuery/jqLite element} parent the parent element where the element will be +       * @param {DOMElement} parent the parent element where the element will be         *   inserted into (if the after element is not present) -       * @param {jQuery/jqLite element} after the sibling element where the element will be +       * @param {DOMElement} after the sibling element where the element will be         *   positioned next to         * @param {function=} done the callback function (if provided) that will be fired after the         *   element has been moved to its new position @@ -176,7 +176,7 @@ var $AnimateProvider = ['$provide', function($provide) {         * @function         * @description Adds the provided className CSS class value to the provided element. Once         * complete, the done() callback will be fired (if provided). -       * @param {jQuery/jqLite element} element the element which will have the className value +       * @param {DOMElement} element the element which will have the className value         *   added to it         * @param {string} className the CSS class which will be added to the element         * @param {function=} done the callback function (if provided) that will be fired after the @@ -199,7 +199,7 @@ var $AnimateProvider = ['$provide', function($provide) {         * @function         * @description Removes the provided className CSS class value from the provided element.         * Once complete, the done() callback will be fired (if provided). -       * @param {jQuery/jqLite element} element the element which will have the className value +       * @param {DOMElement} element the element which will have the className value         *   removed from it         * @param {string} className the CSS class which will be removed from the element         * @param {function=} done the callback function (if provided) that will be fired after the @@ -222,7 +222,7 @@ var $AnimateProvider = ['$provide', function($provide) {         * @function         * @description Adds and/or removes the given CSS classes to and from the element.         * Once complete, the done() callback will be fired (if provided). -       * @param {jQuery/jqLite element} element the element which will it's CSS classes changed +       * @param {DOMElement} element the element which will it's CSS classes changed         *   removed from it         * @param {string} add the CSS classes which will be added to the element         * @param {string} remove the CSS class which will be removed from the element diff --git a/src/ngAnimate/animate.js b/src/ngAnimate/animate.js index 1a0bb172..5c0ed917 100644 --- a/src/ngAnimate/animate.js +++ b/src/ngAnimate/animate.js @@ -409,9 +409,9 @@ angular.module('ngAnimate', ['ng'])           * | 9. The animation ends and all generated CSS classes are removed from the element             | class="my-animation"                        |           * | 10. The doneCallback() callback is fired (if provided)                                       | class="my-animation"                        |           * -         * @param {jQuery/jqLite element} element the element that will be the focus of the enter animation -         * @param {jQuery/jqLite element} parentElement the parent element of the element that will be the focus of the enter animation -         * @param {jQuery/jqLite element} afterElement the sibling element (which is the previous element) of the element that will be the focus of the enter animation +         * @param {DOMElement} element the element that will be the focus of the enter animation +         * @param {DOMElement} parentElement the parent element of the element that will be the focus of the enter animation +         * @param {DOMElement} afterElement the sibling element (which is the previous element) of the element that will be the focus of the enter animation           * @param {function()=} doneCallback the callback function that will be called once the animation is complete          */          enter : function(element, parentElement, afterElement, doneCallback) { @@ -447,7 +447,7 @@ angular.module('ngAnimate', ['ng'])           * | 9. The element is removed from the DOM                                                       | ...                                         |           * | 10. The doneCallback() callback is fired (if provided)                                       | ...                                         |           * -         * @param {jQuery/jqLite element} element the element that will be the focus of the leave animation +         * @param {DOMElement} element the element that will be the focus of the leave animation           * @param {function()=} doneCallback the callback function that will be called once the animation is complete          */          leave : function(element, doneCallback) { @@ -486,9 +486,9 @@ angular.module('ngAnimate', ['ng'])           * | 9. The animation ends and all generated CSS classes are removed from the element             | class="my-animation"                        |           * | 10. The doneCallback() callback is fired (if provided)                                       | class="my-animation"                        |           * -         * @param {jQuery/jqLite element} element the element that will be the focus of the move animation -         * @param {jQuery/jqLite element} parentElement the parentElement element of the element that will be the focus of the move animation -         * @param {jQuery/jqLite element} afterElement the sibling element (which is the previous element) of the element that will be the focus of the move animation +         * @param {DOMElement} element the element that will be the focus of the move animation +         * @param {DOMElement} parentElement the parentElement element of the element that will be the focus of the move animation +         * @param {DOMElement} afterElement the sibling element (which is the previous element) of the element that will be the focus of the move animation           * @param {function()=} doneCallback the callback function that will be called once the animation is complete          */          move : function(element, parentElement, afterElement, doneCallback) { @@ -526,7 +526,7 @@ angular.module('ngAnimate', ['ng'])           * | 9. The super class is kept on the element                                                      | class="my-animation super"                  |           * | 10. The doneCallback() callback is fired (if provided)                                         | class="my-animation super"                  |           * -         * @param {jQuery/jqLite element} element the element that will be animated +         * @param {DOMElement} element the element that will be animated           * @param {string} className the CSS class that will be added to the element and then animated           * @param {function()=} doneCallback the callback function that will be called once the animation is complete          */ @@ -562,7 +562,7 @@ angular.module('ngAnimate', ['ng'])           * | 9. The doneCallback() callback is fired (if provided)                                         | class="my-animation"                        |           *           * -         * @param {jQuery/jqLite element} element the element that will be animated +         * @param {DOMElement} element the element that will be animated           * @param {string} className the CSS class that will be animated and then removed from the element           * @param {function()=} doneCallback the callback function that will be called once the animation is complete          */ @@ -581,7 +581,7 @@ angular.module('ngAnimate', ['ng'])             * @function             * @description Adds and/or removes the given CSS classes to and from the element.             * Once complete, the done() callback will be fired (if provided). -           * @param {jQuery/jqLite element} element the element which will it's CSS classes changed +           * @param {DOMElement} element the element which will it's CSS classes changed             *   removed from it             * @param {string} add the CSS classes which will be added to the element             * @param {string} remove the CSS class which will be removed from the element | 
