From 921f96a1fcca685e7838da5416754110e53e2c4f Mon Sep 17 00:00:00 2001 From: Kristiyan Kostadinov Date: Mon, 9 Jun 2025 09:04:23 +0200 Subject: [PATCH] docs(multiple): remove invalid tags from doc strings We had `@link` doc strings in several doc strings, but we don't have any handling for `@link` in the pipeline which was causing it to log some warnings. These changes remove the invalid tags. --- .../dispose-view-repeater-strategy.ts | 2 +- .../recycle-view-repeater-strategy.ts | 2 +- src/cdk/collections/view-repeater.ts | 11 +++++------ src/cdk/scrolling/virtual-scrollable.ts | 2 +- src/cdk/table/table.ts | 2 +- .../map-marker-clusterer-types.ts | 16 ++++++++-------- src/material/datepicker/datepicker-base.ts | 2 +- 7 files changed, 18 insertions(+), 19 deletions(-) diff --git a/src/cdk/collections/dispose-view-repeater-strategy.ts b/src/cdk/collections/dispose-view-repeater-strategy.ts index c2b10ecff26b..3404ee747942 100644 --- a/src/cdk/collections/dispose-view-repeater-strategy.ts +++ b/src/cdk/collections/dispose-view-repeater-strategy.ts @@ -23,7 +23,7 @@ import { /** * A repeater that destroys views when they are removed from a - * {@link ViewContainerRef}. When new items are inserted into the container, + * `ViewContainerRef`. When new items are inserted into the container, * the repeater will always construct a new embedded view for each item. * * @template T The type for the embedded view's $implicit property. diff --git a/src/cdk/collections/recycle-view-repeater-strategy.ts b/src/cdk/collections/recycle-view-repeater-strategy.ts index 2e91cad9fa7d..735e32aec9de 100644 --- a/src/cdk/collections/recycle-view-repeater-strategy.ts +++ b/src/cdk/collections/recycle-view-repeater-strategy.ts @@ -24,7 +24,7 @@ import { /** * A repeater that caches views when they are removed from a - * {@link ViewContainerRef}. When new items are inserted into the container, + * `ViewContainerRef`. When new items are inserted into the container, * the repeater will reuse one of the cached views instead of creating a new * embedded view. Recycling cached views reduces the quantity of expensive DOM * inserts. diff --git a/src/cdk/collections/view-repeater.ts b/src/cdk/collections/view-repeater.ts index eeaf232cd766..1a0a2970a7b2 100644 --- a/src/cdk/collections/view-repeater.ts +++ b/src/cdk/collections/view-repeater.ts @@ -50,14 +50,14 @@ export type _ViewRepeaterItemContextFactory _ViewRepeaterItemInsertArgs; /** - * Extracts the value of an item from an {@link IterableChangeRecord}. + * Extracts the value of an item from an `IterableChangeRecord`. * * @template T The type for the embedded view's $implicit property. * @template R The type for the item in each IterableDiffer change record. */ export type _ViewRepeaterItemValueResolver = (record: IterableChangeRecord) => T; -/** Indicates how a view was changed by a {@link _ViewRepeater}. */ +/** Indicates how a view was changed by a `_ViewRepeater`. */ export enum _ViewRepeaterOperation { /** The content of an existing view was replaced with another item. */ REPLACED, @@ -70,8 +70,7 @@ export enum _ViewRepeaterOperation { } /** - * Meta data describing the state of a view after it was updated by a - * {@link _ViewRepeater}. + * Meta data describing the state of a view after it was updated by a `_ViewRepeater`. * * @template R The type for the item in each IterableDiffer change record. * @template C The type for the context passed to each embedded view. @@ -94,7 +93,7 @@ export interface _ViewRepeaterItemChange { export type _ViewRepeaterItemChanged = (change: _ViewRepeaterItemChange) => void; /** - * Describes a strategy for rendering items in a {@link ViewContainerRef}. + * Describes a strategy for rendering items in a `ViewContainerRef`. * * @template T The type for the embedded view's $implicit property. * @template R The type for the item in each IterableDiffer change record. @@ -113,7 +112,7 @@ export interface _ViewRepeater> { } /** - * Injection token for {@link _ViewRepeater}. This token is for use by Angular Material only. + * Injection token for `_ViewRepeater`. This token is for use by Angular Material only. * @docs-private */ export const _VIEW_REPEATER_STRATEGY = new InjectionToken< diff --git a/src/cdk/scrolling/virtual-scrollable.ts b/src/cdk/scrolling/virtual-scrollable.ts index 52f2ae36b16f..78c3ceead357 100644 --- a/src/cdk/scrolling/virtual-scrollable.ts +++ b/src/cdk/scrolling/virtual-scrollable.ts @@ -12,7 +12,7 @@ import {CdkScrollable} from './scrollable'; export const VIRTUAL_SCROLLABLE = new InjectionToken('VIRTUAL_SCROLLABLE'); /** - * Extending the {@link CdkScrollable} to be used as scrolling container for virtual scrolling. + * Extending the `CdkScrollable` to be used as scrolling container for virtual scrolling. */ @Directive() export abstract class CdkVirtualScrollable extends CdkScrollable { diff --git a/src/cdk/table/table.ts b/src/cdk/table/table.ts index 6debac739af8..a8ffcfabcbeb 100644 --- a/src/cdk/table/table.ts +++ b/src/cdk/table/table.ts @@ -389,7 +389,7 @@ export class CdkTable /** * Whether the sticky styler should recalculate cell widths when applying sticky styles. If * `false`, cached values will be used instead. This is only applicable to tables with - * {@link fixedLayout} enabled. For other tables, cell widths will always be recalculated. + * `_fixedLayout` enabled. For other tables, cell widths will always be recalculated. */ private _forceRecalculateCellWidths = true; diff --git a/src/google-maps/map-marker-clusterer/map-marker-clusterer-types.ts b/src/google-maps/map-marker-clusterer/map-marker-clusterer-types.ts index c0dae7a90648..0401167bb7be 100644 --- a/src/google-maps/map-marker-clusterer/map-marker-clusterer-types.ts +++ b/src/google-maps/map-marker-clusterer/map-marker-clusterer-types.ts @@ -68,16 +68,16 @@ export type onClusterClickHandler = ( export interface MarkerClustererOptions { markers?: Marker[]; /** - * An algorithm to cluster markers. Default is {@link SuperClusterAlgorithm}. Must - * provide a `calculate` method accepting {@link AlgorithmInput} and returning - * an array of {@link Cluster}. + * An algorithm to cluster markers. Default is `SuperClusterAlgorithm`. Must + * provide a `calculate` method accepting `AlgorithmInput` and returning + * an array of `Cluster`. */ algorithm?: Algorithm; algorithmOptions?: AlgorithmOptions; map?: google.maps.Map | null; /** - * An object that converts a {@link Cluster} into a `google.maps.Marker`. - * Default is {@link DefaultRenderer}. + * An object that converts a `Cluster` into a `google.maps.Marker`. + * Default is `DefaultRenderer`. */ renderer?: Renderer; onClusterClick?: onClusterClickHandler; @@ -93,7 +93,7 @@ export declare const defaultOnClusterClickHandler: onClusterClickHandler; export interface Renderer { /** - * Turn a {@link Cluster} into a `Marker`. + * Turn a `Cluster` into a `Marker`. * * Below is a simple example to create a marker with the number of markers in the cluster as a label. * @@ -125,7 +125,7 @@ export interface ClusterStats { export interface Algorithm { /** - * Calculates an array of {@link Cluster}. + * Calculates an array of `Cluster`. */ calculate: ({markers, map}: AlgorithmInput) => AlgorithmOutput; } @@ -156,7 +156,7 @@ export interface AlgorithmInput { export interface AlgorithmOutput { /** - * The clusters returned based upon the {@link AlgorithmInput}. + * The clusters returned based upon the `AlgorithmInput`. */ clusters: Cluster[]; /** diff --git a/src/material/datepicker/datepicker-base.ts b/src/material/datepicker/datepicker-base.ts index 52b846ad984e..35075750eaa9 100644 --- a/src/material/datepicker/datepicker-base.ts +++ b/src/material/datepicker/datepicker-base.ts @@ -352,7 +352,7 @@ export interface MatDatepickerControl { stateChanges: Observable; } -/** A datepicker that can be attached to a {@link MatDatepickerControl}. */ +/** A datepicker that can be attached to a `MatDatepickerControl`. */ export interface MatDatepickerPanel< C extends MatDatepickerControl, S,