docs($resource): clarify the meaning of @ in paramDefaults

jsdevel · petebacondarwin · commit 2a6081057f93 · 2014-08-03T17:15:03.000+01:00
Closes angular#8457
diff --git a/src/ngResource/resource.js b/src/ngResource/resource.js
@@ -94,8 +94,10 @@ function shallowClearAndCopy(src, dst) {
  *   Given a template `/path/:verb` and parameter `{verb:'greet', salutation:'Hello'}` results in
  *   URL `/path/greet?salutation=Hello`.
  *
- *   If the parameter value is prefixed with `@` then the value of that parameter will be taken
- *   from the corresponding key on the data object (useful for non-GET operations).
+ *   If the parameter value is prefixed with `@` then the value for that parameter will be extracted
+ *   from the corresponding property on the `data` object (provided when calling an action method).  For
+ *   example, if the `defaultParam` object is `{someParam: '@someProp'}` then the value of `someParam`
+ *   will be `data.someProp`.
  *
  * @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

Original file line number	Diff line number	Diff line change
`@@ -94,8 +94,10 @@ function shallowClearAndCopy(src, dst) {`
`94`	`94`	* Given a template `/path/:verb` and parameter `{verb:'greet', salutation:'Hello'}` results in
`95`	`95`	* URL `/path/greet?salutation=Hello`.
`96`	`96`	`*`
`97`		- * If the parameter value is prefixed with `@` then the value of that parameter will be taken
`98`		`- * from the corresponding key on the data object (useful for non-GET operations).`
	`97`	+ * If the parameter value is prefixed with `@` then the value for that parameter will be extracted
	`98`	+ * from the corresponding property on the `data` object (provided when calling an action method). For
	`99`	+ * example, if the `defaultParam` object is `{someParam: '@someProp'}` then the value of `someParam`
	`100`	+ * will be `data.someProp`.
`99`	`101`	`*`
`100`	`102`	`* @param {Object.<Object>=} actions Hash with declaration of custom action that should extend`
`101`	`103`	`* the default set of resource actions. The declaration should be created in the format of {@link`