docs(Angular.js): explain that toJson strips $... properties

Spencer Applegate · petebacondarwin · commit 1532ec1dfe6a · 2013-07-01T11:35:16.000+01:00
In Angular.toJson, any properties with a leading '$' character will be
stripped from the resulting string since angular uses this notation
internally for services.  There have been complaints of not knowing
about this functionality until it breaks within their code.
diff --git a/src/Angular.js b/src/Angular.js
@@ -755,7 +755,8 @@ function toJsonReplacer(key, value) {
  * @function
  *
  * @description
- * Serializes input into a JSON-formatted string.
+ * Serializes input into a JSON-formatted string. Properties with leading $ characters will be
+ * stripped since angular uses this notation internally.
  *
  * @param {Object|Array|Date|string|number} obj Input to be serialized into JSON.
  * @param {boolean=} pretty If set to true, the JSON output will contain newlines and whitespace.

Original file line number	Diff line number	Diff line change
`@@ -755,7 +755,8 @@ function toJsonReplacer(key, value) {`
`755`	`755`	`* @function`
`756`	`756`	`*`
`757`	`757`	`* @description`
`758`		`- * Serializes input into a JSON-formatted string.`
	`758`	`+ * Serializes input into a JSON-formatted string. Properties with leading $ characters will be`
	`759`	`+ * stripped since angular uses this notation internally.`
`759`	`760`	`*`
`760`	`761`	`* @param {Object\|Array\|Date\|string\|number} obj Input to be serialized into JSON.`
`761`	`762`	`* @param {boolean=} pretty If set to true, the JSON output will contain newlines and whitespace.`