aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngTouch/touch.js
diff options
context:
space:
mode:
authorBrian Ford2013-08-22 12:32:42 -0700
committerBrian Ford2013-08-22 16:55:54 -0700
commit57c43dd3762ea665125bff7e4727bce06a225b32 (patch)
tree5002413ad53358a509d881f7999903e01c51f124 /src/ngTouch/touch.js
parent99175f429417318e2087a92dd21bc8d5351c97a3 (diff)
downloadangular.js-57c43dd3762ea665125bff7e4727bce06a225b32.tar.bz2
docs(module): improve the installation instructions for optional modules
Currently, the documentation does a bad job of explaining the distinction between the services that it provides, and the module itself. Furthermore, the instructions for using optional modules are inconsistent or missing. This commit addresses the problem by ading a new `{@installModule foo}` annotation to the docs generator that inlines the appropriate instructions based on the name of the module.
Diffstat (limited to 'src/ngTouch/touch.js')
-rw-r--r--src/ngTouch/touch.js13
1 files changed, 11 insertions, 2 deletions
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