docs(ngTouch): Document event parameter for $swipe handlers

alfonso-presa · Narretz · commit bea74c0f56c9 · 2015-06-17T21:17:33.000+02:00
Document that the event handlers provided by $swipe do receive the raw event as their last parameter. Closes #11983 Closes #12149
diff --git a/src/ngTouch/swipe.js b/src/ngTouch/swipe.js
@@ -74,7 +74,8 @@ ngTouch.factory('$swipe', [function() {
      * `$swipe` will listen for `mouse` and `touch` events.
      *
      * The four events are `start`, `move`, `end`, and `cancel`. `start`, `move`, and `end`
-     * receive as a parameter a coordinates object of the form `{ x: 150, y: 310 }`.
+     * receive as a parameter a coordinates object of the form `{ x: 150, y: 310 }` and the raw
+     * `event`. `cancel` receives the raw `event` as its single parameter.
      *
      * `start` is called on either `mousedown` or `touchstart`. After this event, `$swipe` is
      * watching for `touchmove` or `mousemove` events. These events are ignored until the total

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,8 @@ ngTouch.factory('$swipe', [function() {`
`74`	`74`	* `$swipe` will listen for `mouse` and `touch` events.
`75`	`75`	`*`
`76`	`76`	* The four events are `start`, `move`, `end`, and `cancel`. `start`, `move`, and `end`
`77`		- * receive as a parameter a coordinates object of the form `{ x: 150, y: 310 }`.
	`77`	+ * receive as a parameter a coordinates object of the form `{ x: 150, y: 310 }` and the raw
	`78`	+ * `event`. `cancel` receives the raw `event` as its single parameter.
`78`	`79`	`*`
`79`	`80`	* `start` is called on either `mousedown` or `touchstart`. After this event, `$swipe` is
`80`	`81`	* watching for `touchmove` or `mousemove` events. These events are ignored until the total