Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(*) fix dangling links in API docs #16632

Merged
merged 7 commits into from May 9, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions packages/animations/src/animation_metadata.ts
Expand Up @@ -120,15 +120,15 @@ export interface AnimationGroupMetadata extends AnimationMetadata { steps: Anima
/**
* `trigger` is an animation-specific function that is designed to be used inside of Angular's
animation DSL language. If this information is new, please navigate to the {@link
Component#animations-anchor component animations metadata page} to gain a better understanding of
Component#animations component animations metadata page} to gain a better understanding of
how animations in Angular are used.
*
* `trigger` Creates an animation trigger which will a list of {@link state state} and {@link
transition transition} entries that will be evaluated when the expression bound to the trigger
changes.
*
* Triggers are registered within the component annotation data under the {@link
Component#animations-anchor animations section}. An animation trigger can be placed on an element
Component#animations animations section}. An animation trigger can be placed on an element
within a template by referencing the name of the trigger followed by the expression value that the
trigger is bound to (in the form of `[@triggerName]="expression"`.
*
Expand Down Expand Up @@ -175,7 +175,7 @@ export function trigger(name: string, definitions: AnimationMetadata[]): Animati
/**
* `animate` is an animation-specific function that is designed to be used inside of Angular's
* animation DSL language. If this information is new, please navigate to the {@link
* Component#animations-anchor component animations metadata page} to gain a better understanding of
* Component#animations component animations metadata page} to gain a better understanding of
* how animations in Angular are used.
*
* `animate` specifies an animation step that will apply the provided `styles` data for a given
Expand Down Expand Up @@ -226,7 +226,7 @@ export function animate(
/**
* `group` is an animation-specific function that is designed to be used inside of Angular's
* animation DSL language. If this information is new, please navigate to the {@link
* Component#animations-anchor component animations metadata page} to gain a better understanding of
* Component#animations component animations metadata page} to gain a better understanding of
* how animations in Angular are used.
*
* `group` specifies a list of animation steps that are all run in parallel. Grouped animations are
Expand Down Expand Up @@ -261,7 +261,7 @@ export function group(steps: AnimationMetadata[]): AnimationGroupMetadata {
/**
* `sequence` is an animation-specific function that is designed to be used inside of Angular's
* animation DSL language. If this information is new, please navigate to the {@link
* Component#animations-anchor component animations metadata page} to gain a better understanding of
* Component#animations component animations metadata page} to gain a better understanding of
* how animations in Angular are used.
*
* `sequence` Specifies a list of animation steps that are run one by one. (`sequence` is used by
Expand Down Expand Up @@ -299,7 +299,7 @@ export function sequence(steps: AnimationMetadata[]): AnimationSequenceMetadata
/**
* `style` is an animation-specific function that is designed to be used inside of Angular's
* animation DSL language. If this information is new, please navigate to the {@link
* Component#animations-anchor component animations metadata page} to gain a better understanding of
* Component#animations component animations metadata page} to gain a better understanding of
* how animations in Angular are used.
*
* `style` declares a key/value object containing CSS properties/styles that can then be used for
Expand Down Expand Up @@ -347,7 +347,7 @@ export function style(
/**
* `state` is an animation-specific function that is designed to be used inside of Angular's
* animation DSL language. If this information is new, please navigate to the {@link
* Component#animations-anchor component animations metadata page} to gain a better understanding of
* Component#animations component animations metadata page} to gain a better understanding of
* how animations in Angular are used.
*
* `state` declares an animation state within the given trigger. When a state is active within a
Expand Down Expand Up @@ -399,7 +399,7 @@ export function state(name: string, styles: AnimationStyleMetadata): AnimationSt
/**
* `keyframes` is an animation-specific function that is designed to be used inside of Angular's
* animation DSL language. If this information is new, please navigate to the {@link
* Component#animations-anchor component animations metadata page} to gain a better understanding of
* Component#animations component animations metadata page} to gain a better understanding of
* how animations in Angular are used.
*
* `keyframes` specifies a collection of {@link style style} entries each optionally characterized
Expand Down Expand Up @@ -448,7 +448,7 @@ export function keyframes(steps: AnimationStyleMetadata[]): AnimationKeyframesSe
/**
* `transition` is an animation-specific function that is designed to be used inside of Angular's
* animation DSL language. If this information is new, please navigate to the {@link
* Component#animations-anchor component animations metadata page} to gain a better understanding of
* Component#animations component animations metadata page} to gain a better understanding of
* how animations in Angular are used.
*
* `transition` declares the {@link sequence sequence of animation steps} that will be run when the
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/di/reflective_injector.ts
Expand Up @@ -113,7 +113,7 @@ export abstract class ReflectiveInjector implements Injector {
*
* This function is slower than the corresponding `fromResolvedProviders`
* because it needs to resolve the passed-in providers first.
* See {@link Injector#resolve} and {@link Injector#fromResolvedProviders}.
* See {@link ReflectiveInjector#resolve} and {@link ReflectiveInjector#fromResolvedProviders}.
*/
static resolveAndCreate(providers: Provider[], parent?: Injector): ReflectiveInjector {
const ResolvedReflectiveProviders = ReflectiveInjector.resolve(providers);
Expand Down Expand Up @@ -190,7 +190,7 @@ export abstract class ReflectiveInjector implements Injector {
*
* This function is slower than the corresponding `createChildFromResolved`
* because it needs to resolve the passed-in providers first.
* See {@link Injector#resolve} and {@link Injector#createChildFromResolved}.
* See {@link ReflectiveInjector#resolve} and {@link ReflectiveInjector#createChildFromResolved}.
*/
abstract resolveAndCreateChild(providers: Provider[]): ReflectiveInjector;

Expand Down
14 changes: 7 additions & 7 deletions packages/core/src/metadata/view.ts
Expand Up @@ -61,19 +61,19 @@ export enum ViewEncapsulation {
* {@link Component}
*/
export class ViewMetadata {
/** {@link Component.templateUrl} */
/** {@link Component#templateUrl} */
templateUrl: string|undefined;
/** {@link Component.template} */
/** {@link Component#template} */
template: string|undefined;
/** {@link Component.stylesUrl} */
/** {@link Component#stylesUrl} */
styleUrls: string[]|undefined;
/** {@link Component.styles} */
/** {@link Component#styles} */
styles: string[]|undefined;
/** {@link Component.encapsulation} */
/** {@link Component#encapsulation} */
encapsulation: ViewEncapsulation|undefined;
/** {@link Component.animation} */
/** {@link Component#animation} */
animations: any[]|undefined;
/** {@link Component.interpolation} */
/** {@link Component#interpolation} */
interpolation: [string, string]|undefined;

constructor(
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/render/api.ts
Expand Up @@ -99,7 +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
* expressed declaratively. For example if you need to set a property or an attribute whose name is
* not statically known, use {@link #setElementProperty} or {@link #setElementAttribute}
* not statically known, use {@link Renderer#setElementProperty} or {@link
* Renderer#setElementAttribute}
* respectively.
*
* If you are implementing a custom renderer, you must implement this interface.
Expand Down
Expand Up @@ -128,7 +128,7 @@ export const formArrayNameProvider: any = {
* status is re-calculated.
*
* **Add new controls**: You can add new controls to the {@link FormArray} dynamically by
* calling its {@link FormArray.push} method.
* calling its {@link FormArray#push} method.
* Ex: `this.form.get('cities').push(new FormControl());`
*
* ### Example
Expand Down
6 changes: 3 additions & 3 deletions packages/forms/src/model.ts
Expand Up @@ -676,8 +676,8 @@ export class FormControl extends AbstractControl {
/**
* Patches the value of a control.
*
* This function is functionally the same as {@link FormControl.setValue} at this level.
* It exists for symmetry with {@link FormGroup.patchValue} on `FormGroups` and `FormArrays`,
* This function is functionally the same as {@link FormControl#setValue} at this level.
* It exists for symmetry with {@link FormGroup#patchValue} on `FormGroups` and `FormArrays`,
* where it does behave differently.
*/
patchValue(value: any, options: {
Expand Down Expand Up @@ -842,7 +842,7 @@ export class FormGroup extends AbstractControl {
* Registers a control with the group's list of controls.
*
* This method does not update value or validity of the control, so for
* most cases you'll want to use {@link FormGroup.addControl} instead.
* most cases you'll want to use {@link FormGroup#addControl} instead.
*/
registerControl(name: string, control: AbstractControl): AbstractControl {
if (this.controls[name]) return this.controls[name];
Expand Down
4 changes: 2 additions & 2 deletions packages/router/src/directives/router_link.ts
Expand Up @@ -72,7 +72,7 @@ import {UrlTree} from '../url_tree';
* - 'merge' merge the queryParams into the current queryParams
* - 'preserve' prserve the current queryParams
* - default / '' use the queryParams only
* same options for {@link NavigationExtras.queryParamsHandling}
* same options for {@link NavigationExtras#queryParamsHandling}
*
* ```
* <a [routerLink]="['/user/bob']" [queryParams]="{debug: true}" queryParamsHandling="merge">
Expand All @@ -89,7 +89,7 @@ import {UrlTree} from '../url_tree';
*
* @ngModule RouterModule
*
* See {@link Router.createUrlTree} for more information.
* See {@link Router#createUrlTree} for more information.
*
* @stable
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/upgrade/src/common/downgrade_component.ts
Expand Up @@ -18,7 +18,7 @@ let downgradeCount = 0;
/**
* @whatItDoes
*
* *Part of the [upgrade/static](/docs/ts/latest/api/#!?query=upgrade%2Fstatic)
* *Part of the [upgrade/static](api?query=upgrade%2Fstatic)
* library for hybrid upgrade apps that support AoT compilation*
*
* Allows an Angular component to be used from AngularJS.
Expand Down
2 changes: 1 addition & 1 deletion packages/upgrade/src/common/downgrade_injectable.ts
Expand Up @@ -12,7 +12,7 @@ import {INJECTOR_KEY} from './constants';
/**
* @whatItDoes
*
* *Part of the [upgrade/static](/docs/ts/latest/api/#!?query=upgrade%2Fstatic)
* *Part of the [upgrade/static](api?query=upgrade%2Fstatic)
* library for hybrid upgrade apps that support AoT compilation*
*
* Allow an Angular service to be accessible from AngularJS.
Expand Down
2 changes: 1 addition & 1 deletion packages/upgrade/src/static/upgrade_component.ts
Expand Up @@ -43,7 +43,7 @@ type LifecycleHook = '$doCheck' | '$onChanges' | '$onDestroy' | '$onInit' | '$po
/**
* @whatItDoes
*
* *Part of the [upgrade/static](/docs/ts/latest/api/#!?query=upgrade%2Fstatic)
* *Part of the [upgrade/static](api?query=upgrade%2Fstatic)
* library for hybrid upgrade apps that support AoT compilation*
*
* Allows an AngularJS component to be used from Angular.
Expand Down
3 changes: 2 additions & 1 deletion packages/upgrade/src/static/upgrade_module.ts
Expand Up @@ -18,7 +18,7 @@ import {angular1Providers, setTempInjectorRef} from './angular1_providers';
/**
* @whatItDoes
*
* *Part of the [upgrade/static](/docs/ts/latest/api/#!?query=upgrade%2Fstatic)
* *Part of the [upgrade/static](api?query=upgrade%2Fstatic)
* library for hybrid upgrade apps that support AoT compilation*
*
* Allows AngularJS and Angular components to be used together inside a hybrid upgrade
Expand Down Expand Up @@ -88,6 +88,7 @@ import {angular1Providers, setTempInjectorRef} from './angular1_providers';
*
* {@example upgrade/static/ts/module.ts region='bootstrap'}
*
* {@a upgrading-an-angular-1-service}
*
* ## Upgrading an AngularJS service
*
Expand Down