docs(ngRoute): make it easier to find the example

petebacondarwin · petebacondarwin · commit cad5a367c3ea · 2013-11-20T11:18:21.000Z
Closes angular#4975
diff --git 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(){

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@`
`9`	`9`	`*`
`10`	`10`	* The `ngRoute` module provides routing and deeplinking services and directives for angular apps.
`11`	`11`	`*`
	`12`	`+ * ## Example`
	`13`	+ * See {@link ngRoute.$route#example $route} for an example of configuring and using `ngRoute`.
	`14`	`+ *`
`12`	`15`	`* {@installModule route}`
`13`	`16`	`*`
`14`	`17`	`* <div doc-module-components="ngRoute"></div>`
`@@ -24,8 +27,12 @@ var ngRouteModule = angular.module('ngRoute', ['ng']).`
`24`	`27`	`*`
`25`	`28`	`* @description`
`26`	`29`	`*`
`27`		`- * Used for configuring routes. See {@link ngRoute.$route $route} for an example.`
	`30`	`+ * Used for configuring routes.`
	`31`	`+ *`
	`32`	`+ * ## Example`
	`33`	+ * See {@link ngRoute.$route#example $route} for an example of configuring and using `ngRoute`.
`28`	`34`	`*`
	`35`	`+ * ## Dependencies`
`29`	`36`	* Requires the {@link ngRoute `ngRoute`} module to be installed.
`30`	`37`	`*/`
`31`	`38`	`function $RouteProvider(){`