12
12
13
13
* @param {Array.<string|Function> } modules A list of module functions or their aliases. See
14
14
* {@link angular.module}. The `ng` module must be explicitly added.
15
- * @returns {function() } Injector function. See {@link AUTO .$injector $injector}.
15
+ * @returns {function() } Injector function. See {@link auto .$injector $injector}.
16
16
*
17
17
* @example
18
18
* Typical usage
53
53
54
54
55
55
/**
56
- * @ngdoc overview
57
- * @name AUTO
56
+ * @ngdoc module
57
+ * @name auto
58
58
* @description
59
59
*
60
- * Implicit module which gets automatically added to each {@link AUTO .$injector $injector}.
60
+ * Implicit module which gets automatically added to each {@link auto .$injector $injector}.
61
61
*/
62
62
63
63
var FN_ARGS = / ^ f u n c t i o n \s * [ ^ \( ] * \( \s * ( [ ^ \) ] * ) \) / m;
@@ -98,14 +98,14 @@ function annotate(fn) {
98
98
///////////////////////////////////////
99
99
100
100
/**
101
- * @ngdoc object
102
- * @name AUTO. $injector
101
+ * @ngdoc service
102
+ * @name $injector
103
103
* @function
104
104
*
105
105
* @description
106
106
*
107
107
* `$injector` is used to retrieve object instances as defined by
108
- * {@link AUTO .$provide provider}, instantiate types, invoke methods,
108
+ * {@link auto .$provide provider}, instantiate types, invoke methods,
109
109
* and load modules.
110
110
*
111
111
* The following always holds true:
@@ -151,8 +151,7 @@ function annotate(fn) {
151
151
152
152
/**
153
153
* @ngdoc method
154
- * @name AUTO.$injector#get
155
- * @methodOf AUTO.$injector
154
+ * @name $injector#get
156
155
*
157
156
* @description
158
157
* Return an instance of the service.
@@ -163,8 +162,7 @@ function annotate(fn) {
163
162
164
163
/**
165
164
* @ngdoc method
166
- * @name AUTO.$injector#invoke
167
- * @methodOf AUTO.$injector
165
+ * @name $injector#invoke
168
166
*
169
167
* @description
170
168
* Invoke the method and supply the method arguments from the `$injector`.
@@ -179,8 +177,7 @@ function annotate(fn) {
179
177
180
178
/**
181
179
* @ngdoc method
182
- * @name AUTO.$injector#has
183
- * @methodOf AUTO.$injector
180
+ * @name $injector#has
184
181
*
185
182
* @description
186
183
* Allows the user to query if the particular service exist.
@@ -191,8 +188,7 @@ function annotate(fn) {
191
188
192
189
/**
193
190
* @ngdoc method
194
- * @name AUTO.$injector#instantiate
195
- * @methodOf AUTO.$injector
191
+ * @name $injector#instantiate
196
192
* @description
197
193
* Create a new instance of JS type. The method takes a constructor function invokes the new
198
194
* operator and supplies all of the arguments to the constructor function as specified by the
@@ -206,8 +202,7 @@ function annotate(fn) {
206
202
207
203
/**
208
204
* @ngdoc method
209
- * @name AUTO.$injector#annotate
210
- * @methodOf AUTO.$injector
205
+ * @name $injector#annotate
211
206
*
212
207
* @description
213
208
* Returns an array of service names which the function is requesting for injection. This API is
@@ -290,38 +285,38 @@ function annotate(fn) {
290
285
291
286
/**
292
287
* @ngdoc object
293
- * @name AUTO. $provide
288
+ * @name $provide
294
289
*
295
290
* @description
296
291
*
297
- * The {@link AUTO .$provide $provide} service has a number of methods for registering components
298
- * with the {@link AUTO .$injector $injector}. Many of these functions are also exposed on
292
+ * The {@link auto .$provide $provide} service has a number of methods for registering components
293
+ * with the {@link auto .$injector $injector}. Many of these functions are also exposed on
299
294
* {@link angular.Module}.
300
295
*
301
296
* An Angular **service** is a singleton object created by a **service factory**. These **service
302
297
* factories** are functions which, in turn, are created by a **service provider**.
303
298
* The **service providers** are constructor functions. When instantiated they must contain a
304
299
* property called `$get`, which holds the **service factory** function.
305
300
*
306
- * When you request a service, the {@link AUTO .$injector $injector} is responsible for finding the
301
+ * When you request a service, the {@link auto .$injector $injector} is responsible for finding the
307
302
* correct **service provider**, instantiating it and then calling its `$get` **service factory**
308
303
* function to get the instance of the **service**.
309
304
*
310
305
* Often services have no configuration options and there is no need to add methods to the service
311
306
* provider. The provider will be no more than a constructor function with a `$get` property. For
312
- * these cases the {@link AUTO .$provide $provide} service has additional helper methods to register
307
+ * these cases the {@link auto .$provide $provide} service has additional helper methods to register
313
308
* services without specifying a provider.
314
309
*
315
- * * {@link AUTO .$provide#methods_provider provider(provider)} - registers a **service provider** with the
316
- * {@link AUTO .$injector $injector}
317
- * * {@link AUTO .$provide#methods_constant constant(obj)} - registers a value/object that can be accessed by
310
+ * * {@link auto .$provide#methods_provider provider(provider)} - registers a **service provider** with the
311
+ * {@link auto .$injector $injector}
312
+ * * {@link auto .$provide#methods_constant constant(obj)} - registers a value/object that can be accessed by
318
313
* providers and services.
319
- * * {@link AUTO .$provide#methods_value value(obj)} - registers a value/object that can only be accessed by
314
+ * * {@link auto .$provide#methods_value value(obj)} - registers a value/object that can only be accessed by
320
315
* services, not providers.
321
- * * {@link AUTO .$provide#methods_factory factory(fn)} - registers a service **factory function**, `fn`,
316
+ * * {@link auto .$provide#methods_factory factory(fn)} - registers a service **factory function**, `fn`,
322
317
* that will be wrapped in a **service provider** object, whose `$get` property will contain the
323
318
* given factory function.
324
- * * {@link AUTO .$provide#methods_service service(class)} - registers a **constructor function**, `class` that
319
+ * * {@link auto .$provide#methods_service service(class)} - registers a **constructor function**, `class` that
325
320
* that will be wrapped in a **service provider** object, whose `$get` property will instantiate
326
321
* a new object using the given constructor function.
327
322
*
@@ -330,11 +325,10 @@ function annotate(fn) {
330
325
331
326
/**
332
327
* @ngdoc method
333
- * @name AUTO.$provide#provider
334
- * @methodOf AUTO.$provide
328
+ * @name $provide#provider
335
329
* @description
336
330
*
337
- * Register a **provider function** with the {@link AUTO .$injector $injector}. Provider functions
331
+ * Register a **provider function** with the {@link auto .$injector $injector}. Provider functions
338
332
* are constructor functions, whose instances are responsible for "providing" a factory for a
339
333
* service.
340
334
*
@@ -354,16 +348,16 @@ function annotate(fn) {
354
348
* @param {(Object|function()) } provider If the provider is:
355
349
*
356
350
* - `Object`: then it should have a `$get` method. The `$get` method will be invoked using
357
- * {@link AUTO .$injector#invoke $injector.invoke()} when an instance needs to be created.
351
+ * {@link auto .$injector#invoke $injector.invoke()} when an instance needs to be created.
358
352
* - `Constructor`: a new instance of the provider will be created using
359
- * {@link AUTO .$injector#instantiate $injector.instantiate()}, then treated as `object`.
353
+ * {@link auto .$injector#instantiate $injector.instantiate()}, then treated as `object`.
360
354
*
361
355
* @returns {Object } registered provider instance
362
356
363
357
* @example
364
358
*
365
359
* The following example shows how to create a simple event tracking service and register it using
366
- * {@link AUTO .$provide#methods_provider $provide.provider()}.
360
+ * {@link auto .$provide#methods_provider $provide.provider()}.
367
361
*
368
362
* <pre>
369
363
* // Define the eventTracker provider
@@ -427,14 +421,13 @@ function annotate(fn) {
427
421
428
422
/**
429
423
* @ngdoc method
430
- * @name AUTO.$provide#factory
431
- * @methodOf AUTO.$provide
424
+ * @name $provide#factory
432
425
* @description
433
426
*
434
427
* Register a **service factory**, which will be called to return the service instance.
435
428
* This is short for registering a service where its provider consists of only a `$get` property,
436
429
* which is the given service factory function.
437
- * You should use {@link AUTO .$provide#factory $provide.factory(getFn)} if you do not need to
430
+ * You should use {@link auto .$provide#factory $provide.factory(getFn)} if you do not need to
438
431
* configure your service in a provider.
439
432
*
440
433
* @param {string } name The name of the instance.
@@ -462,16 +455,15 @@ function annotate(fn) {
462
455
463
456
/**
464
457
* @ngdoc method
465
- * @name AUTO.$provide#service
466
- * @methodOf AUTO.$provide
458
+ * @name $provide#service
467
459
* @description
468
460
*
469
461
* Register a **service constructor**, which will be invoked with `new` to create the service
470
462
* instance.
471
463
* This is short for registering a service where its provider's `$get` property is the service
472
464
* constructor function that will be used to instantiate the service instance.
473
465
*
474
- * You should use {@link AUTO .$provide#methods_service $provide.service(class)} if you define your service
466
+ * You should use {@link auto .$provide#methods_service $provide.service(class)} if you define your service
475
467
* as a type/class.
476
468
*
477
469
* @param {string } name The name of the instance.
@@ -480,7 +472,7 @@ function annotate(fn) {
480
472
*
481
473
* @example
482
474
* Here is an example of registering a service using
483
- * {@link AUTO .$provide#methods_service $provide.service(class)}.
475
+ * {@link auto .$provide#methods_service $provide.service(class)}.
484
476
* <pre>
485
477
* var Ping = function($http) {
486
478
* this.$http = $http;
@@ -504,19 +496,18 @@ function annotate(fn) {
504
496
505
497
/**
506
498
* @ngdoc method
507
- * @name AUTO.$provide#value
508
- * @methodOf AUTO.$provide
499
+ * @name $provide#value
509
500
* @description
510
501
*
511
- * Register a **value service** with the {@link AUTO .$injector $injector}, such as a string, a
502
+ * Register a **value service** with the {@link auto .$injector $injector}, such as a string, a
512
503
* number, an array, an object or a function. This is short for registering a service where its
513
504
* provider's `$get` property is a factory function that takes no arguments and returns the **value
514
505
* service**.
515
506
*
516
507
* Value services are similar to constant services, except that they cannot be injected into a
517
508
* module configuration function (see {@link angular.Module#config}) but they can be overridden by
518
509
* an Angular
519
- * {@link AUTO .$provide#decorator decorator}.
510
+ * {@link auto .$provide#decorator decorator}.
520
511
*
521
512
* @param {string } name The name of the instance.
522
513
* @param {* } value The value.
@@ -538,14 +529,13 @@ function annotate(fn) {
538
529
539
530
/**
540
531
* @ngdoc method
541
- * @name AUTO.$provide#constant
542
- * @methodOf AUTO.$provide
532
+ * @name $provide#constant
543
533
* @description
544
534
*
545
535
* Register a **constant service**, such as a string, a number, an array, an object or a function,
546
- * with the {@link AUTO .$injector $injector}. Unlike {@link AUTO .$provide#value value} it can be
536
+ * with the {@link auto .$injector $injector}. Unlike {@link auto .$provide#value value} it can be
547
537
* injected into a module configuration function (see {@link angular.Module#config}) and it cannot
548
- * be overridden by an Angular {@link AUTO .$provide#decorator decorator}.
538
+ * be overridden by an Angular {@link auto .$provide#decorator decorator}.
549
539
*
550
540
* @param {string } name The name of the constant.
551
541
* @param {* } value The constant value.
@@ -567,19 +557,18 @@ function annotate(fn) {
567
557
568
558
/**
569
559
* @ngdoc method
570
- * @name AUTO.$provide#decorator
571
- * @methodOf AUTO.$provide
560
+ * @name $provide#decorator
572
561
* @description
573
562
*
574
- * Register a **service decorator** with the {@link AUTO .$injector $injector}. A service decorator
563
+ * Register a **service decorator** with the {@link auto .$injector $injector}. A service decorator
575
564
* intercepts the creation of a service, allowing it to override or modify the behaviour of the
576
565
* service. The object returned by the decorator may be the original service, or a new service
577
566
* object which replaces or wraps and delegates to the original service.
578
567
*
579
568
* @param {string } name The name of the service to decorate.
580
569
* @param {function() } decorator This function will be invoked when the service needs to be
581
570
* instantiated and should return the decorated service instance. The function is called using
582
- * the {@link AUTO .$injector#invoke injector.invoke} method and is therefore fully injectable.
571
+ * the {@link auto .$injector#invoke injector.invoke} method and is therefore fully injectable.
583
572
* Local injection arguments:
584
573
*
585
574
* * `$delegate` - The original service instance, which can be monkey patched, configured,
0 commit comments