docs: clean up formatting of animation events

Narretz · Narretz · commit 7de7059f95fb · 2016-02-08T16:56:36.000+01:00
Closes #12670 Closes #10742
diff --git a/src/ng/directive/ngClass.js b/src/ng/directive/ngClass.js
@@ -148,9 +148,10 @@ function classDirective(name, selector) {
  * new classes added.
  *
  * @animations
- * **add** - happens just before the class is applied to the elements
- *
- * **remove** - happens just before the class is removed from the element
+ * | Animation                        | Occurs                              |
+ * |----------------------------------|-------------------------------------|
+ * | {@link ng.$animate#addClass addClass}       | just before the class is applied to the element   |
+ * | {@link ng.$animate#removeClass removeClass} | just before the class is removed from the element |
  *
  * @element ANY
  * @param {expression} ngClass {@link guide/expression Expression} to eval. The result
diff --git a/src/ng/directive/ngIf.js b/src/ng/directive/ngIf.js
@@ -34,8 +34,10 @@
  * and `leave` effects.
  *
  * @animations
- * enter - happens just after the `ngIf` contents change and a new DOM element is created and injected into the `ngIf` container
- * leave - happens just before the `ngIf` contents are removed from the DOM
+ * | Animation                        | Occurs                               |
+ * |----------------------------------|-------------------------------------|
+ * | {@link ng.$animate#enter enter}  | just after the `ngIf` contents change and a new DOM element is created and injected into the `ngIf` container |
+ * | {@link ng.$animate#leave leave}  | just before the `ngIf` contents are removed from the DOM |
  *
  * @element ANY
  * @scope
diff --git a/src/ng/directive/ngInclude.js b/src/ng/directive/ngInclude.js
@@ -23,8 +23,10 @@
  * access on some browsers.
  *
  * @animations
- * enter - animation is used to bring new content into the browser.
- * leave - animation is used to animate existing content away.
+ * | Animation                        | Occurs                              |
+ * |----------------------------------|-------------------------------------|
+ * | {@link ng.$animate#enter enter}  | when the expression changes, on the new include |
+ * | {@link ng.$animate#leave leave}  | when the expression changes, on the old include |
  *
  * The enter and leave animation occur concurrently.
  *
diff --git a/src/ng/directive/ngRepeat.js b/src/ng/directive/ngRepeat.js
@@ -164,11 +164,11 @@
  * as **data-ng-repeat-start**, **x-ng-repeat-start** and **ng:repeat-start**).
  *
  * @animations
- * **.enter** - when a new item is added to the list or when an item is revealed after a filter
- *
- * **.leave** - when an item is removed from the list or when an item is filtered out
- *
- * **.move** - when an adjacent item is filtered out causing a reorder or when the item contents are reordered
+ * | Animation                        | Occurs                              |
+ * |----------------------------------|-------------------------------------|
+ * | {@link ng.$animate#enter enter} | when a new item is added to the list or when an item is revealed after a filter |
+ * | {@link ng.$animate#leave leave} | when an item is removed from the list or when an item is filtered out |
+ * | {@link ng.$animate#move move } | when an adjacent item is filtered out causing a reorder or when the item contents are reordered |
  *
  * See the example below for defining CSS animations with ngRepeat.
  *
diff --git a/src/ng/directive/ngShowHide.js b/src/ng/directive/ngShowHide.js
@@ -85,12 +85,14 @@ var NG_HIDE_IN_PROGRESS_CLASS = 'ng-hide-animate';
  * .my-element.ng-hide-remove.ng-hide-remove-active { ... }
  * ```
  *
- * Keep in mind that, as of AngularJS version 1.3.0-beta.11, there is no need to change the display
+ * Keep in mind that, as of AngularJS version 1.3, there is no need to change the display
  * property to block during animation states--ngAnimate will handle the style toggling automatically for you.
  *
  * @animations
- * addClass: `.ng-hide` - happens after the `ngShow` expression evaluates to a truthy value and the just before contents are set to visible
- * removeClass: `.ng-hide` - happens after the `ngShow` expression evaluates to a non truthy value and just before the contents are set to hidden
+ * | Animation                        | Occurs                              |
+ * |----------------------------------|-------------------------------------|
+ * | {@link $animate#addClass addClass} `.ng-hide`  | after the `ngShow` expression evaluates to a non truthy value and just before the contents are set to hidden |
+ * | {@link $animate#removeClass removeClass}  `.ng-hide`  | after the `ngShow` expression evaluates to a truthy value and just before contents are set to visible |
  *
  * @element ANY
  * @param {expression} ngShow If the {@link guide/expression expression} is truthy
@@ -249,12 +251,15 @@ var ngShowDirective = ['$animate', function($animate) {
  * .my-element.ng-hide-remove.ng-hide-remove-active { ... }
  * ```
  *
- * Keep in mind that, as of AngularJS version 1.3.0-beta.11, there is no need to change the display
+ * Keep in mind that, as of AngularJS version 1.3, there is no need to change the display
  * property to block during animation states--ngAnimate will handle the style toggling automatically for you.
  *
  * @animations
- * removeClass: `.ng-hide` - happens after the `ngHide` expression evaluates to a truthy value and just before the contents are set to hidden
- * addClass: `.ng-hide` - happens after the `ngHide` expression evaluates to a non truthy value and just before the contents are set to visible
+ * | Animation                        | Occurs                              |
+ * |----------------------------------|-------------------------------------|
+ * | {@link $animate#addClass addClass} `.ng-hide`  | after the `ngHide` expression evaluates to a truthy value and just before the contents are set to hidden |
+ * | {@link $animate#removeClass removeClass}  `.ng-hide`  | after the `ngHide` expression evaluates to a non truthy value and just before contents are set to visible |
+ *
  *
  * @element ANY
  * @param {expression} ngHide If the {@link guide/expression expression} is truthy then
diff --git a/src/ng/directive/ngSwitch.js b/src/ng/directive/ngSwitch.js
@@ -27,8 +27,10 @@
  * </div>
 
  * @animations
- * enter - happens after the ngSwitch contents change and the matched child element is placed inside the container
- * leave - happens just after the ngSwitch contents change and just before the former contents are removed from the DOM
+ * | Animation                        | Occurs                              |
+ * |----------------------------------|-------------------------------------|
+ * | {@link ng.$animate#enter enter}  | after the ngSwitch contents change and the matched child element is placed inside the container |
+ * | {@link ng.$animate#leave leave}  | after the ngSwitch contents change and just before the former contents are removed from the DOM |
  *
  * @usage
  *
diff --git a/src/ngAnimate/ngAnimateSwap.js b/src/ngAnimate/ngAnimateSwap.js
@@ -10,11 +10,17 @@
  *
  * ngAnimateSwap is a animation-oriented directive that allows for the container to
  * be removed and entered in whenever the associated expression changes. A
- * common usecase for this directive is a rotating banner component which
+ * common usecase for this directive is a rotating banner or slider component which
  * contains one image being present at a time. When the active image changes
  * then the old image will perform a `leave` animation and the new element
  * will be inserted via an `enter` animation.
  *
+ * @animations
+ * | Animation                        | Occurs                               |
+ * |----------------------------------|--------------------------------------|
+ * | {@link ng.$animate#enter enter}  | when the new element is inserted to the DOM  |
+ * | {@link ng.$animate#leave leave}  | when the old element is removed from the DOM |
+ *
  * @example
  * <example name="ngAnimateSwap-directive" module="ngAnimateSwapExample"
  *          deps="angular-animate.js"
diff --git a/src/ngRoute/directive/ngView.js b/src/ngRoute/directive/ngView.js
@@ -19,8 +19,10 @@ ngRouteModule.directive('ngView', ngViewFillContentFactory);
  * Requires the {@link ngRoute `ngRoute`} module to be installed.
  *
  * @animations
- * enter - animation is used to bring new content into the browser.
- * leave - animation is used to animate existing content away.
+ * | Animation                        | Occurs                              |
+ * |----------------------------------|-------------------------------------|
+ * | {@link ng.$animate#enter enter}  | when the new element is inserted to the DOM |
+ * | {@link ng.$animate#leave leave}  | when the old element is removed from to the DOM  |
  *
  * The enter and leave animation occur concurrently.
  *

Original file line number	Diff line number	Diff line change
`@@ -148,9 +148,10 @@ function classDirective(name, selector) {`
`148`	`148`	`* new classes added.`
`149`	`149`	`*`
`150`	`150`	`* @animations`
`151`		`- * add - happens just before the class is applied to the elements`
`152`		`- *`
`153`		`- * remove - happens just before the class is removed from the element`
	`151`	`+ * \| Animation \| Occurs \|`
	`152`	`+ * \|----------------------------------\|-------------------------------------\|`
	`153`	`+ * \| {@link ng.$animate#addClass addClass} \| just before the class is applied to the element \|`
	`154`	`+ * \| {@link ng.$animate#removeClass removeClass} \| just before the class is removed from the element \|`
`154`	`155`	`*`
`155`	`156`	`* @element ANY`
`156`	`157`	`* @param {expression} ngClass {@link guide/expression Expression} to eval. The result`
Original file line number	Diff line number	Diff line change
`@@ -34,8 +34,10 @@`
`34`	`34`	* and `leave` effects.
`35`	`35`	`*`
`36`	`36`	`* @animations`
`37`		- * enter - happens just after the `ngIf` contents change and a new DOM element is created and injected into the `ngIf` container
`38`		- * leave - happens just before the `ngIf` contents are removed from the DOM
	`37`	`+ * \| Animation \| Occurs \|`
	`38`	`+ * \|----------------------------------\|-------------------------------------\|`
	`39`	+ * \| {@link ng.$animate#enter enter} \| just after the `ngIf` contents change and a new DOM element is created and injected into the `ngIf` container \|
	`40`	+ * \| {@link ng.$animate#leave leave} \| just before the `ngIf` contents are removed from the DOM \|
`39`	`41`	`*`
`40`	`42`	`* @element ANY`
`41`	`43`	`* @scope`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,10 @@`
`23`	`23`	`* access on some browsers.`
`24`	`24`	`*`
`25`	`25`	`* @animations`
`26`		`- * enter - animation is used to bring new content into the browser.`
`27`		`- * leave - animation is used to animate existing content away.`
	`26`	`+ * \| Animation \| Occurs \|`
	`27`	`+ * \|----------------------------------\|-------------------------------------\|`
	`28`	`+ * \| {@link ng.$animate#enter enter} \| when the expression changes, on the new include \|`
	`29`	`+ * \| {@link ng.$animate#leave leave} \| when the expression changes, on the old include \|`
`28`	`30`	`*`
`29`	`31`	`* The enter and leave animation occur concurrently.`
`30`	`32`	`*`
Original file line number	Diff line number	Diff line change
`@@ -164,11 +164,11 @@`
`164`	`164`	`* as data-ng-repeat-start, x-ng-repeat-start and ng:repeat-start).`
`165`	`165`	`*`
`166`	`166`	`* @animations`
`167`		`- * .enter - when a new item is added to the list or when an item is revealed after a filter`
`168`		`- *`
`169`		`- * .leave - when an item is removed from the list or when an item is filtered out`
`170`		`- *`
`171`		`- * .move - when an adjacent item is filtered out causing a reorder or when the item contents are reordered`
	`167`	`+ * \| Animation \| Occurs \|`
	`168`	`+ * \|----------------------------------\|-------------------------------------\|`
	`169`	`+ * \| {@link ng.$animate#enter enter} \| when a new item is added to the list or when an item is revealed after a filter \|`
	`170`	`+ * \| {@link ng.$animate#leave leave} \| when an item is removed from the list or when an item is filtered out \|`
	`171`	`+ * \| {@link ng.$animate#move move } \| when an adjacent item is filtered out causing a reorder or when the item contents are reordered \|`
`172`	`172`	`*`
`173`	`173`	`* See the example below for defining CSS animations with ngRepeat.`
`174`	`174`	`*`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,10 @@`
`27`	`27`	`* </div>`
`28`	`28`
`29`	`29`	`* @animations`
`30`		`- * enter - happens after the ngSwitch contents change and the matched child element is placed inside the container`
`31`		`- * leave - happens just after the ngSwitch contents change and just before the former contents are removed from the DOM`
	`30`	`+ * \| Animation \| Occurs \|`
	`31`	`+ * \|----------------------------------\|-------------------------------------\|`
	`32`	`+ * \| {@link ng.$animate#enter enter} \| after the ngSwitch contents change and the matched child element is placed inside the container \|`
	`33`	`+ * \| {@link ng.$animate#leave leave} \| after the ngSwitch contents change and just before the former contents are removed from the DOM \|`
`32`	`34`	`*`
`33`	`35`	`* @usage`
`34`	`36`	`*`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,10 @@ ngRouteModule.directive('ngView', ngViewFillContentFactory);`
`19`	`19`	* Requires the {@link ngRoute `ngRoute`} module to be installed.
`20`	`20`	`*`
`21`	`21`	`* @animations`
`22`		`- * enter - animation is used to bring new content into the browser.`
`23`		`- * leave - animation is used to animate existing content away.`
	`22`	`+ * \| Animation \| Occurs \|`
	`23`	`+ * \|----------------------------------\|-------------------------------------\|`
	`24`	`+ * \| {@link ng.$animate#enter enter} \| when the new element is inserted to the DOM \|`
	`25`	`+ * \| {@link ng.$animate#leave leave} \| when the old element is removed from to the DOM \|`
`24`	`26`	`*`
`25`	`27`	`* The enter and leave animation occur concurrently.`
`26`	`28`	`*`