X Tutup
Skip to content

Commit 2e641ac

Browse files
petebacondarwinpetebacondarwin
committed
docs(bike-shed-migration): convert doctype and names
1 parent 1ca22a3 commit 2e641ac

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+500
-679
lines changed

‎src/Angular.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
/**
9191
* @ngdoc module
9292
* @name ng
93+
* @module ng
9394
* @description
9495
*
9596
* # ng (core module)
@@ -1134,7 +1135,7 @@ function encodeUriQuery(val, pctEncodeSpaces) {
11341135

11351136
/**
11361137
* @ngdoc directive
1137-
* @name ng.directive:ngApp
1138+
* @name ngApp
11381139
* @module ng
11391140
*
11401141
* @element ANY
@@ -1153,7 +1154,7 @@ function encodeUriQuery(val, pctEncodeSpaces) {
11531154
* {@link angular.bootstrap} instead. AngularJS applications cannot be nested within each other.
11541155
*
11551156
* You can specify an **AngularJS module** to be used as the root module for the application. This
1156-
* module will be loaded into the {@link AUTO.$injector} when the application is bootstrapped and
1157+
* module will be loaded into the {@link auto.$injector} when the application is bootstrapped and
11571158
* should contain the application code needed or have dependencies on other modules that will
11581159
* contain the code. See {@link angular.module} for more information.
11591160
*
@@ -1239,7 +1240,7 @@ function angularInit(element, bootstrap) {
12391240
* Each item in the array should be the name of a predefined module or a (DI annotated)
12401241
* function that will be invoked by the injector as a run block.
12411242
* See: {@link angular.module modules}
1242-
* @returns {AUTO.$injector} Returns the newly created injector for this app.
1243+
* @returns {auto.$injector} Returns the newly created injector for this app.
12431244
*/
12441245
function bootstrap(element, modules) {
12451246
var doBootstrap = function() {

‎src/AngularPublic.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777

7878

7979
/**
80-
* @ngdoc property
80+
* @ngdoc object
8181
* @name angular.version
8282
* @module ng
8383
* @description

‎src/auto/injector.js‎

Lines changed: 42 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
1313
* @param {Array.<string|Function>} modules A list of module functions or their aliases. See
1414
* {@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}.
1616
*
1717
* @example
1818
* Typical usage
@@ -53,11 +53,11 @@
5353

5454

5555
/**
56-
* @ngdoc overview
57-
* @name AUTO
56+
* @ngdoc module
57+
* @name auto
5858
* @description
5959
*
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}.
6161
*/
6262

6363
var FN_ARGS = /^function\s*[^\(]*\(\s*([^\)]*)\)/m;
@@ -98,14 +98,14 @@ function annotate(fn) {
9898
///////////////////////////////////////
9999

100100
/**
101-
* @ngdoc object
102-
* @name AUTO.$injector
101+
* @ngdoc service
102+
* @name $injector
103103
* @function
104104
*
105105
* @description
106106
*
107107
* `$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,
109109
* and load modules.
110110
*
111111
* The following always holds true:
@@ -151,8 +151,7 @@ function annotate(fn) {
151151

152152
/**
153153
* @ngdoc method
154-
* @name AUTO.$injector#get
155-
* @methodOf AUTO.$injector
154+
* @name $injector#get
156155
*
157156
* @description
158157
* Return an instance of the service.
@@ -163,8 +162,7 @@ function annotate(fn) {
163162

164163
/**
165164
* @ngdoc method
166-
* @name AUTO.$injector#invoke
167-
* @methodOf AUTO.$injector
165+
* @name $injector#invoke
168166
*
169167
* @description
170168
* Invoke the method and supply the method arguments from the `$injector`.
@@ -179,8 +177,7 @@ function annotate(fn) {
179177

180178
/**
181179
* @ngdoc method
182-
* @name AUTO.$injector#has
183-
* @methodOf AUTO.$injector
180+
* @name $injector#has
184181
*
185182
* @description
186183
* Allows the user to query if the particular service exist.
@@ -191,8 +188,7 @@ function annotate(fn) {
191188

192189
/**
193190
* @ngdoc method
194-
* @name AUTO.$injector#instantiate
195-
* @methodOf AUTO.$injector
191+
* @name $injector#instantiate
196192
* @description
197193
* Create a new instance of JS type. The method takes a constructor function invokes the new
198194
* operator and supplies all of the arguments to the constructor function as specified by the
@@ -206,8 +202,7 @@ function annotate(fn) {
206202

207203
/**
208204
* @ngdoc method
209-
* @name AUTO.$injector#annotate
210-
* @methodOf AUTO.$injector
205+
* @name $injector#annotate
211206
*
212207
* @description
213208
* Returns an array of service names which the function is requesting for injection. This API is
@@ -290,38 +285,38 @@ function annotate(fn) {
290285

291286
/**
292287
* @ngdoc object
293-
* @name AUTO.$provide
288+
* @name $provide
294289
*
295290
* @description
296291
*
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
299294
* {@link angular.Module}.
300295
*
301296
* An Angular **service** is a singleton object created by a **service factory**. These **service
302297
* factories** are functions which, in turn, are created by a **service provider**.
303298
* The **service providers** are constructor functions. When instantiated they must contain a
304299
* property called `$get`, which holds the **service factory** function.
305300
*
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
307302
* correct **service provider**, instantiating it and then calling its `$get` **service factory**
308303
* function to get the instance of the **service**.
309304
*
310305
* Often services have no configuration options and there is no need to add methods to the service
311306
* 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
313308
* services without specifying a provider.
314309
*
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
318313
* 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
320315
* 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`,
322317
* that will be wrapped in a **service provider** object, whose `$get` property will contain the
323318
* 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
325320
* that will be wrapped in a **service provider** object, whose `$get` property will instantiate
326321
* a new object using the given constructor function.
327322
*
@@ -330,11 +325,10 @@ function annotate(fn) {
330325

331326
/**
332327
* @ngdoc method
333-
* @name AUTO.$provide#provider
334-
* @methodOf AUTO.$provide
328+
* @name $provide#provider
335329
* @description
336330
*
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
338332
* are constructor functions, whose instances are responsible for "providing" a factory for a
339333
* service.
340334
*
@@ -354,16 +348,16 @@ function annotate(fn) {
354348
* @param {(Object|function())} provider If the provider is:
355349
*
356350
* - `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.
358352
* - `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`.
360354
*
361355
* @returns {Object} registered provider instance
362356
363357
* @example
364358
*
365359
* 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()}.
367361
*
368362
* <pre>
369363
* // Define the eventTracker provider
@@ -427,14 +421,13 @@ function annotate(fn) {
427421

428422
/**
429423
* @ngdoc method
430-
* @name AUTO.$provide#factory
431-
* @methodOf AUTO.$provide
424+
* @name $provide#factory
432425
* @description
433426
*
434427
* Register a **service factory**, which will be called to return the service instance.
435428
* This is short for registering a service where its provider consists of only a `$get` property,
436429
* 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
438431
* configure your service in a provider.
439432
*
440433
* @param {string} name The name of the instance.
@@ -462,16 +455,15 @@ function annotate(fn) {
462455

463456
/**
464457
* @ngdoc method
465-
* @name AUTO.$provide#service
466-
* @methodOf AUTO.$provide
458+
* @name $provide#service
467459
* @description
468460
*
469461
* Register a **service constructor**, which will be invoked with `new` to create the service
470462
* instance.
471463
* This is short for registering a service where its provider's `$get` property is the service
472464
* constructor function that will be used to instantiate the service instance.
473465
*
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
475467
* as a type/class.
476468
*
477469
* @param {string} name The name of the instance.
@@ -480,7 +472,7 @@ function annotate(fn) {
480472
*
481473
* @example
482474
* 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)}.
484476
* <pre>
485477
* var Ping = function($http) {
486478
* this.$http = $http;
@@ -504,19 +496,18 @@ function annotate(fn) {
504496

505497
/**
506498
* @ngdoc method
507-
* @name AUTO.$provide#value
508-
* @methodOf AUTO.$provide
499+
* @name $provide#value
509500
* @description
510501
*
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
512503
* number, an array, an object or a function. This is short for registering a service where its
513504
* provider's `$get` property is a factory function that takes no arguments and returns the **value
514505
* service**.
515506
*
516507
* Value services are similar to constant services, except that they cannot be injected into a
517508
* module configuration function (see {@link angular.Module#config}) but they can be overridden by
518509
* an Angular
519-
* {@link AUTO.$provide#decorator decorator}.
510+
* {@link auto.$provide#decorator decorator}.
520511
*
521512
* @param {string} name The name of the instance.
522513
* @param {*} value The value.
@@ -538,14 +529,13 @@ function annotate(fn) {
538529

539530
/**
540531
* @ngdoc method
541-
* @name AUTO.$provide#constant
542-
* @methodOf AUTO.$provide
532+
* @name $provide#constant
543533
* @description
544534
*
545535
* 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
547537
* 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}.
549539
*
550540
* @param {string} name The name of the constant.
551541
* @param {*} value The constant value.
@@ -567,19 +557,18 @@ function annotate(fn) {
567557

568558
/**
569559
* @ngdoc method
570-
* @name AUTO.$provide#decorator
571-
* @methodOf AUTO.$provide
560+
* @name $provide#decorator
572561
* @description
573562
*
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
575564
* intercepts the creation of a service, allowing it to override or modify the behaviour of the
576565
* service. The object returned by the decorator may be the original service, or a new service
577566
* object which replaces or wraps and delegates to the original service.
578567
*
579568
* @param {string} name The name of the service to decorate.
580569
* @param {function()} decorator This function will be invoked when the service needs to be
581570
* 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.
583572
* Local injection arguments:
584573
*
585574
* * `$delegate` - The original service instance, which can be monkey patched, configured,

0 commit comments

Comments
 (0)
X Tutup