Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit f296e2e

Browse files
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`.
1 parent f4a121f commit f296e2e

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

src/ng/animate.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ var $AnimateProvider = ['$provide', function($provide) {
109109
* @function
110110
* @description Inserts the element into the DOM either after the `after` element or within
111111
* the `parent` element. Once complete, the done() callback will be fired (if provided).
112-
* @param {jQuery/jqLite element} element the element which will be inserted into the DOM
113-
* @param {jQuery/jqLite element} parent the parent element which will append the element as
112+
* @param {DOMElement} element the element which will be inserted into the DOM
113+
* @param {DOMElement} parent the parent element which will append the element as
114114
* a child (if the after element is not present)
115-
* @param {jQuery/jqLite element} after the sibling element which will append the element
115+
* @param {DOMElement} after the sibling element which will append the element
116116
* after itself
117117
* @param {function=} done callback function that will be called after the element has been
118118
* inserted into the DOM
@@ -136,7 +136,7 @@ var $AnimateProvider = ['$provide', function($provide) {
136136
* @function
137137
* @description Removes the element from the DOM. Once complete, the done() callback will be
138138
* fired (if provided).
139-
* @param {jQuery/jqLite element} element the element which will be removed from the DOM
139+
* @param {DOMElement} element the element which will be removed from the DOM
140140
* @param {function=} done callback function that will be called after the element has been
141141
* removed from the DOM
142142
*/
@@ -154,11 +154,11 @@ var $AnimateProvider = ['$provide', function($provide) {
154154
* either after the `after` element or inside of the `parent` element. Once complete, the
155155
* done() callback will be fired (if provided).
156156
*
157-
* @param {jQuery/jqLite element} element the element which will be moved around within the
157+
* @param {DOMElement} element the element which will be moved around within the
158158
* DOM
159-
* @param {jQuery/jqLite element} parent the parent element where the element will be
159+
* @param {DOMElement} parent the parent element where the element will be
160160
* inserted into (if the after element is not present)
161-
* @param {jQuery/jqLite element} after the sibling element where the element will be
161+
* @param {DOMElement} after the sibling element where the element will be
162162
* positioned next to
163163
* @param {function=} done the callback function (if provided) that will be fired after the
164164
* element has been moved to its new position
@@ -176,7 +176,7 @@ var $AnimateProvider = ['$provide', function($provide) {
176176
* @function
177177
* @description Adds the provided className CSS class value to the provided element. Once
178178
* complete, the done() callback will be fired (if provided).
179-
* @param {jQuery/jqLite element} element the element which will have the className value
179+
* @param {DOMElement} element the element which will have the className value
180180
* added to it
181181
* @param {string} className the CSS class which will be added to the element
182182
* @param {function=} done the callback function (if provided) that will be fired after the
@@ -199,7 +199,7 @@ var $AnimateProvider = ['$provide', function($provide) {
199199
* @function
200200
* @description Removes the provided className CSS class value from the provided element.
201201
* Once complete, the done() callback will be fired (if provided).
202-
* @param {jQuery/jqLite element} element the element which will have the className value
202+
* @param {DOMElement} element the element which will have the className value
203203
* removed from it
204204
* @param {string} className the CSS class which will be removed from the element
205205
* @param {function=} done the callback function (if provided) that will be fired after the
@@ -222,7 +222,7 @@ var $AnimateProvider = ['$provide', function($provide) {
222222
* @function
223223
* @description Adds and/or removes the given CSS classes to and from the element.
224224
* Once complete, the done() callback will be fired (if provided).
225-
* @param {jQuery/jqLite element} element the element which will it's CSS classes changed
225+
* @param {DOMElement} element the element which will it's CSS classes changed
226226
* removed from it
227227
* @param {string} add the CSS classes which will be added to the element
228228
* @param {string} remove the CSS class which will be removed from the element

src/ngAnimate/animate.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -409,9 +409,9 @@ angular.module('ngAnimate', ['ng'])
409409
* | 9. The animation ends and all generated CSS classes are removed from the element | class="my-animation" |
410410
* | 10. The doneCallback() callback is fired (if provided) | class="my-animation" |
411411
*
412-
* @param {jQuery/jqLite element} element the element that will be the focus of the enter animation
413-
* @param {jQuery/jqLite element} parentElement the parent element of the element that will be the focus of the enter animation
414-
* @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
412+
* @param {DOMElement} element the element that will be the focus of the enter animation
413+
* @param {DOMElement} parentElement the parent element of the element that will be the focus of the enter animation
414+
* @param {DOMElement} afterElement the sibling element (which is the previous element) of the element that will be the focus of the enter animation
415415
* @param {function()=} doneCallback the callback function that will be called once the animation is complete
416416
*/
417417
enter : function(element, parentElement, afterElement, doneCallback) {
@@ -447,7 +447,7 @@ angular.module('ngAnimate', ['ng'])
447447
* | 9. The element is removed from the DOM | ... |
448448
* | 10. The doneCallback() callback is fired (if provided) | ... |
449449
*
450-
* @param {jQuery/jqLite element} element the element that will be the focus of the leave animation
450+
* @param {DOMElement} element the element that will be the focus of the leave animation
451451
* @param {function()=} doneCallback the callback function that will be called once the animation is complete
452452
*/
453453
leave : function(element, doneCallback) {
@@ -486,9 +486,9 @@ angular.module('ngAnimate', ['ng'])
486486
* | 9. The animation ends and all generated CSS classes are removed from the element | class="my-animation" |
487487
* | 10. The doneCallback() callback is fired (if provided) | class="my-animation" |
488488
*
489-
* @param {jQuery/jqLite element} element the element that will be the focus of the move animation
490-
* @param {jQuery/jqLite element} parentElement the parentElement element of the element that will be the focus of the move animation
491-
* @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
489+
* @param {DOMElement} element the element that will be the focus of the move animation
490+
* @param {DOMElement} parentElement the parentElement element of the element that will be the focus of the move animation
491+
* @param {DOMElement} afterElement the sibling element (which is the previous element) of the element that will be the focus of the move animation
492492
* @param {function()=} doneCallback the callback function that will be called once the animation is complete
493493
*/
494494
move : function(element, parentElement, afterElement, doneCallback) {
@@ -526,7 +526,7 @@ angular.module('ngAnimate', ['ng'])
526526
* | 9. The super class is kept on the element | class="my-animation super" |
527527
* | 10. The doneCallback() callback is fired (if provided) | class="my-animation super" |
528528
*
529-
* @param {jQuery/jqLite element} element the element that will be animated
529+
* @param {DOMElement} element the element that will be animated
530530
* @param {string} className the CSS class that will be added to the element and then animated
531531
* @param {function()=} doneCallback the callback function that will be called once the animation is complete
532532
*/
@@ -562,7 +562,7 @@ angular.module('ngAnimate', ['ng'])
562562
* | 9. The doneCallback() callback is fired (if provided) | class="my-animation" |
563563
*
564564
*
565-
* @param {jQuery/jqLite element} element the element that will be animated
565+
* @param {DOMElement} element the element that will be animated
566566
* @param {string} className the CSS class that will be animated and then removed from the element
567567
* @param {function()=} doneCallback the callback function that will be called once the animation is complete
568568
*/
@@ -581,7 +581,7 @@ angular.module('ngAnimate', ['ng'])
581581
* @function
582582
* @description Adds and/or removes the given CSS classes to and from the element.
583583
* Once complete, the done() callback will be fired (if provided).
584-
* @param {jQuery/jqLite element} element the element which will it's CSS classes changed
584+
* @param {DOMElement} element the element which will it's CSS classes changed
585585
* removed from it
586586
* @param {string} add the CSS classes which will be added to the element
587587
* @param {string} remove the CSS class which will be removed from the element

0 commit comments

Comments
 (0)