docs: fix link texts

Fixes #19701

PR Close #19709
This commit is contained in:
George Kalpakas 2017-10-13 22:27:38 +03:00 committed by Matias Niemelä
parent 6fbc2b3be0
commit 901436e46f
10 changed files with 47 additions and 47 deletions

View File

@ -13,7 +13,7 @@ import {ComponentRef} from './linker/component_factory';
/** /**
* A DI Token representing a unique string id assigned to the application by Angular and used * A DI Token representing a unique string id assigned to the application by Angular and used
* primarily for prefixing application attributes and CSS styles when * primarily for prefixing application attributes and CSS styles when
* {@link ViewEncapsulation#Emulated} is being used. * {@link ViewEncapsulation#Emulated ViewEncapsulation.Emulated} is being used.
* *
* If you need to avoid randomly generated value to be used as an application id, you can provide * If you need to avoid randomly generated value to be used as an application id, you can provide
* a custom value via a DI provider <!-- TODO: provider --> configuring the root {@link Injector} * a custom value via a DI provider <!-- TODO: provider --> configuring the root {@link Injector}

View File

@ -11,7 +11,7 @@
*/ */
export abstract class ChangeDetectorRef { export abstract class ChangeDetectorRef {
/** /**
* Marks all {@link ChangeDetectionStrategy#OnPush} ancestors as to be checked. * Marks all {@link ChangeDetectionStrategy#OnPush OnPush} ancestors as to be checked.
* *
* <!-- TODO: Add a link to a chapter on OnPush components --> * <!-- TODO: Add a link to a chapter on OnPush components -->
* *
@ -53,9 +53,8 @@ export abstract class ChangeDetectorRef {
* *
* The detached change detector will not be checked until it is reattached. * The detached change detector will not be checked until it is reattached.
* *
* This can also be used in combination with {@link ChangeDetectorRef#detectChanges} to implement * This can also be used in combination with {@link ChangeDetectorRef#detectChanges detectChanges}
* local change * to implement local change detection checks.
* detection checks.
* *
* <!-- TODO: Add a link to a chapter on detach/reattach/local digest --> * <!-- TODO: Add a link to a chapter on detach/reattach/local digest -->
* <!-- TODO: Add a live demo once ref.detectChanges is merged into master --> * <!-- TODO: Add a live demo once ref.detectChanges is merged into master -->
@ -106,9 +105,8 @@ export abstract class ChangeDetectorRef {
/** /**
* Checks the change detector and its children. * Checks the change detector and its children.
* *
* This can also be used in combination with {@link ChangeDetectorRef#detach} to implement local * This can also be used in combination with {@link ChangeDetectorRef#detach detach} to implement
* change detection * local change detection checks.
* checks.
* *
* <!-- TODO: Add a link to a chapter on detach/reattach/local digest --> * <!-- TODO: Add a link to a chapter on detach/reattach/local digest -->
* <!-- TODO: Add a live demo once ref.detectChanges is merged into master --> * <!-- TODO: Add a live demo once ref.detectChanges is merged into master -->
@ -123,7 +121,7 @@ export abstract class ChangeDetectorRef {
* check * check
* every five seconds. * every five seconds.
* *
* See {@link ChangeDetectorRef#detach} for more information. * See {@link ChangeDetectorRef#detach detach} for more information.
*/ */
abstract detectChanges(): void; abstract detectChanges(): void;

View File

@ -83,7 +83,7 @@ export abstract class ReflectiveInjector implements Injector {
* }); * });
* ``` * ```
* *
* See {@link ReflectiveInjector#fromResolvedProviders} for more info. * See {@link ReflectiveInjector#fromResolvedProviders fromResolvedProviders} for more info.
*/ */
static resolve(providers: Provider[]): ResolvedReflectiveProvider[] { static resolve(providers: Provider[]): ResolvedReflectiveProvider[] {
return resolveReflectiveProviders(providers); return resolveReflectiveProviders(providers);
@ -113,7 +113,8 @@ export abstract class ReflectiveInjector implements Injector {
* *
* This function is slower than the corresponding `fromResolvedProviders` * This function is slower than the corresponding `fromResolvedProviders`
* because it needs to resolve the passed-in providers first. * because it needs to resolve the passed-in providers first.
* See {@link ReflectiveInjector#resolve} and {@link ReflectiveInjector#fromResolvedProviders}. * See {@link ReflectiveInjector#resolve resolve} and
* {@link ReflectiveInjector#fromResolvedProviders fromResolvedProviders}.
*/ */
static resolveAndCreate(providers: Provider[], parent?: Injector): ReflectiveInjector { static resolveAndCreate(providers: Provider[], parent?: Injector): ReflectiveInjector {
const ResolvedReflectiveProviders = ReflectiveInjector.resolve(providers); const ResolvedReflectiveProviders = ReflectiveInjector.resolve(providers);
@ -190,7 +191,8 @@ export abstract class ReflectiveInjector implements Injector {
* *
* This function is slower than the corresponding `createChildFromResolved` * This function is slower than the corresponding `createChildFromResolved`
* because it needs to resolve the passed-in providers first. * because it needs to resolve the passed-in providers first.
* See {@link ReflectiveInjector#resolve} and {@link ReflectiveInjector#createChildFromResolved}. * See {@link ReflectiveInjector#resolve resolve} and
* {@link ReflectiveInjector#createChildFromResolved createChildFromResolved}.
*/ */
abstract resolveAndCreateChild(providers: Provider[]): ReflectiveInjector; abstract resolveAndCreateChild(providers: Provider[]): ReflectiveInjector;

View File

@ -18,9 +18,8 @@ import {EmbeddedViewRef} from './view_ref';
* the constructor of the directive using the `TemplateRef` Token. Alternatively you can query for * the constructor of the directive using the `TemplateRef` Token. Alternatively you can query for
* the `TemplateRef` from a Component or a Directive via {@link Query}. * the `TemplateRef` from a Component or a Directive via {@link Query}.
* *
* To instantiate Embedded Views based on a Template, use * To instantiate Embedded Views based on a Template, use {@link ViewContainerRef#
* {@link ViewContainerRef#createEmbeddedView}, which will create the View and attach it to the * createEmbeddedView}, which will create the View and attach it to the View Container.
* View Container.
* @stable * @stable
*/ */
export abstract class TemplateRef<C> { export abstract class TemplateRef<C> {

View File

@ -73,8 +73,8 @@ export abstract class ViewContainerRef {
* Instantiates a single {@link Component} and inserts its Host View into this container at the * Instantiates a single {@link Component} and inserts its Host View into this container at the
* specified `index`. * specified `index`.
* *
* The component is instantiated using its {@link ComponentFactory} which can be * The component is instantiated using its {@link ComponentFactory} which can be obtained via
* obtained via {@link ComponentFactoryResolver#resolveComponentFactory}. * {@link ComponentFactoryResolver#resolveComponentFactory resolveComponentFactory}.
* *
* If `index` is not specified, the new View will be inserted as the last View in the container. * If `index` is not specified, the new View will be inserted as the last View in the container.
* *

View File

@ -9,15 +9,15 @@
/** /**
* Defines template and style encapsulation options available for Component's {@link Component}. * Defines template and style encapsulation options available for Component's {@link Component}.
* *
* See {@link Component#encapsulation}. * See {@link Component#encapsulation encapsulation}.
* @stable * @stable
*/ */
export enum ViewEncapsulation { export enum ViewEncapsulation {
/** /**
* Emulate `Native` scoping of styles by adding an attribute containing surrogate id to the Host * Emulate `Native` scoping of styles by adding an attribute containing surrogate id to the Host
* Element and pre-processing the style rules provided via * Element and pre-processing the style rules provided via {@link Component#styles styles} or
* {@link Component#styles} or {@link Component#styleUrls}, and adding the new Host Element * {@link Component#styleUrls styleUrls}, and adding the new Host Element attribute to all
* attribute to all selectors. * selectors.
* *
* This is the default option. * This is the default option.
*/ */

View File

@ -99,9 +99,8 @@ export const Renderer2Interceptor = new InjectionToken<Renderer2[]>('Renderer2In
* *
* Use this service to bypass Angular's templating and make custom UI changes that can't be * Use this service to bypass Angular's templating and make custom UI changes that can't be
* expressed declaratively. For example if you need to set a property or an attribute whose name is * expressed declaratively. For example if you need to set a property or an attribute whose name is
* not statically known, use {@link Renderer#setElementProperty} or {@link * not statically known, use {@link Renderer#setElementProperty setElementProperty} or
* Renderer#setElementAttribute} * {@link Renderer#setElementAttribute setElementAttribute} respectively.
* respectively.
* *
* If you are implementing a custom renderer, you must implement this interface. * If you are implementing a custom renderer, you must implement this interface.
* *

View File

@ -40,7 +40,7 @@ export const formGroupNameProvider: any = {
* controls into their own nested object. * controls into their own nested object.
* *
* **Access the group**: You can access the associated {@link FormGroup} using the * **Access the group**: You can access the associated {@link FormGroup} using the
* {@link AbstractControl#get} method. Ex: `this.form.get('name')`. * {@link AbstractControl#get get} method. Ex: `this.form.get('name')`.
* *
* You can also access individual controls within the group using dot syntax. * You can also access individual controls within the group using dot syntax.
* Ex: `this.form.get('name.first')` * Ex: `this.form.get('name.first')`
@ -111,7 +111,7 @@ export const formArrayNameProvider: any = {
* form controls dynamically. * form controls dynamically.
* *
* **Access the array**: You can access the associated {@link FormArray} using the * **Access the array**: You can access the associated {@link FormArray} using the
* {@link AbstractControl#get} method on the parent {@link FormGroup}. * {@link AbstractControl#get get} method on the parent {@link FormGroup}.
* Ex: `this.form.get('cities')`. * Ex: `this.form.get('cities')`.
* *
* **Get the value**: the `value` property is always synced and available on the * **Get the value**: the `value` property is always synced and available on the
@ -119,16 +119,16 @@ export const formArrayNameProvider: any = {
* *
* **Set the value**: You can set an initial value for each child control when instantiating * **Set the value**: You can set an initial value for each child control when instantiating
* the {@link FormArray}, or you can set the value programmatically later using the * the {@link FormArray}, or you can set the value programmatically later using the
* {@link FormArray}'s {@link AbstractControl#setValue} or {@link AbstractControl#patchValue} * {@link FormArray}'s {@link AbstractControl#setValue setValue} or
* methods. * {@link AbstractControl#patchValue patchValue} methods.
* *
* **Listen to value**: If you want to listen to changes in the value of the array, you can * **Listen to value**: If you want to listen to changes in the value of the array, you can
* subscribe to the {@link FormArray}'s {@link AbstractControl#valueChanges} event. You can also * subscribe to the {@link FormArray}'s {@link AbstractControl#valueChanges valueChanges} event.
* listen to its {@link AbstractControl#statusChanges} event to be notified when the validation * You can also listen to its {@link AbstractControl#statusChanges statusChanges} event to be
* status is re-calculated. * notified when the validation status is re-calculated.
* *
* **Add new controls**: You can add new controls to the {@link FormArray} dynamically by * **Add new controls**: You can add new controls to the {@link FormArray} dynamically by calling
* calling its {@link FormArray#push} method. * its {@link FormArray#push push} method.
* Ex: `this.form.get('cities').push(new FormControl());` * Ex: `this.form.get('cities').push(new FormControl());`
* *
* ### Example * ### Example

View File

@ -755,9 +755,9 @@ export class FormControl extends AbstractControl {
/** /**
* Patches the value of a control. * Patches the value of a control.
* *
* This function is functionally the same as {@link FormControl#setValue} at this level. * This function is functionally the same as {@link FormControl#setValue setValue} at this level.
* It exists for symmetry with {@link FormGroup#patchValue} on `FormGroups` and `FormArrays`, * It exists for symmetry with {@link FormGroup#patchValue patchValue} on `FormGroups` and
* where it does behave differently. * `FormArrays`, where it does behave differently.
*/ */
patchValue(value: any, options: { patchValue(value: any, options: {
onlySelf?: boolean, onlySelf?: boolean,
@ -956,8 +956,8 @@ export class FormGroup extends AbstractControl {
/** /**
* Registers a control with the group's list of controls. * Registers a control with the group's list of controls.
* *
* This method does not update value or validity of the control, so for * This method does not update the value or validity of the control, so for most cases you'll want
* most cases you'll want to use {@link FormGroup#addControl} instead. * to use {@link FormGroup#addControl addControl} instead.
*/ */
registerControl(name: string, control: AbstractControl): AbstractControl { registerControl(name: string, control: AbstractControl): AbstractControl {
if (this.controls[name]) return this.controls[name]; if (this.controls[name]) return this.controls[name];
@ -1000,8 +1000,8 @@ export class FormGroup extends AbstractControl {
/** /**
* Check whether there is an enabled control with the given name in the group. * Check whether there is an enabled control with the given name in the group.
* *
* It will return false for disabled controls. If you'd like to check for * It will return false for disabled controls. If you'd like to check for existence in the group
* existence in the group only, use {@link AbstractControl#get} instead. * only, use {@link AbstractControl#get get} instead.
*/ */
contains(controlName: string): boolean { contains(controlName: string): boolean {
return this.controls.hasOwnProperty(controlName) && this.controls[controlName].enabled; return this.controls.hasOwnProperty(controlName) && this.controls[controlName].enabled;

View File

@ -69,10 +69,12 @@ import {UrlTree} from '../url_tree';
* ``` * ```
* *
* You can tell the directive to how to handle queryParams, available options are: * You can tell the directive to how to handle queryParams, available options are:
* - 'merge' merge the queryParams into the current queryParams * - `'merge'`: merge the queryParams into the current queryParams
* - 'preserve' preserve the current queryParams * - `'preserve'`: preserve the current queryParams
* - default / '' use the queryParams only * - default/`''`: use the queryParams only
* same options for {@link NavigationExtras#queryParamsHandling} *
* Same options for {@link NavigationExtras#queryParamsHandling
* NavigationExtras#queryParamsHandling}.
* *
* ``` * ```
* <a [routerLink]="['/user/bob']" [queryParams]="{debug: true}" queryParamsHandling="merge"> * <a [routerLink]="['/user/bob']" [queryParams]="{debug: true}" queryParamsHandling="merge">
@ -87,9 +89,9 @@ import {UrlTree} from '../url_tree';
* Then the following link `<a [routerLink]="['/user/jim']">Jim</a>` will generate the link * Then the following link `<a [routerLink]="['/user/jim']">Jim</a>` will generate the link
* `/user/(jim//aux:team)`. * `/user/(jim//aux:team)`.
* *
* @ngModule RouterModule * See {@link Router#createUrlTree createUrlTree} for more information.
* *
* See {@link Router#createUrlTree} for more information. * @ngModule RouterModule
* *
* @stable * @stable
*/ */