aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorReto Aebersold2013-08-14 14:18:28 +0200
committerIgor Minar2013-08-15 10:34:23 -0700
commitdba5e16269c1db9f69e385b5828cab72c8ac53ba (patch)
tree7c1b84585f53d691af746de716a2a2f50b9652a6 /src
parent380854fd2ce4541aec7970066a0e93ccfb5943cb (diff)
downloadangular.js-dba5e16269c1db9f69e385b5828cab72c8ac53ba.tar.bz2
docs($route): add hint for ngRoute module inclusion
Closes #3583
Diffstat (limited to 'src')
-rw-r--r--src/ngRoute/route.js13
1 files changed, 12 insertions, 1 deletions
diff --git a/src/ngRoute/route.js b/src/ngRoute/route.js
index d1d7bba6..f8a285cd 100644
--- a/src/ngRoute/route.js
+++ b/src/ngRoute/route.js
@@ -5,7 +5,18 @@
* @name ngRoute
* @description
*
- * Module that provides routing and deeplinking services and directives for angular apps.
+ * ngRoute
+ * =========
+ *
+ * The ngRoute module provides routing and deeplinking services and directives for angular apps.
+ *
+ * To make use of routing with AngularJS, the `angular-route.js` JavaScript file must be included into your application
+ * and the `ngRoute` module must be included as a dependency.
+ *
+ * <pre>
+ * angular.module('App', ['ngRoute']);
+ * </pre>
+ *
*/
var ngRouteModule = angular.module('ngRoute', ['ng']).