Skip to content

Commit 457cc99

Browse files
committed
docs(docgen): tell dgeni to use ts files and fix some bad links
1 parent db7a1f1 commit 457cc99

File tree

7 files changed

+28
-30
lines changed

7 files changed

+28
-30
lines changed

docs/public-docs-package/index.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ module.exports = new Package('angular-public', [basePackage])
55

66
.config(function(readTypeScriptModules) {
77
readTypeScriptModules.sourceFiles = [
8-
'angular2/annotations.js',
8+
'angular2/annotations.ts',
99
'angular2/change_detection.ts',
10-
'angular2/core.js',
10+
'angular2/core.ts',
1111
'angular2/di.ts',
12-
'angular2/directives.js',
13-
'angular2/forms.js',
12+
'angular2/directives.ts',
13+
'angular2/forms.ts',
1414
'angular2/router.js',
15-
'angular2/test.js',
16-
'angular2/pipes.js'
15+
'angular2/test.ts',
16+
'angular2/pipes.ts'
1717
];
1818
readTypeScriptModules.hidePrivateMembers = true;
1919
})
@@ -25,4 +25,4 @@ module.exports = new Package('angular-public', [basePackage])
2525
// Configure file writing
2626
.config(function(writeFilesProcessor) {
2727
writeFilesProcessor.outputFolder = 'dist/public_docs';
28-
});
28+
});

modules/angular2/annotations.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
*
66
* Annotations provide the additional information that Angular requires in order to run your
77
* application. This module
8-
* contains {@link Component}, {@link Directive}, and {@link View} annotations, as well as {@link
9-
* Parent} and {@link Ancestor} annotations that are
8+
* contains {@link Component}, {@link Directive}, and {@link View} annotations, as well as
9+
* {@link Parent} and {@link Ancestor} annotations that are
1010
* used by Angular to resolve dependencies.
1111
*
1212
*/

modules/angular2/src/core/annotations_impl/annotations.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ import {DEFAULT} from 'angular2/change_detection';
6969
*
7070
* To inject element-specific special objects, declare the constructor parameter as:
7171
* - `element: ElementRef` to obtain a reference to logical element in the view.
72-
* - `viewContainer: ViewContainerRef` to control child template instantiation, for {@link
73-
* Directive} directives only
72+
* - `viewContainer: ViewContainerRef` to control child template instantiation, for
73+
* {@link Directive} directives only
7474
* - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
7575
*
7676
* ## Example
@@ -514,7 +514,7 @@ export class Directive extends Injectable {
514514
* For example, we could write a binding that updates the directive on structural changes, rather
515515
* than on reference changes, as normally occurs in change detection.
516516
*
517-
* See {@link Pipe} and {@link keyValDiff} documentation for more details.
517+
* See {@link Pipe} and {@link pipes/keyValDiff} documentation for more details.
518518
*
519519
* ```
520520
* @Directive({
@@ -705,7 +705,7 @@ export class Directive extends Injectable {
705705
/**
706706
* Specifies a set of lifecycle hostListeners in which the directive participates.
707707
*
708-
* See {@link onChange}, {@link onDestroy}, {@link onAllChangesDone} for details.
708+
* See {@link annotations/onChange}, {@link annotations/onDestroy}, {@link annotations/onAllChangesDone} for details.
709709
*/
710710
lifecycle: List<LifecycleEvent>;
711711

@@ -787,8 +787,8 @@ export class Directive extends Injectable {
787787
* When a component is instantiated, Angular
788788
* - creates a shadow DOM for the component.
789789
* - loads the selected template into the shadow DOM.
790-
* - creates a child {@link Injector} which is configured with the `appInjector` for the {@link
791-
* Component}.
790+
* - creates a child {@link Injector} which is configured with the `appInjector` for the
791+
* {@link Component}.
792792
*
793793
* All template expressions and statements are then evaluated against the component instance.
794794
*

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@ import {ABSTRACT, CONST, Type} from 'angular2/src/facade/lang';
44
* Declares the available HTML templates for an application.
55
*
66
* Each angular component requires a single `@Component` and at least one `@View` annotation. The
7-
* @View
8-
* annotation specifies the HTML template to use, and lists the directives that are active within
9-
* the template.
7+
* `@View` annotation specifies the HTML template to use, and lists the directives that are active
8+
* within the template.
109
*
1110
* When a component is instantiated, the template is loaded into the component's shadow root, and
12-
* the
13-
* expressions and statements in the template are evaluated against the component.
11+
* the expressions and statements in the template are evaluated against the component.
1412
*
1513
* For details on the `@Component` annotation, see {@link Component}.
1614
*

modules/angular2/src/di/injector.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ export class Injector {
118118
* Creates an injector from previously resolved bindings. This bypasses resolution and flattening.
119119
* This API is the recommended way to construct injectors in performance-sensitive parts.
120120
*
121-
* @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the {@link
122-
*Injector}.
121+
* @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the
122+
* {@link Injector}.
123123
* @param `defaultBindings` Setting to true will auto-create bindings.
124124
*/
125125
static fromResolvedBindings(bindings: List<ResolvedBinding>,
@@ -128,8 +128,8 @@ export class Injector {
128128
}
129129

130130
/**
131-
* @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the {@link
132-
* Injector}.
131+
* @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the
132+
* {@link Injector}.
133133
* @param `parent` Parent Injector or `null` if root Injector.
134134
* @param `defaultBindings` Setting to true will auto-create bindings. (Only use with root
135135
* injector.)

modules/angular2/src/forms/directives/default_value_accessor.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import {ControlDirective} from './control_directive';
44
import {ControlValueAccessor} from './control_value_accessor';
55

66
/**
7-
* The default accessor for writing a value and listening to changes that is used by a {@link
8-
* Control} directive.
7+
* The default accessor for writing a value and listening to changes that is used by a
8+
* {@link Control} directive.
99
*
1010
* This is the default strategy that Angular uses when no other accessor is applied.
1111
*
@@ -38,4 +38,4 @@ export class DefaultValueAccessor implements ControlValueAccessor {
3838
}
3939

4040
registerOnChange(fn) { this.onChange = fn; }
41-
}
41+
}

modules/angular2/src/forms/directives/select_control_value_accessor.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import {ControlDirective} from './control_directive';
44
import {ControlValueAccessor} from './control_value_accessor';
55

66
/**
7-
* The accessor for writing a value and listening to changes that is used by a {@link
8-
* Control} directive.
7+
* The accessor for writing a value and listening to changes that is used by a
8+
* {@link Control} directive.
99
*
1010
* This is the default strategy that Angular uses when no other accessor is applied.
1111
*
@@ -38,4 +38,4 @@ export class SelectControlValueAccessor implements ControlValueAccessor {
3838
}
3939

4040
registerOnChange(fn) { this.onChange = fn; }
41-
}
41+
}

0 commit comments

Comments
 (0)