aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngTouch
diff options
context:
space:
mode:
Diffstat (limited to 'src/ngTouch')
-rw-r--r--src/ngTouch/directive/ngClick.js2
-rw-r--r--src/ngTouch/directive/ngSwipe.js4
-rw-r--r--src/ngTouch/swipe.js4
-rw-r--r--src/ngTouch/touch.js13
4 files changed, 20 insertions, 3 deletions
diff --git a/src/ngTouch/directive/ngClick.js b/src/ngTouch/directive/ngClick.js
index f1d8ccaa..d6e404ca 100644
--- a/src/ngTouch/directive/ngClick.js
+++ b/src/ngTouch/directive/ngClick.js
@@ -10,6 +10,8 @@
* the click event. This version handles them immediately, and then prevents the
* following click event from propagating.
*
+ * Requires the {@link ngTouch `ngTouch`} module to be installed.
+ *
* This directive can fall back to using an ordinary click event, and so works on desktop
* browsers as well as mobile.
*
diff --git a/src/ngTouch/directive/ngSwipe.js b/src/ngTouch/directive/ngSwipe.js
index e754113c..a5911f9a 100644
--- a/src/ngTouch/directive/ngSwipe.js
+++ b/src/ngTouch/directive/ngSwipe.js
@@ -9,6 +9,8 @@
* A leftward swipe is a quick, right-to-left slide of the finger.
* Though ngSwipeLeft is designed for touch-based devices, it will work with a mouse click and drag too.
*
+ * Requires the {@link ngTouch `ngTouch`} module to be installed.
+ *
* @element ANY
* @param {expression} ngSwipeLeft {@link guide/expression Expression} to evaluate
* upon left swipe. (Event object is available as `$event`)
@@ -36,6 +38,8 @@
* A rightward swipe is a quick, left-to-right slide of the finger.
* Though ngSwipeRight is designed for touch-based devices, it will work with a mouse click and drag too.
*
+ * Requires the {@link ngTouch `ngTouch`} module to be installed.
+ *
* @element ANY
* @param {expression} ngSwipeRight {@link guide/expression Expression} to evaluate
* upon right swipe. (Event object is available as `$event`)
diff --git a/src/ngTouch/swipe.js b/src/ngTouch/swipe.js
index 655043f8..0ee4218e 100644
--- a/src/ngTouch/swipe.js
+++ b/src/ngTouch/swipe.js
@@ -8,7 +8,9 @@
* The `$swipe` service is a service that abstracts the messier details of hold-and-drag swipe
* behavior, to make implementing swipe-related directives more convenient.
*
- * It is used by the `ngSwipeLeft` and `ngSwipeRight` directives in `ngTouch`, and by
+ * Requires the {@link ngTouch `ngTouch`} module to be installed.
+ *
+ * `$swipe` is used by the `ngSwipeLeft` and `ngSwipeRight` directives in `ngTouch`, and by
* `ngCarousel` in a separate component.
*
* # Usage
diff --git a/src/ngTouch/touch.js b/src/ngTouch/touch.js
index 844350aa..0e9229b2 100644
--- a/src/ngTouch/touch.js
+++ b/src/ngTouch/touch.js
@@ -4,8 +4,17 @@
* @ngdoc overview
* @name ngTouch
* @description
- * Touch events and other mobile helpers.
- * Based on jQuery Mobile touch event handling (jquerymobile.com)
+ *
+ * # ngTouch
+ *
+ * `ngTouch` is the name of the optional Angular module that provides touch events and other
+ * helpers for touch-enabled devices.
+ * The implementation is based on jQuery Mobile touch event handling
+ * ([jquerymobile.com](http://jquerymobile.com/))
+ *
+ * {@installModule touch}
+ *
+ * See {@link ngTouch.$swipe `$swipe`} for usage.
*/
// define ngTouch module