doc(injector): adds strictDi documentation to appropriate methods.

rkirov · rkirov · commit 920b59508075 · 2014-11-22T14:01:37.000-08:00
Closes angular#9624
diff --git a/src/Angular.js b/src/Angular.js
@@ -1332,7 +1332,7 @@ function angularInit(element, bootstrap) {
  *     following keys are supported:
  *
  *     - `strictDi`: disable automatic function annotation for the application. This is meant to
- *       assist in finding bugs which break minified code.
+ *       assist in finding bugs which break minified code. Defaults to false.
  *
  * @returns {auto.$injector} Returns the newly created injector for this app.
  */
diff --git a/src/auto/injector.js b/src/auto/injector.js
@@ -10,9 +10,10 @@
  * Creates an injector object that can be used for retrieving services as well as for
  * dependency injection (see {@link guide/di dependency injection}).
  *
-
  * @param {Array.<string|Function>} modules A list of module functions or their aliases. See
- *        {@link angular.module}. The `ng` module must be explicitly added.
+ *     {@link angular.module}. The `ng` module must be explicitly added.
+ * @param {boolean=} [strictDi=false] Whether the injector should be in strict mode, which
+ *     disallows argument name annotation inference.
  * @returns {injector} Injector object. See {@link auto.$injector $injector}.
  *
  * @example
@@ -158,8 +159,10 @@ function annotate(fn, strictDi, name) {
  * ## Inference
  *
  * In JavaScript calling `toString()` on a function returns the function definition. The definition
- * can then be parsed and the function arguments can be extracted. *NOTE:* This does not work with
- * minification, and obfuscation tools since these tools change the argument names.
+ * can then be parsed and the function arguments can be extracted. This method of discovering
+ * annotations is disallowed when the injector is in strict mode.
+ * *NOTE:* This does not work with minification, and obfuscation tools since these tools change the
+ * argument names.
  *
  * ## `$inject` Annotation
  * By adding an `$inject` property onto a function the injection parameters can be specified.
@@ -244,6 +247,8 @@ function annotate(fn, strictDi, name) {
  *   expect(injector.annotate(MyController)).toEqual(['$scope', '$route']);
  * ```
  *
+ * You can disallow this method by using strict injection mode.
+ *
  * This method does not work with code minification / obfuscation. For this reason the following
  * annotation strategies are supported.
  *
@@ -296,6 +301,8 @@ function annotate(fn, strictDi, name) {
  * @param {Function|Array.<string|Function>} fn Function for which dependent service names need to
  * be retrieved as described above.
  *
+ * @param {boolean=} [strictDi=false] Disallow argument name annotation inference.
+ *
  * @returns {Array.<string>} The names of the services which the function requires.
  */
 

Original file line number	Diff line number	Diff line change
`@@ -1332,7 +1332,7 @@ function angularInit(element, bootstrap) {`
`1332`	`1332`	`* following keys are supported:`
`1333`	`1333`	`*`
`1334`	`1334`	* - `strictDi`: disable automatic function annotation for the application. This is meant to
`1335`		`- * assist in finding bugs which break minified code.`
	`1335`	`+ * assist in finding bugs which break minified code. Defaults to false.`
`1336`	`1336`	`*`
`1337`	`1337`	`* @returns {auto.$injector} Returns the newly created injector for this app.`
`1338`	`1338`	`*/`