aboutsummaryrefslogtreecommitdiffstats
path: root/src/Angular.js
diff options
context:
space:
mode:
authorPete Bacon Darwin2013-09-05 12:18:56 +0100
committerPete Bacon Darwin2013-09-05 12:18:56 +0100
commit327a78604a2a3eed5af7477266e226a458417590 (patch)
treec2861841c40a39491c053093866a5717c3346226 /src/Angular.js
parentd72fc304e093165a73a3ae5dd37bc0b289aa1c63 (diff)
downloadangular.js-327a78604a2a3eed5af7477266e226a458417590.tar.bz2
docs(angular.bootstrap): clarify modules parameter
It was not clear what you could pass to specify modules to load in the `module` parameter of this function. The `modules` parameter takes an array. The main case is to provide a String, which is the name of a "predefined" angular module. The side cases are to provide a Function (or an annotated function in the form of an Array), which will be invoked by the injector as a run block. It is not possible to "define" new modules via this parameter. Closes #3692
Diffstat (limited to 'src/Angular.js')
-rw-r--r--src/Angular.js4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/Angular.js b/src/Angular.js
index 9e2f93f2..0a61d5a9 100644
--- a/src/Angular.js
+++ b/src/Angular.js
@@ -1053,7 +1053,9 @@ function angularInit(element, bootstrap) {
* They must use {@link api/ng.directive:ngApp ngApp}.
*
* @param {Element} element DOM element which is the root of angular application.
- * @param {Array<String|Function>=} modules an array of module declarations. See: {@link angular.module modules}
+ * @param {Array<String|Function|Array>=} modules an array of modules to load into the application.
+ * Each item in the array should be the name of a predefined module or a (DI annotated)
+ * function that will be invoked by the injector as a run block. See: {@link angular.module modules}
* @returns {AUTO.$injector} Returns the newly created injector for this app.
*/
function bootstrap(element, modules) {