diff options
| author | Igor Minar | 2012-01-15 23:28:10 -0800 |
|---|---|---|
| committer | Igor Minar | 2012-01-17 09:49:37 -0800 |
| commit | 92af30ce6e99676c71c85bd08962b68629564908 (patch) | |
| tree | 4adf4b56cbf7c9fb6ee9dee8f40dd16fb2199842 /src/loader.js | |
| parent | 54581d36df74ac128a078aafb3e4b66e0b1599f3 (diff) | |
| download | angular.js-92af30ce6e99676c71c85bd08962b68629564908.tar.bz2 | |
docs(*): various doc fixes
Diffstat (limited to 'src/loader.js')
| -rw-r--r-- | src/loader.js | 30 |
1 files changed, 18 insertions, 12 deletions
diff --git a/src/loader.js b/src/loader.js index e6662aae..69ae024f 100644 --- a/src/loader.js +++ b/src/loader.js @@ -24,38 +24,43 @@ function setupModuleLoader(window) { * @description * * The `angular.module` is a global place for registering angular modules. All modules - * (angular core or 3rd party) that should be available to an application must be registered using this mechanism. + * (angular core or 3rd party) that should be available to an application must be registered + * using this mechanism. + * * * # Module * - * A module is a collocation of services, directives, filters, and configure information. Module is used to configure the, - * {@link angular.module.AUTO.$injector $injector}. + * A module is a collocation of services, directives, filters, and configure information. Module + * is used to configure the {@link angular.module.AUTO.$injector $injector}. * * <pre> * // Create a new module * var myModule = angular.module('myModule', []); * - * // configure a new service + * // register a new service * myModule.value('appName', 'MyCoolApp'); * * // configure existing services inside initialization blocks. - * myModule.init(function($locationProvider) { + * myModule.config(function($locationProvider) { * // Configure existing providers - * $locationProvider.hashPrefix = '!'; + * $locationProvider.hashPrefix('!'); * }); * </pre> * - * Then you can load your module like this: + * Then you can create an injector and load your modules like this: * * <pre> * var injector = angular.injector(['ng', 'MyModule']) * </pre> * + * However it's more likely that you'll just use {@link angular.directive.ng:app ng:app} or + * {@link angular.bootstrap} to simplify this process for you. + * * @param {!string} name The name of the module to create or retrieve. * @param {Array.<string>=} requires If specified then new module is being created. If unspecified then the * the module is being retrieved for further configuration. - * @param {Function} initFn Option configuration function for the module. Same as - * {@link angular.Module#init Module.init()}. + * @param {Function} configFn Option configuration function for the module. Same as + * {@link angular.Module#config Module#config()}. * @return {angular.Module} */ return function module(name, requires, configFn) { @@ -149,8 +154,8 @@ function setupModuleLoader(window) { * @ngdoc method * @name angular.Module#config * @methodOf angular.Module - * @param {Function} initializationFn Execute this function on module load. Useful for - * service configuration. + * @param {Function} configFn Execute this function on module load. Useful for service + * configuration. * @description * Use this method to register work which needs to be performed on module loading. */ @@ -163,7 +168,8 @@ function setupModuleLoader(window) { * @param {Function} initializationFn Execute this function after injector creation. * Useful for application initialization. * @description - * Use this method to register work which needs to be performed on module loading. + * Use this method to register work which needs to be performed when the injector with + * with the current module is finished loading. */ run: function(block) { runBlocks.push(block); |
