From 57c43dd3762ea665125bff7e4727bce06a225b32 Mon Sep 17 00:00:00 2001
From: Brian Ford
Date: Thu, 22 Aug 2013 12:32:42 -0700
Subject: 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.
---
 src/ngTouch/directive/ngClick.js | 2 ++
 src/ngTouch/directive/ngSwipe.js | 4 ++++
 2 files changed, 6 insertions(+)

(limited to 'src/ngTouch/directive')

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`)
-- 
cgit v1.2.3