aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngRoute/route.js
diff options
context:
space:
mode:
authorPete Bacon Darwin2013-11-20 11:18:21 +0000
committerPete Bacon Darwin2013-11-20 11:18:21 +0000
commitcad5a367c3ea38c249211e56bfb4779a19b31d38 (patch)
tree779eb10b5483d31d14ee9dda6c5097be28bd70d1 /src/ngRoute/route.js
parentf2453eabb35b05fc3ba83b49b2e236e3c4c092fb (diff)
downloadangular.js-cad5a367c3ea38c249211e56bfb4779a19b31d38.tar.bz2
docs(ngRoute): make it easier to find the example
Closes #4975
Diffstat (limited to 'src/ngRoute/route.js')
-rw-r--r--src/ngRoute/route.js9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/ngRoute/route.js b/src/ngRoute/route.js
index db157a43..e56faa30 100644
--- a/src/ngRoute/route.js
+++ b/src/ngRoute/route.js
@@ -9,6 +9,9 @@
*
* The `ngRoute` module provides routing and deeplinking services and directives for angular apps.
*
+ * ## Example
+ * See {@link ngRoute.$route#example $route} for an example of configuring and using `ngRoute`.
+ *
* {@installModule route}
*
* <div doc-module-components="ngRoute"></div>
@@ -24,8 +27,12 @@ var ngRouteModule = angular.module('ngRoute', ['ng']).
*
* @description
*
- * Used for configuring routes. See {@link ngRoute.$route $route} for an example.
+ * Used for configuring routes.
+ *
+ * ## Example
+ * See {@link ngRoute.$route#example $route} for an example of configuring and using `ngRoute`.
*
+ * ## Dependencies
* Requires the {@link ngRoute `ngRoute`} module to be installed.
*/
function $RouteProvider(){