From 749dec7dfb0c4c76e6110e7f702cbd46c0dd6a6b Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 7 Jul 2016 23:02:35 -0700 Subject: [PATCH] doc(api): fix invalid doc links (#9873) Errors were reported during API doc generation. --- .../common/src/forms-deprecated/directives/ng_form.ts | 2 +- modules/@angular/core/src/di/provider.ts | 2 +- modules/@angular/core/src/di/reflective_exceptions.ts | 4 ++-- modules/@angular/core/src/di/reflective_provider.ts | 2 +- modules/@angular/core/src/linker/compiler.ts | 5 ++--- modules/@angular/core/src/metadata.ts | 8 ++++---- modules/@angular/core/src/metadata/directives.ts | 4 ++-- modules/@angular/core/src/metadata/view.ts | 2 +- modules/@angular/facade/src/lang.dart | 2 +- modules/@angular/forms/src/directives/ng_form.ts | 2 +- modules/@angular/platform-browser/src/browser.ts | 5 +++-- modules/@angular/platform-server/src/server.ts | 2 +- modules/@angular/router-deprecated/router.ts | 4 ++-- modules/@angular/router/src/router.ts | 2 +- modules/@angular/router/src/url_tree.ts | 4 ++-- 15 files changed, 25 insertions(+), 25 deletions(-) diff --git a/modules/@angular/common/src/forms-deprecated/directives/ng_form.ts b/modules/@angular/common/src/forms-deprecated/directives/ng_form.ts index b9a5b1505a..1ce5c54759 100644 --- a/modules/@angular/common/src/forms-deprecated/directives/ng_form.ts +++ b/modules/@angular/common/src/forms-deprecated/directives/ng_form.ts @@ -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 diff --git a/modules/@angular/core/src/di/provider.ts b/modules/@angular/core/src/di/provider.ts index 4361022686..ab44021431 100644 --- a/modules/@angular/core/src/di/provider.ts +++ b/modules/@angular/core/src/di/provider.ts @@ -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 */ diff --git a/modules/@angular/core/src/di/reflective_exceptions.ts b/modules/@angular/core/src/di/reflective_exceptions.ts index 97f8ffa274..997f1aef02 100644 --- a/modules/@angular/core/src/di/reflective_exceptions.ts +++ b/modules/@angular/core/src/di/reflective_exceptions.ts @@ -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)) * diff --git a/modules/@angular/core/src/di/reflective_provider.ts b/modules/@angular/core/src/di/reflective_provider.ts index c394116ad5..a2a5f304f4 100644 --- a/modules/@angular/core/src/di/reflective_provider.ts +++ b/modules/@angular/core/src/di/reflective_provider.ts @@ -68,7 +68,7 @@ export interface ResolvedReflectiveProvider { } /** - * See {@link ResolvedProvider} instead. + * See {@link ResolvedReflectiveProvider} instead. * * @deprecated */ diff --git a/modules/@angular/core/src/linker/compiler.ts b/modules/@angular/core/src/linker/compiler.ts index a9f59f140e..4e3e4c7be0 100644 --- a/modules/@angular/core/src/linker/compiler.ts +++ b/modules/@angular/core/src/linker/compiler.ts @@ -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(component: ConcreteType): ComponentFactory { 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(moduleType: ConcreteType, metadata: AppModuleMetadata = null): AppModuleFactory { diff --git a/modules/@angular/core/src/metadata.ts b/modules/@angular/core/src/metadata.ts index 99d8c384c2..1a6b59bd10 100644 --- a/modules/@angular/core/src/metadata.ts +++ b/modules/@angular/core/src/metadata.ts @@ -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. * diff --git a/modules/@angular/core/src/metadata/directives.ts b/modules/@angular/core/src/metadata/directives.ts index cfa4112fea..d6515e7c12 100644 --- a/modules/@angular/core/src/metadata/directives.ts +++ b/modules/@angular/core/src/metadata/directives.ts @@ -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. * diff --git a/modules/@angular/core/src/metadata/view.ts b/modules/@angular/core/src/metadata/view.ts index 4747945c74..253fe5c926 100644 --- a/modules/@angular/core/src/metadata/view.ts +++ b/modules/@angular/core/src/metadata/view.ts @@ -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 diff --git a/modules/@angular/facade/src/lang.dart b/modules/@angular/facade/src/lang.dart index 1a53c9fcef..a1b7670e6b 100644 --- a/modules/@angular/facade/src/lang.dart +++ b/modules/@angular/facade/src/lang.dart @@ -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 values) { diff --git a/modules/@angular/forms/src/directives/ng_form.ts b/modules/@angular/forms/src/directives/ng_form.ts index 201f1f5042..c2511d66a1 100644 --- a/modules/@angular/forms/src/directives/ng_form.ts +++ b/modules/@angular/forms/src/directives/ng_form.ts @@ -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 diff --git a/modules/@angular/platform-browser/src/browser.ts b/modules/@angular/platform-browser/src/browser.ts index e52af7bd95..4c48cb4dce 100644 --- a/modules/@angular/platform-browser/src/browser.ts +++ b/modules/@angular/platform-browser/src/browser.ts @@ -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 = [ /** * 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. */ diff --git a/modules/@angular/platform-server/src/server.ts b/modules/@angular/platform-server/src/server.ts index f4db931e29..33f2f59d9d 100644 --- a/modules/@angular/platform-server/src/server.ts +++ b/modules/@angular/platform-server/src/server.ts @@ -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 = [ diff --git a/modules/@angular/router-deprecated/router.ts b/modules/@angular/router-deprecated/router.ts index bf5ead9dd8..ae44062af9 100644 --- a/modules/@angular/router-deprecated/router.ts +++ b/modules/@angular/router-deprecated/router.ts @@ -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)) * diff --git a/modules/@angular/router/src/router.ts b/modules/@angular/router/src/router.ts index 781c99ec31..8f66bada39 100644 --- a/modules/@angular/router/src/router.ts +++ b/modules/@angular/router/src/router.ts @@ -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 */ diff --git a/modules/@angular/router/src/url_tree.ts b/modules/@angular/router/src/url_tree.ts index 118b98a731..69759449c8 100644 --- a/modules/@angular/router/src/url_tree.ts +++ b/modules/@angular/router/src/url_tree.ts @@ -159,12 +159,12 @@ export function mapChildrenIntoArray( */ 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; }