Skip to content

Commit c922b5a

Browse files
gjungbpkozlowski-opensource
authored andcommitted
docs(annotations): fix some typos, align docs with code
Closes angular#1227
1 parent d552303 commit c922b5a

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

modules/angular2/src/core/annotations/annotations.js

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ import {Injectable} from 'angular2/di';
2424
* - The terminal [Injector] cannot resolve dependencies. It either throws an error or, if the dependency was
2525
* specified as `@Optional`, returns `null`.
2626
* - The primordial injector resolves browser singleton resources, such as: cookies, title, location, and others.
27-
* - *Component Injectors*: Each `@Component` has its own [Injector], and they follow the same parent-child hierachy
27+
* - *Component Injectors*: Each `@Component` has its own [Injector], and they follow the same parent-child hierarchy
2828
* as the components in the DOM.
2929
* - *Element Injectors*: Each component has a Shadow DOM. Within the Shadow DOM each element has an [ElementInjector]
30-
* which follow the same parent-child hiercachy as the DOM elements themselves.
30+
* which follow the same parent-child hierarchy as the DOM elements themselves.
3131
*
3232
* When a template is instantiated, it also must instantiate the corresponding directives in a depth-first order. The
3333
* current [ElementInjector] resolves the constructor dependencies for each directive.
@@ -46,14 +46,14 @@ import {Injectable} from 'angular2/di';
4646
* To inject other directives, declare the constructor parameter as:
4747
* - `directive:DirectiveType`: a directive on the current element only
4848
* - `@Ancestor() directive:DirectiveType`: any directive that matches the type between the current element and the
49-
* Shadow DOM root. Current Element is not included in the resolution, therefor even if it could resolve it, it will
49+
* Shadow DOM root. Current element is not included in the resolution, therefor even if it could resolve it, it will
5050
* be ignored.
5151
* - `@Parent() directive:DirectiveType`: any directive that matches the type on a direct parent element only.
5252
* - `@Children query:Query<DirectiveType>`: A live collection of direct child directives [TO BE IMPLEMENTED].
5353
* - `@Descendants query:Query<DirectiveType>`: A live collection of any child directives [TO BE IMPLEMENTED].
5454
*
5555
* To inject element-specific special objects, declare the constructor parameter as:
56-
* - `element: NgElement` to obtain a DOM element (DEPRECATED: replacment coming)
56+
* - `element: NgElement` to obtain a DOM element (DEPRECATED: replacement coming)
5757
* - `viewContainer: ViewContainer` to control child template instantiation, for [Viewport] directives only
5858
* - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
5959
*
@@ -322,7 +322,7 @@ export class Directive extends Injectable {
322322
* ```
323323
*
324324
* Whenever the `someExpression` expression changes, the `bind` declaration instructs Angular to update the
325-
* `Tooltip`'s `tooltipText` property.
325+
* `Tooltip`'s `text` property.
326326
*
327327
*
328328
*
@@ -331,7 +331,7 @@ export class Directive extends Injectable {
331331
* You can also use pipes when writing binding definitions for a directive.
332332
*
333333
* For example, we could write a binding that updates the directive on structural changes, rather than on reference
334-
* changes, as normally occurs in change detection. (See: [Pipe] and [keyValueDiff] documentaition for more details.)
334+
* changes, as normally occurs in change detection. (See: [Pipe] and [keyValueDiff] documentation for more details.)
335335
*
336336
* ```
337337
* @Decorator({
@@ -364,11 +364,11 @@ export class Directive extends Injectable {
364364
* The `events` property defines a set of `event` to `method` key-value pairs:
365365
*
366366
* - `event1`: the DOM event that the directive listens to.
367-
* - `statement`: the statment to execute when the event occurs.
367+
* - `statement`: the statement to execute when the event occurs.
368368
*
369369
*
370370
* When writing a directive event binding, you can also refer to the following local variables:
371-
* - `$event`: Current event object which triggerd the event.
371+
* - `$event`: Current event object which triggered the event.
372372
* - `$target`: The source of the event. This will be either a DOM element or an Angular directive.
373373
* [TO BE IMPLEMENTED]
374374
*
@@ -402,7 +402,7 @@ export class Directive extends Injectable {
402402
* }
403403
* ```
404404
*
405-
* Here `InputDecorator` is invoked whenever the DOM element fires the 'change' event.
405+
* Here the `onChange` method of `InputDecorator` is invoked whenever the DOM element fires the 'change' event.
406406
*
407407
*/
408408
events:any; // StringMap
@@ -447,7 +447,7 @@ export class Directive extends Injectable {
447447
/**
448448
* Declare reusable UI building blocks for an application.
449449
*
450-
* Each angular component requires a single `@Component` and at least one `@Template` annotation. The @Component
450+
* Each Angular component requires a single `@Component` and at least one `@Template` annotation. The `@Component`
451451
* annotation specifies when a component is instantiated, and which properties and events it binds to.
452452
*
453453
* When a component is instantiated, Angular
@@ -486,8 +486,8 @@ export class Component extends Directive {
486486
* When a component is instantiated, Angular creates a change detector, which is responsible for propagating
487487
* the component's bindings.
488488
*
489-
* The changeDetection property defines if the change detection will be checked every time or only when the component
490-
* tell it too.
489+
* The `changeDetection` property defines, whether the change detection will be checked every time or only when the component
490+
* tells it to do so.
491491
*/
492492
changeDetection:string;
493493

@@ -571,8 +571,8 @@ export class Component extends Directive {
571571
/**
572572
* Directive used for dynamically loading components.
573573
*
574-
* Regular angular components are statically resolved. DynamicComponent allows to you resolve a component at runtime
575-
* instead by providing a placeholder into which a regular angular component can be dynamically loaded. Once loaded,
574+
* Regular Angular components are statically resolved. DynamicComponent allows to you resolve a component at runtime
575+
* instead by providing a placeholder into which a regular Angular component can be dynamically loaded. Once loaded,
576576
* the dynamically-loaded component becomes permanent and cannot be changed.
577577
*
578578
*
@@ -581,7 +581,7 @@ export class Component extends Directive {
581581
* Here we have `DynamicComp` which acts as the placeholder for `HelloCmp`. At runtime, the dynamic component
582582
* `DynamicComp` requests loading of the `HelloCmp` component.
583583
*
584-
* There is nothing special about `HelloCmp`, which is a regular angular component. It can also be used in other static
584+
* There is nothing special about `HelloCmp`, which is a regular Angular component. It can also be used in other static
585585
* locations.
586586
*
587587
* ```
@@ -660,7 +660,7 @@ export class DynamicComponent extends Directive {
660660
* Decorators differ from [Component]s in that they:
661661
* - can have multiple decorators per element
662662
* - do not create their own evaluation context
663-
* - do not have template (and therefor do not create Shadow DOM)
663+
* - do not have a template (and therefor do not create Shadow DOM)
664664
*
665665
*
666666
* ## Example

0 commit comments

Comments
 (0)