diff --git a/packages/animations/src/animation_metadata.ts b/packages/animations/src/animation_metadata.ts index 340816f3a20..98f30851ac3 100644 --- a/packages/animations/src/animation_metadata.ts +++ b/packages/animations/src/animation_metadata.ts @@ -54,7 +54,7 @@ export declare type AnimateTimings = { * * - `transition()` * - `sequence()` - * - `{@link animations/group group()}` + * - `{@link /api/animations/group group()}` * - `query()` * - `animation()` * - `useAnimation()` @@ -118,7 +118,7 @@ export enum AnimationMetadataType { Sequence = 2, /** * Contains a set of animation steps. - * See `{@link animations/group group()}` + * See `{@link /api/animations/group group()}` */ Group = 3, /** @@ -636,7 +636,7 @@ export function trigger(name: string, definitions: AnimationMetadata[]): Animati * @returns An object that encapsulates the animation step. * * @usageNotes - * Call within an animation `sequence()`, `{@link animations/group group()}`, or + * Call within an animation `sequence()`, {@link /api/animations/group group()}, or * `transition()` call to specify an animation step * that applies given style data to the parent animation for a given amount of time. * @@ -740,10 +740,10 @@ export function group( * @usageNotes * When you pass an array of steps to a * `transition()` call, the steps run sequentially by default. - * Compare this to the `{@link animations/group group()}` call, which runs animation steps in + * Compare this to the {@link /api/animations/group group()} call, which runs animation steps in *parallel. * - * When a sequence is used within a `{@link animations/group group()}` or a `transition()` call, + * When a sequence is used within a {@link /api/animations/group group()} or a `transition()` call, * execution continues to the next instruction only after each of the inner animation * steps have completed. * diff --git a/packages/common/src/directives/ng_component_outlet.ts b/packages/common/src/directives/ng_component_outlet.ts index 0051fb559ad..943e26d6394 100644 --- a/packages/common/src/directives/ng_component_outlet.ts +++ b/packages/common/src/directives/ng_component_outlet.ts @@ -23,7 +23,7 @@ import { } from '@angular/core'; /** - * Instantiates a {@link Component} type and inserts its Host View into the current View. + * Instantiates a {@link /api/core/Component Component} type and inserts its Host View into the current View. * `NgComponentOutlet` provides a declarative approach for dynamic component creation. * * `NgComponentOutlet` requires a component type, if a falsy value is set the view will clear and diff --git a/packages/common/src/location/platform_location.ts b/packages/common/src/location/platform_location.ts index aca0dbcf9bd..9bb47e8d529 100644 --- a/packages/common/src/location/platform_location.ts +++ b/packages/common/src/location/platform_location.ts @@ -26,8 +26,8 @@ import {DOCUMENT} from '../dom_tokens'; * when they need to interact with the DOM APIs like pushState, popState, etc. * * {@link LocationStrategy} in turn is used by the {@link Location} service which is used directly - * by the {@link Router} in order to navigate between routes. Since all interactions between {@link - * Router} / + * by the {@link /api/router/Router Router} in order to navigate between routes. Since all interactions between + * {@link /api/router/Router Router} / * {@link Location} / {@link LocationStrategy} and DOM APIs flow through the `PlatformLocation` * class, they are all platform-agnostic. * diff --git a/packages/core/src/change_detection/constants.ts b/packages/core/src/change_detection/constants.ts index 0b9bd0a30a4..7bb9b6ebaf4 100644 --- a/packages/core/src/change_detection/constants.ts +++ b/packages/core/src/change_detection/constants.ts @@ -10,8 +10,8 @@ * The strategy that the default change detector uses to detect changes. * When set, takes effect the next time change detection is triggered. * - * @see [Change detection usage](/api/core/ChangeDetectorRef?tab=usage-notes) - * @see [Skipping component subtrees](/best-practices/skipping-subtrees) + * @see {@link /api/core/ChangeDetectorRef?tab=usage-notes Change detection usage} + * @see {@link /best-practices/skipping-subtrees Skipping component subtrees} * * @publicApi */ diff --git a/packages/core/src/change_detection/differs/iterable_differs.ts b/packages/core/src/change_detection/differs/iterable_differs.ts index e212d4845ae..c739dd7a631 100644 --- a/packages/core/src/change_detection/differs/iterable_differs.ts +++ b/packages/core/src/change_detection/differs/iterable_differs.ts @@ -20,7 +20,7 @@ import {DefaultIterableDifferFactory} from '../differs/default_iterable_differ'; export type NgIterable = Array | Iterable; /** - * A strategy for tracking changes over time to an iterable. Used by {@link NgForOf} to + * A strategy for tracking changes over time to an iterable. Used by {@link /api/common/NgForOf NgForOf} to * respond to changes in an iterable by effecting equivalent changes in the DOM. * * @publicApi diff --git a/packages/core/src/change_detection/scheduling/ng_zone_scheduling.ts b/packages/core/src/change_detection/scheduling/ng_zone_scheduling.ts index 82c60652f17..e40298ddf94 100644 --- a/packages/core/src/change_detection/scheduling/ng_zone_scheduling.ts +++ b/packages/core/src/change_detection/scheduling/ng_zone_scheduling.ts @@ -153,7 +153,7 @@ export function internalProvideZoneChangeDetection({ * ``` * * @publicApi - * @see {@link bootstrapApplication} + * @see {@link /api/core/bootstrapApplication bootstrapApplication} * @see {@link NgZoneOptions} */ export function provideZoneChangeDetection(options?: NgZoneOptions): EnvironmentProviders { diff --git a/packages/core/src/change_detection/scheduling/zoneless_scheduling_impl.ts b/packages/core/src/change_detection/scheduling/zoneless_scheduling_impl.ts index 453aaafea21..8381a42b6d0 100644 --- a/packages/core/src/change_detection/scheduling/zoneless_scheduling_impl.ts +++ b/packages/core/src/change_detection/scheduling/zoneless_scheduling_impl.ts @@ -369,7 +369,7 @@ export class ChangeDetectionSchedulerImpl implements ChangeDetectionScheduler { * * @publicApi * @experimental - * @see [bootstrapApplication](/api/platform-browser/bootstrapApplication) + * @see {@link /api/platform-browser/bootstrapApplication bootstrapApplication} */ export function provideExperimentalZonelessChangeDetection(): EnvironmentProviders { performanceMarkFeature('NgZoneless'); diff --git a/packages/core/src/linker/view_ref.ts b/packages/core/src/linker/view_ref.ts index d9423a0df3d..3d83cbca59d 100644 --- a/packages/core/src/linker/view_ref.ts +++ b/packages/core/src/linker/view_ref.ts @@ -11,7 +11,7 @@ import {ChangeDetectorRef} from '../change_detection/change_detector_ref'; /** * Represents an Angular view. * - * @see [Change detection usage](/api/core/ChangeDetectorRef?tab=usage-notes) + * @see {@link /api/core/ChangeDetectorRef?tab=usage-notes Change detection usage} * * @publicApi */ diff --git a/packages/core/src/metadata/view.ts b/packages/core/src/metadata/view.ts index 30e3b75a58c..cff1ecdcaae 100644 --- a/packages/core/src/metadata/view.ts +++ b/packages/core/src/metadata/view.ts @@ -7,7 +7,7 @@ */ /** - * Defines the CSS styles encapsulation policies for the {@link Component} decorator's + * Defines the CSS styles encapsulation policies for the {@link /api/core/Component Component} decorator's * `encapsulation` option. * * See {@link Component#encapsulation encapsulation}. diff --git a/packages/core/src/render/api_flags.ts b/packages/core/src/render/api_flags.ts index 8ac52241881..eac178da10f 100644 --- a/packages/core/src/render/api_flags.ts +++ b/packages/core/src/render/api_flags.ts @@ -41,8 +41,7 @@ export interface RendererType2 { data: {[kind: string]: any}; /** - * A function added by the {@link ɵɵExternalStylesFeature} and used by the framework to create - * the list of external runtime style URLs. + * A function used by the framework to create the list of external runtime style URLs. */ getExternalStyles?: ((encapsulationId?: string) => string[]) | null; } diff --git a/packages/core/src/render3/definition.ts b/packages/core/src/render3/definition.ts index fb10faadffe..4c892398e0c 100644 --- a/packages/core/src/render3/definition.ts +++ b/packages/core/src/render3/definition.ts @@ -286,7 +286,7 @@ interface ComponentDefinition extends Omit, 'features' features?: ComponentDefFeature[]; /** - * Defines template and style encapsulation options available for Component's {@link Component}. + * Defines template and style encapsulation options available for Component's {@link /api/core/Component Component}. */ encapsulation?: ViewEncapsulation; diff --git a/packages/core/src/render3/interfaces/definition.ts b/packages/core/src/render3/interfaces/definition.ts index e2da569dd55..5db253a9136 100644 --- a/packages/core/src/render3/interfaces/definition.ts +++ b/packages/core/src/render3/interfaces/definition.ts @@ -402,8 +402,7 @@ export interface ComponentDef extends DirectiveDef { | null; /** - * A function added by the {@link ɵɵExternalStylesFeature} and used by the framework to create - * the list of external runtime style URLs. + * A function used by the framework to create the list of external runtime style URLs. */ getExternalStyles: ((encapsulationId?: string) => string[]) | null; diff --git a/packages/core/src/render3/reactivity/asserts.ts b/packages/core/src/render3/reactivity/asserts.ts index 6f00f61dbad..94f8794ea73 100644 --- a/packages/core/src/render3/reactivity/asserts.ts +++ b/packages/core/src/render3/reactivity/asserts.ts @@ -12,7 +12,7 @@ import {RuntimeError, RuntimeErrorCode} from '../../errors'; /** * Asserts that the current stack frame is not within a reactive context. Useful - * to disallow certain code from running inside a reactive context (see {@link toSignal}). + * to disallow certain code from running inside a reactive context (see {@link /api/core/rxjs/toSignal toSignal}) * * @param debugFn a reference to the function making the assertion (used for the error message). * diff --git a/packages/core/src/render3/util/change_detection_utils.ts b/packages/core/src/render3/util/change_detection_utils.ts index 8a92a746be7..3eb79418977 100644 --- a/packages/core/src/render3/util/change_detection_utils.ts +++ b/packages/core/src/render3/util/change_detection_utils.ts @@ -19,7 +19,7 @@ import {getRootComponents} from './discovery_utils'; * Marks a component for check (in case of OnPush components) and synchronously * performs change detection on the application this component belongs to. * - * @param component Component to {@link ChangeDetectorRef#markForCheck mark for check}. + * @param component Component to {@link /api/core/ChangeDetectorRef#markForCheck mark for check} * * @publicApi */ diff --git a/packages/forms/src/validators.ts b/packages/forms/src/validators.ts index 18dc22a8617..be23ca4108a 100644 --- a/packages/forms/src/validators.ts +++ b/packages/forms/src/validators.ts @@ -175,7 +175,7 @@ export class Validators { * @returns A validator function that returns an error map with the * `min` property if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static min(min: number): ValidatorFn { @@ -199,7 +199,7 @@ export class Validators { * @returns A validator function that returns an error map with the * `max` property if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static max(max: number): ValidatorFn { @@ -223,7 +223,7 @@ export class Validators { * @returns An error map with the `required` property * if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static required(control: AbstractControl): ValidationErrors | null { @@ -248,7 +248,7 @@ export class Validators { * @returns An error map that contains the `required` property * set to `true` if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static requiredTrue(control: AbstractControl): ValidationErrors | null { @@ -288,7 +288,7 @@ export class Validators { * @returns An error map with the `email` property * if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static email(control: AbstractControl): ValidationErrors | null { @@ -323,7 +323,7 @@ export class Validators { * @returns A validator function that returns an error map with the * `minlength` property if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static minLength(minLength: number): ValidatorFn { @@ -355,7 +355,7 @@ export class Validators { * @returns A validator function that returns an error map with the * `maxlength` property if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static maxLength(maxLength: number): ValidatorFn { @@ -408,7 +408,7 @@ export class Validators { * @returns A validator function that returns an error map with the * `pattern` property if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static pattern(pattern: string | RegExp): ValidatorFn { @@ -419,7 +419,7 @@ export class Validators { * @description * Validator that performs no operation. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static nullValidator(control: AbstractControl): ValidationErrors | null { @@ -434,7 +434,7 @@ export class Validators { * @returns A validator function that returns an error map with the * merged error maps of the validators if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static compose(validators: null): null; @@ -451,7 +451,7 @@ export class Validators { * @returns A validator function that returns an error map with the * merged error objects of the async validators if the validation check fails, otherwise `null`. * - * @see {@link updateValueAndValidity()} + * @see {@link /api/forms/AbstractControl#updateValueAndValidity updateValueAndValidity} * */ static composeAsync(validators: (AsyncValidatorFn | null)[]): AsyncValidatorFn | null { diff --git a/packages/localize/src/translate.ts b/packages/localize/src/translate.ts index 432572ecd5f..d0273d433ca 100644 --- a/packages/localize/src/translate.ts +++ b/packages/localize/src/translate.ts @@ -58,7 +58,7 @@ declare const $localize: LocalizeFn & {TRANSLATIONS: Record) { @@ -80,7 +80,7 @@ export function loadTranslations(translations: Record) * All translations that had been loading into memory using `loadTranslations()` will be removed. * * @see {@link loadTranslations} for loading translations at runtime. - * @see [$localize](api/localize/init/$localize) for tagging messages as needing to be translated. + * @see {@link /api/localize/init/$localize $localize} for tagging messages as needing to be translated. * * @publicApi */ diff --git a/packages/router/src/models.ts b/packages/router/src/models.ts index 485bc7388da..3cac17da666 100644 --- a/packages/router/src/models.ts +++ b/packages/router/src/models.ts @@ -59,7 +59,7 @@ export type OnSameUrlNavigation = 'reload' | 'ignore'; * @see {@link CanActivateChildFn} * @see {@link CanDeactivateFn} * @see {@link ResolveFn} - * @see {@link core/inject} + * @see {@link /api/core/inject inject} * @publicApi */ export type DeprecatedGuard = ProviderToken | any; diff --git a/packages/router/src/provide_router.ts b/packages/router/src/provide_router.ts index 48075a746fe..c4e4e351ede 100644 --- a/packages/router/src/provide_router.ts +++ b/packages/router/src/provide_router.ts @@ -622,7 +622,7 @@ export type RouterHashLocationFeature = RouterFeature * (This option is only necessary when using `downgradeModule()` to downgrade more than one * Angular module.) - * - `propagateDigest?: boolean`: Whether to perform {@link ChangeDetectorRef#detectChanges} on the - * component on every - * [$digest](https://docs.angularjs.org/api/ng/type/$rootScope.Scope#$digest). If set to `false`, - * change detection will still be performed when any of the component's inputs changes. + * - `propagateDigest?: boolean`: Whether to perform {@link /api/core/ChangeDetectorRef#detectChanges detectChanges} on the + * component on every {@link https://docs.angularjs.org/api/ng/type/$rootScope.Scope#$digest $digest}. + * If set to `false`, change detection will still be performed when any of the component's inputs changes. * (Default: true) * * @returns a factory function that can be used to register the component in an diff --git a/packages/upgrade/static/src/downgrade_module.ts b/packages/upgrade/static/src/downgrade_module.ts index 9f8bd147552..e58eb7a1ba2 100644 --- a/packages/upgrade/static/src/downgrade_module.ts +++ b/packages/upgrade/static/src/downgrade_module.ts @@ -128,7 +128,7 @@ let moduleUid = 0; * {@link PlatformRef#bootstrapmodulefactory `bootstrapModuleFactory()`} to bootstrap the * downgraded modules, each one is considered a "root" module. As a consequence, a new instance * will be created for every injectable provided in `"root"` (via - * {@link Injectable#providedIn `providedIn`}). + * {@link /api/core/Injectable#providedIn providedIn} * If this is not your intention, you can have a shared module (that will act as act as the "root" * module) and create all downgraded modules using that module's injector: * @@ -244,7 +244,7 @@ export function downgradeModule( * {@link PlatformRef#bootstrapmodulefactory `bootstrapModuleFactory()`} to bootstrap the * downgraded modules, each one is considered a "root" module. As a consequence, a new instance * will be created for every injectable provided in `"root"` (via - * {@link Injectable#providedIn `providedIn`}). + * {@link /api/core/Injectable#providedIn providedIn} * If this is not your intention, you can have a shared module (that will act as act as the "root" * module) and create all downgraded modules using that module's injector: * @@ -361,7 +361,7 @@ export function downgradeModule(moduleOrBootstrapFn: NgModuleFactory): str * {@link PlatformRef#bootstrapmodulefactory `bootstrapModuleFactory()`} to bootstrap the * downgraded modules, each one is considered a "root" module. As a consequence, a new instance * will be created for every injectable provided in `"root"` (via - * {@link Injectable#providedIn `providedIn`}). + * {@link /api/core/Injectable#providedIn providedIn} * If this is not your intention, you can have a shared module (that will act as act as the "root" * module) and create all downgraded modules using that module's injector: *