docs(api): escape params that have <object> in their type

petebacondarwin · petebacondarwin · commit 2123772a653e · 2014-02-16T19:03:44.000Z
Really the doc-gen process should escape there but for now this should
stop the layout from breaking.
diff --git a/src/ng/http.js b/src/ng/http.js
@@ -573,7 +573,7 @@ function $HttpProvider() {
      *   - **headers** – `{function([headerName])}` – Header getter function.
      *   - **config** – `{Object}` – The configuration object that was used to generate the request.
      *
-     * @property {Array.<Object>} pendingRequests Array of config objects for currently pending
+     * @property {Array.&ltObject&gt;} pendingRequests Array of config objects for currently pending
      *   requests. This is primarily meant to be used for debugging purposes.
      *
      *
diff --git a/src/ngResource/resource.js b/src/ngResource/resource.js
@@ -98,8 +98,8 @@ function shallowClearAndCopy(src, dst) {
  *   If the parameter value is prefixed with `@` then the value of that parameter is extracted from
  *   the data object (useful for non-GET operations).
  *
- * @param {Object.<Object>=} actions Hash with declaration of custom action that should extend the
- *   default set of resource actions. The declaration should be created in the format of {@link
+ * @param {Object.&lt;Object&gt;=} actions Hash with declaration of custom action that should extend
+ *   the default set of resource actions. The declaration should be created in the format of {@link
  *   ng.$http#usage_parameters $http.config}:
  *
  *       {action1: {method:?, params:?, isArray:?, headers:?, ...},
@@ -145,25 +145,26 @@ function shallowClearAndCopy(src, dst) {
  *
  * @returns {Object} A resource "class" object with methods for the default set of resource actions
  *   optionally extended with custom `actions`. The default set contains these actions:
- *
- *       { 'get':    {method:'GET'},
- *         'save':   {method:'POST'},
- *         'query':  {method:'GET', isArray:true},
- *         'remove': {method:'DELETE'},
- *         'delete': {method:'DELETE'} };
- *
+ *   ```js
+ *   { 'get':    {method:'GET'},
+ *     'save':   {method:'POST'},
+ *     'query':  {method:'GET', isArray:true},
+ *     'remove': {method:'DELETE'},
+ *     'delete': {method:'DELETE'} };
+ *   ```
+ *   
  *   Calling these methods invoke an {@link ng.$http} with the specified http method,
  *   destination and parameters. When the data is returned from the server then the object is an
  *   instance of the resource class. The actions `save`, `remove` and `delete` are available on it
  *   as  methods with the `$` prefix. This allows you to easily perform CRUD operations (create,
  *   read, update, delete) on server-side data like this:
  *   ```js
-        var User = $resource('/user/:userId', {userId:'@id'});
-        var user = User.get({userId:123}, function() {
-          user.abc = true;
-          user.$save();
-        });
-     ```
+ *   var User = $resource('/user/:userId', {userId:'@id'});
+ *   var user = User.get({userId:123}, function() {
+ *     user.abc = true;
+ *     user.$save();
+ *   });
+ *   ```
  *
  *   It is important to realize that invoking a $resource object method immediately returns an
  *   empty reference (object or array depending on `isArray`). Once the data is returned from the
diff --git a/src/ngRoute/route.js b/src/ngRoute/route.js
@@ -83,15 +83,15 @@ function $RouteProvider(){
    *
    *      If `template` is a function, it will be called with the following parameters:
    *
-   *      - `{Array.<Object>}` - route parameters extracted from the current
+   *      - `{Array.&lt;Object&gt;}` - route parameters extracted from the current
    *        `$location.path()` by applying the current route
    *
    *    - `templateUrl` – `{string=|function()=}` – path or function that returns a path to an html
    *      template that should be used by {@link ngRoute.directive:ngView ngView}.
    *
    *      If `templateUrl` is a function, it will be called with the following parameters:
    *
-   *      - `{Array.<Object>}` - route parameters extracted from the current
+   *      - `{Array.&lt;Object&gt;}` - route parameters extracted from the current
    *        `$location.path()` by applying the current route
    *
    *    - `resolve` - `{Object.<string, function>=}` - An optional map of dependencies which should
@@ -248,7 +248,7 @@ function $RouteProvider(){
      *     - `$scope` - The current route scope.
      *     - `$template` - The current route template HTML.
      *
-     * @property {Array.<Object>} routes Array of all configured routes.
+     * @property {Array.&lt;Object&gt;} routes Array of all configured routes.
      *
      * @description
      * `$route` is used for deep-linking URLs to controllers and views (HTML partials).

Original file line number	Diff line number	Diff line change
`@@ -573,7 +573,7 @@ function $HttpProvider() {`
`573`	`573`	* - headers – `{function([headerName])}` – Header getter function.
`574`	`574`	* - config – `{Object}` – The configuration object that was used to generate the request.
`575`	`575`	`*`
`576`		`- * @property {Array.<Object>} pendingRequests Array of config objects for currently pending`
	`576`	`+ * @property {Array.&ltObject>} pendingRequests Array of config objects for currently pending`
`577`	`577`	`* requests. This is primarily meant to be used for debugging purposes.`
`578`	`578`	`*`
`579`	`579`	`*`
Original file line number	Diff line number	Diff line change
`@@ -83,15 +83,15 @@ function $RouteProvider(){`
`83`	`83`	`*`
`84`	`84`	* If `template` is a function, it will be called with the following parameters:
`85`	`85`	`*`
`86`		- * - `{Array.<Object>}` - route parameters extracted from the current
	`86`	+ * - `{Array.<Object>}` - route parameters extracted from the current
`87`	`87`	* `$location.path()` by applying the current route
`88`	`88`	`*`
`89`	`89`	* - `templateUrl` – `{string=\|function()=}` – path or function that returns a path to an html
`90`	`90`	`* template that should be used by {@link ngRoute.directive:ngView ngView}.`
`91`	`91`	`*`
`92`	`92`	* If `templateUrl` is a function, it will be called with the following parameters:
`93`	`93`	`*`
`94`		- * - `{Array.<Object>}` - route parameters extracted from the current
	`94`	+ * - `{Array.<Object>}` - route parameters extracted from the current
`95`	`95`	* `$location.path()` by applying the current route
`96`	`96`	`*`
`97`	`97`	* - `resolve` - `{Object.<string, function>=}` - An optional map of dependencies which should
`@@ -248,7 +248,7 @@ function $RouteProvider(){`
`248`	`248`	* - `$scope` - The current route scope.
`249`	`249`	* - `$template` - The current route template HTML.
`250`	`250`	`*`
`251`		`- * @property {Array.<Object>} routes Array of all configured routes.`
	`251`	`+ * @property {Array.<Object>} routes Array of all configured routes.`
`252`	`252`	`*`
`253`	`253`	`* @description`
`254`	`254`	* `$route` is used for deep-linking URLs to controllers and views (HTML partials).