Skip to content

Commit a251df9

Browse files
committed
docs: api docs for Renderer and all the related apis
Closes angular#4459
1 parent a110ce9 commit a251df9

4 files changed

Lines changed: 249 additions & 57 deletions

File tree

modules/angular2/src/core/linker/element_ref.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,16 @@ export class ElementRef implements RenderElementRef {
5454
* <div class="callout is-critical">
5555
* <header>Use with caution</header>
5656
* <p>
57-
* Use this api as the last resort when direct access to DOM is needed. Use templating and
58-
* data-binding provided by Angular instead.
57+
* Use this API as the last resort when direct access to DOM is needed. Use templating and
58+
* data-binding provided by Angular instead. Alternatively you take a look at {@link Renderer}
59+
* which provides API that can safely be used even when direct access to native elements is not
60+
* supported.
5961
* </p>
6062
* <p>
6163
* Relying on direct DOM access creates tight coupling between your application and rendering
6264
* layers which will make it impossible to separate the two and deploy your application into a
6365
* web worker.
6466
* </p>
65-
* <!-- TODO: add info about custom renderers that should be used instead -->
6667
* </div>
6768
*/
6869
get nativeElement(): any { return this._renderer.getNativeElementSync(this); }

modules/angular2/src/core/metadata/view.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {ViewEncapsulation} from 'angular2/src/core/render/api';
44
export {ViewEncapsulation} from 'angular2/src/core/render/api';
55

66
/**
7-
* Declares the available HTML templates for an application.
7+
* Metadata properties available for configuring Views.
88
*
99
* Each Angular component requires a single `@Component` and at least one `@View` annotation. The
1010
* `@View` annotation specifies the HTML template to use, and lists the directives that are active
@@ -39,19 +39,23 @@ export class ViewMetadata {
3939
/**
4040
* Specifies a template URL for an Angular component.
4141
*
42-
* NOTE: either `templateUrl` or `template` should be used, but not both.
42+
* NOTE: Only one of `templateUrl` or `template` can be defined per View.
43+
*
44+
* <!-- TODO: what's the url relative to? -->
4345
*/
4446
templateUrl: string;
4547

4648
/**
4749
* Specifies an inline template for an Angular component.
4850
*
49-
* NOTE: either `templateUrl` or `template` should be used, but not both.
51+
* NOTE: Only one of `templateUrl` or `template` can be defined per View.
5052
*/
5153
template: string;
5254

5355
/**
5456
* Specifies stylesheet URLs for an Angular component.
57+
*
58+
* <!-- TODO: what's the url relative to? -->
5559
*/
5660
styleUrls: string[];
5761

0 commit comments

Comments
 (0)