doc(api): fix invalid doc links (#9873)
Errors were reported during API doc generation.
This commit is contained in:
parent
96a9e66616
commit
749dec7dfb
|
@ -31,7 +31,7 @@ let _formWarningDisplayed: boolean = false;
|
|||
*
|
||||
* ### Typical Use
|
||||
*
|
||||
* Include `FORM_DIRECTIVES` in the `directives` section of a {@link View} annotation
|
||||
* Include `FORM_DIRECTIVES` in the `directives` section of a {@link Component} annotation
|
||||
* to use `NgForm` and its associated controls.
|
||||
*
|
||||
* ### Structure
|
||||
|
|
|
@ -259,7 +259,7 @@ export class Binding extends Provider {
|
|||
* to an existing `token`.
|
||||
* See {@link ProviderBuilder} for more details.
|
||||
*
|
||||
* The `token` is most commonly a class or {@link OpaqueToken-class.html}.
|
||||
* The `token` is most commonly a class or {@link OpaqueToken}.
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
|
|
|
@ -73,8 +73,8 @@ export class AbstractProviderError extends BaseException {
|
|||
}
|
||||
|
||||
/**
|
||||
* Thrown when trying to retrieve a dependency by `Key` from {@link Injector}, but the
|
||||
* {@link Injector} does not have a {@link Provider} for {@link Key}.
|
||||
* Thrown when trying to retrieve a dependency by key from {@link Injector}, but the
|
||||
* {@link Injector} does not have a {@link Provider} for the given key.
|
||||
*
|
||||
* ### Example ([live demo](http://plnkr.co/edit/vq8D3FRB9aGbnWJqtEPE?p=preview))
|
||||
*
|
||||
|
|
|
@ -68,7 +68,7 @@ export interface ResolvedReflectiveProvider {
|
|||
}
|
||||
|
||||
/**
|
||||
* See {@link ResolvedProvider} instead.
|
||||
* See {@link ResolvedReflectiveProvider} instead.
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
|
|
|
@ -53,8 +53,7 @@ export class Compiler {
|
|||
}
|
||||
/**
|
||||
* Compiles the given component. All templates have to be either inline or compiled via
|
||||
* `compileComponentAsync` before. Otherwise throws a {@link
|
||||
* CompileSyncComponentStillLoadingError}.
|
||||
* `compileComponentAsync` before. Otherwise throws a {@link ComponentStillLoadingError}.
|
||||
*/
|
||||
compileComponentSync<T>(component: ConcreteType<T>): ComponentFactory<T> {
|
||||
throw new BaseException(
|
||||
|
@ -63,7 +62,7 @@ export class Compiler {
|
|||
/**
|
||||
* Compiles the given App Module. All templates of the components listed in `precompile`
|
||||
* have to be either inline or compiled before via `compileComponentAsync` /
|
||||
* `compileAppModuleAsync`. Otherwise throws a {@link CompileSyncComponentStillLoadingError}.
|
||||
* `compileAppModuleAsync`. Otherwise throws a {@link ComponentStillLoadingError}.
|
||||
*/
|
||||
compileAppModuleSync<T>(moduleType: ConcreteType<T>, metadata: AppModuleMetadata = null):
|
||||
AppModuleFactory<T> {
|
||||
|
|
|
@ -31,7 +31,7 @@ import {Type} from '../src/facade/lang';
|
|||
/**
|
||||
* Interface for the {@link DirectiveMetadata} decorator function.
|
||||
*
|
||||
* See {@link DirectiveFactory}.
|
||||
* See {@link DirectiveMetadataFactory}.
|
||||
*
|
||||
* @stable
|
||||
*/
|
||||
|
@ -64,7 +64,7 @@ export interface ComponentDecorator extends TypeDecorator {
|
|||
/**
|
||||
* Interface for the {@link ViewMetadata} decorator function.
|
||||
*
|
||||
* See {@link ViewFactory}.
|
||||
* See {@link ViewMetadataFactory}.
|
||||
*
|
||||
* @experimental
|
||||
*/
|
||||
|
@ -528,7 +528,7 @@ export interface AppModuleMetadataFactory {
|
|||
*
|
||||
* ## Lifecycle hooks
|
||||
*
|
||||
* When the component class implements some {@link ../../../guide/lifecycle-hooks.html} the
|
||||
* When the component class implements some {@linkDocs guide/lifecycle-hooks} the
|
||||
* callbacks are called by the change detection at defined points in time during the life of the
|
||||
* component.
|
||||
*
|
||||
|
@ -860,7 +860,7 @@ export var Component: ComponentMetadataFactory =
|
|||
*
|
||||
* ## Lifecycle hooks
|
||||
*
|
||||
* When the directive class implements some {@link ../../../guide/lifecycle-hooks.html} the
|
||||
* When the directive class implements some {@linkDocs guide/lifecycle-hooks} the
|
||||
* callbacks are called by the change detection at defined points in time during the life of the
|
||||
* directive.
|
||||
*
|
||||
|
|
|
@ -332,7 +332,7 @@ import {ViewEncapsulation} from './view';
|
|||
*
|
||||
* ## Lifecycle hooks
|
||||
*
|
||||
* When the directive class implements some {@link ../../../guide/lifecycle-hooks.html} the
|
||||
* When the directive class implements some {@linkDocs guide/lifecycle-hooks} the
|
||||
* callbacks are called by the change detection at defined points in time during the life of the
|
||||
* directive.
|
||||
*
|
||||
|
@ -791,7 +791,7 @@ export class DirectiveMetadata extends InjectableMetadata {
|
|||
*
|
||||
* ## Lifecycle hooks
|
||||
*
|
||||
* When the component class implements some {@link ../../../guide/lifecycle-hooks.html} the
|
||||
* When the component class implements some {@linkDocs guide/lifecycle-hooks} the
|
||||
* callbacks are called by the change detection at defined points in time during the life of the
|
||||
* component.
|
||||
*
|
||||
|
|
|
@ -11,7 +11,7 @@ import {Type} from '../facade/lang';
|
|||
|
||||
|
||||
/**
|
||||
* Defines template and style encapsulation options available for Component's {@link View}.
|
||||
* Defines template and style encapsulation options available for Component's {@link Component}.
|
||||
*
|
||||
* See {@link ViewMetadata#encapsulation}.
|
||||
* @stable
|
||||
|
|
|
@ -49,7 +49,7 @@ int serializeEnum(val) {
|
|||
|
||||
/**
|
||||
* Deserializes an enum
|
||||
* val should be the indexed value of the enum (sa returned from @Link{serializeEnum})
|
||||
* val should be the indexed value of the enum (sa returned from @link{serializeEnum})
|
||||
* values should be a map from indexes to values for the enum that you want to deserialize.
|
||||
*/
|
||||
dynamic deserializeEnum(num val, Map<num, dynamic> values) {
|
||||
|
|
|
@ -30,7 +30,7 @@ export const formDirectiveProvider: any =
|
|||
*
|
||||
* ### Typical Use
|
||||
*
|
||||
* Include `FORM_DIRECTIVES` in the `directives` section of a {@link View} annotation
|
||||
* Include `FORM_DIRECTIVES` in the `directives` section of a {@link Component} annotation
|
||||
* to use `NgForm` and its associated controls.
|
||||
*
|
||||
* ### Structure
|
||||
|
|
|
@ -33,7 +33,7 @@ const BROWSER_PLATFORM_MARKER = new OpaqueToken('BrowserPlatformMarker');
|
|||
/**
|
||||
* A set of providers to initialize the Angular platform in a web browser.
|
||||
*
|
||||
* Used automatically by `bootstrap`, or can be passed to {@link platform}.
|
||||
* Used automatically by `bootstrap`, or can be passed to `platform`.
|
||||
*
|
||||
* @experimental API related to bootstrapping are still under review.
|
||||
*/
|
||||
|
@ -57,7 +57,8 @@ export const BROWSER_SANITIZATION_PROVIDERS: Array<any> = [
|
|||
/**
|
||||
* A set of providers to initialize an Angular application in a web browser.
|
||||
*
|
||||
* Used automatically by `bootstrap`, or can be passed to {@link PlatformRef.application}.
|
||||
* Used automatically by `bootstrap`, or can be passed to {@link PlatformRef
|
||||
* PlatformRef.application}.
|
||||
*
|
||||
* @experimental API related to bootstrapping are still under review.
|
||||
*/
|
||||
|
|
|
@ -35,7 +35,7 @@ class ServerPlatformLocation extends PlatformLocation {
|
|||
/**
|
||||
* A set of providers to initialize the Angular platform in a server.
|
||||
*
|
||||
* Used automatically by `serverBootstrap`, or can be passed to {@link platform}.
|
||||
* Used automatically by `serverBootstrap`, or can be passed to `platform`.
|
||||
* @experimental
|
||||
*/
|
||||
export const SERVER_PLATFORM_PROVIDERS: Array<any /*Type | Provider | any[]*/> = [
|
||||
|
|
|
@ -32,8 +32,8 @@ import {RouterLink} from './src/directives/router_link';
|
|||
|
||||
/**
|
||||
* A list of directives. To use the router directives like {@link RouterOutlet} and
|
||||
* {@link RouterLink}, add this to your `directives` array in the {@link View} decorator of your
|
||||
* component.
|
||||
* {@link RouterLink}, add this to your `directives` array in the {@link Component} decorator
|
||||
* of your component.
|
||||
*
|
||||
* ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
|
||||
*
|
||||
|
|
|
@ -113,7 +113,7 @@ export type Event = NavigationStart | NavigationEnd | NavigationCancel | Navigat
|
|||
/**
|
||||
* The `Router` is responsible for mapping URLs to components.
|
||||
*
|
||||
* See {@link Routes) for more details and examples.
|
||||
* See {@link Routes} for more details and examples.
|
||||
*
|
||||
* @stable
|
||||
*/
|
||||
|
|
|
@ -159,12 +159,12 @@ export function mapChildrenIntoArray<T>(
|
|||
*/
|
||||
export abstract class UrlSerializer {
|
||||
/**
|
||||
* Parse a url into a {@Link UrlTree}
|
||||
* Parse a url into a {@link UrlTree}
|
||||
*/
|
||||
abstract parse(url: string): UrlTree;
|
||||
|
||||
/**
|
||||
* Converts a {@Link UrlTree} into a url
|
||||
* Converts a {@link UrlTree} into a url
|
||||
*/
|
||||
abstract serialize(tree: UrlTree): string;
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue