docs(docgen): tell dgeni to use ts files and fix some bad links
This commit is contained in:
parent
e67b7e87b2
commit
b746e0c9f0
|
@ -5,15 +5,15 @@ module.exports = new Package('angular-public', [basePackage])
|
||||||
|
|
||||||
.config(function(readTypeScriptModules) {
|
.config(function(readTypeScriptModules) {
|
||||||
readTypeScriptModules.sourceFiles = [
|
readTypeScriptModules.sourceFiles = [
|
||||||
'angular2/annotations.js',
|
'angular2/annotations.ts',
|
||||||
'angular2/change_detection.ts',
|
'angular2/change_detection.ts',
|
||||||
'angular2/core.js',
|
'angular2/core.ts',
|
||||||
'angular2/di.ts',
|
'angular2/di.ts',
|
||||||
'angular2/directives.js',
|
'angular2/directives.ts',
|
||||||
'angular2/forms.js',
|
'angular2/forms.ts',
|
||||||
'angular2/router.js',
|
'angular2/router.js',
|
||||||
'angular2/test.js',
|
'angular2/test.ts',
|
||||||
'angular2/pipes.js'
|
'angular2/pipes.ts'
|
||||||
];
|
];
|
||||||
readTypeScriptModules.hidePrivateMembers = true;
|
readTypeScriptModules.hidePrivateMembers = true;
|
||||||
})
|
})
|
||||||
|
@ -25,4 +25,4 @@ module.exports = new Package('angular-public', [basePackage])
|
||||||
// Configure file writing
|
// Configure file writing
|
||||||
.config(function(writeFilesProcessor) {
|
.config(function(writeFilesProcessor) {
|
||||||
writeFilesProcessor.outputFolder = 'dist/public_docs';
|
writeFilesProcessor.outputFolder = 'dist/public_docs';
|
||||||
});
|
});
|
||||||
|
|
|
@ -5,8 +5,8 @@
|
||||||
*
|
*
|
||||||
* Annotations provide the additional information that Angular requires in order to run your
|
* Annotations provide the additional information that Angular requires in order to run your
|
||||||
* application. This module
|
* application. This module
|
||||||
* contains {@link Component}, {@link Directive}, and {@link View} annotations, as well as {@link
|
* contains {@link Component}, {@link Directive}, and {@link View} annotations, as well as
|
||||||
* Parent} and {@link Ancestor} annotations that are
|
* {@link Parent} and {@link Ancestor} annotations that are
|
||||||
* used by Angular to resolve dependencies.
|
* used by Angular to resolve dependencies.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -69,8 +69,8 @@ import {DEFAULT} from 'angular2/change_detection';
|
||||||
*
|
*
|
||||||
* To inject element-specific special objects, declare the constructor parameter as:
|
* To inject element-specific special objects, declare the constructor parameter as:
|
||||||
* - `element: ElementRef` to obtain a reference to logical element in the view.
|
* - `element: ElementRef` to obtain a reference to logical element in the view.
|
||||||
* - `viewContainer: ViewContainerRef` to control child template instantiation, for {@link
|
* - `viewContainer: ViewContainerRef` to control child template instantiation, for
|
||||||
* Directive} directives only
|
* {@link Directive} directives only
|
||||||
* - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
|
* - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
|
||||||
*
|
*
|
||||||
* ## Example
|
* ## Example
|
||||||
|
@ -514,7 +514,7 @@ export class Directive extends Injectable {
|
||||||
* For example, we could write a binding that updates the directive on structural changes, rather
|
* For example, we could write a binding that updates the directive on structural changes, rather
|
||||||
* than on reference changes, as normally occurs in change detection.
|
* than on reference changes, as normally occurs in change detection.
|
||||||
*
|
*
|
||||||
* See {@link Pipe} and {@link keyValDiff} documentation for more details.
|
* See {@link Pipe} and {@link pipes/keyValDiff} documentation for more details.
|
||||||
*
|
*
|
||||||
* ```
|
* ```
|
||||||
* @Directive({
|
* @Directive({
|
||||||
|
@ -705,7 +705,7 @@ export class Directive extends Injectable {
|
||||||
/**
|
/**
|
||||||
* Specifies a set of lifecycle hostListeners in which the directive participates.
|
* Specifies a set of lifecycle hostListeners in which the directive participates.
|
||||||
*
|
*
|
||||||
* See {@link onChange}, {@link onDestroy}, {@link onAllChangesDone} for details.
|
* See {@link annotations/onChange}, {@link annotations/onDestroy}, {@link annotations/onAllChangesDone} for details.
|
||||||
*/
|
*/
|
||||||
lifecycle: List<LifecycleEvent>;
|
lifecycle: List<LifecycleEvent>;
|
||||||
|
|
||||||
|
@ -787,8 +787,8 @@ export class Directive extends Injectable {
|
||||||
* When a component is instantiated, Angular
|
* When a component is instantiated, Angular
|
||||||
* - creates a shadow DOM for the component.
|
* - creates a shadow DOM for the component.
|
||||||
* - loads the selected template into the shadow DOM.
|
* - loads the selected template into the shadow DOM.
|
||||||
* - creates a child {@link Injector} which is configured with the `appInjector` for the {@link
|
* - creates a child {@link Injector} which is configured with the `appInjector` for the
|
||||||
* Component}.
|
* {@link Component}.
|
||||||
*
|
*
|
||||||
* All template expressions and statements are then evaluated against the component instance.
|
* All template expressions and statements are then evaluated against the component instance.
|
||||||
*
|
*
|
||||||
|
|
|
@ -4,13 +4,11 @@ import {ABSTRACT, CONST, Type} from 'angular2/src/facade/lang';
|
||||||
* Declares the available HTML templates for an application.
|
* Declares the available HTML templates for an application.
|
||||||
*
|
*
|
||||||
* Each angular component requires a single `@Component` and at least one `@View` annotation. The
|
* Each angular component requires a single `@Component` and at least one `@View` annotation. The
|
||||||
* @View
|
* `@View` annotation specifies the HTML template to use, and lists the directives that are active
|
||||||
* annotation specifies the HTML template to use, and lists the directives that are active within
|
* within the template.
|
||||||
* the template.
|
|
||||||
*
|
*
|
||||||
* When a component is instantiated, the template is loaded into the component's shadow root, and
|
* When a component is instantiated, the template is loaded into the component's shadow root, and
|
||||||
* the
|
* the expressions and statements in the template are evaluated against the component.
|
||||||
* expressions and statements in the template are evaluated against the component.
|
|
||||||
*
|
*
|
||||||
* For details on the `@Component` annotation, see {@link Component}.
|
* For details on the `@Component` annotation, see {@link Component}.
|
||||||
*
|
*
|
||||||
|
|
|
@ -115,8 +115,8 @@ export class Injector {
|
||||||
* Creates an injector from previously resolved bindings. This bypasses resolution and flattening.
|
* Creates an injector from previously resolved bindings. This bypasses resolution and flattening.
|
||||||
* This API is the recommended way to construct injectors in performance-sensitive parts.
|
* This API is the recommended way to construct injectors in performance-sensitive parts.
|
||||||
*
|
*
|
||||||
* @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the {@link
|
* @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the
|
||||||
*Injector}.
|
* {@link Injector}.
|
||||||
* @param `defaultBindings` Setting to true will auto-create bindings.
|
* @param `defaultBindings` Setting to true will auto-create bindings.
|
||||||
*/
|
*/
|
||||||
static fromResolvedBindings(bindings: List<ResolvedBinding>,
|
static fromResolvedBindings(bindings: List<ResolvedBinding>,
|
||||||
|
@ -125,8 +125,8 @@ export class Injector {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the {@link
|
* @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the
|
||||||
* Injector}.
|
* {@link Injector}.
|
||||||
* @param `parent` Parent Injector or `null` if root Injector.
|
* @param `parent` Parent Injector or `null` if root Injector.
|
||||||
* @param `defaultBindings` Setting to true will auto-create bindings. (Only use with root
|
* @param `defaultBindings` Setting to true will auto-create bindings. (Only use with root
|
||||||
* injector.)
|
* injector.)
|
||||||
|
|
|
@ -4,8 +4,8 @@ import {ControlDirective} from './control_directive';
|
||||||
import {ControlValueAccessor} from './control_value_accessor';
|
import {ControlValueAccessor} from './control_value_accessor';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The default accessor for writing a value and listening to changes that is used by a {@link
|
* The default accessor for writing a value and listening to changes that is used by a
|
||||||
* Control} directive.
|
* {@link Control} directive.
|
||||||
*
|
*
|
||||||
* This is the default strategy that Angular uses when no other accessor is applied.
|
* This is the default strategy that Angular uses when no other accessor is applied.
|
||||||
*
|
*
|
||||||
|
@ -38,4 +38,4 @@ export class DefaultValueAccessor implements ControlValueAccessor {
|
||||||
}
|
}
|
||||||
|
|
||||||
registerOnChange(fn) { this.onChange = fn; }
|
registerOnChange(fn) { this.onChange = fn; }
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,8 +4,8 @@ import {ControlDirective} from './control_directive';
|
||||||
import {ControlValueAccessor} from './control_value_accessor';
|
import {ControlValueAccessor} from './control_value_accessor';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The accessor for writing a value and listening to changes that is used by a {@link
|
* The accessor for writing a value and listening to changes that is used by a
|
||||||
* Control} directive.
|
* {@link Control} directive.
|
||||||
*
|
*
|
||||||
* This is the default strategy that Angular uses when no other accessor is applied.
|
* This is the default strategy that Angular uses when no other accessor is applied.
|
||||||
*
|
*
|
||||||
|
@ -38,4 +38,4 @@ export class SelectControlValueAccessor implements ControlValueAccessor {
|
||||||
}
|
}
|
||||||
|
|
||||||
registerOnChange(fn) { this.onChange = fn; }
|
registerOnChange(fn) { this.onChange = fn; }
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue