Skip to content

Commit ede6331

Browse files
authored
docs(multiple): remove invalid tags from doc strings (#31317)
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.
1 parent 8d1860e commit ede6331

File tree

7 files changed

+18
-19
lines changed

7 files changed

+18
-19
lines changed

src/cdk/collections/dispose-view-repeater-strategy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323

2424
/**
2525
* A repeater that destroys views when they are removed from a
26-
* {@link ViewContainerRef}. When new items are inserted into the container,
26+
* `ViewContainerRef`. When new items are inserted into the container,
2727
* the repeater will always construct a new embedded view for each item.
2828
*
2929
* @template T The type for the embedded view's $implicit property.

src/cdk/collections/recycle-view-repeater-strategy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import {
2424

2525
/**
2626
* A repeater that caches views when they are removed from a
27-
* {@link ViewContainerRef}. When new items are inserted into the container,
27+
* `ViewContainerRef`. When new items are inserted into the container,
2828
* the repeater will reuse one of the cached views instead of creating a new
2929
* embedded view. Recycling cached views reduces the quantity of expensive DOM
3030
* inserts.

src/cdk/collections/view-repeater.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ export type _ViewRepeaterItemContextFactory<T, R, C extends _ViewRepeaterItemCon
5050
) => _ViewRepeaterItemInsertArgs<C>;
5151

5252
/**
53-
* Extracts the value of an item from an {@link IterableChangeRecord}.
53+
* Extracts the value of an item from an `IterableChangeRecord`.
5454
*
5555
* @template T The type for the embedded view's $implicit property.
5656
* @template R The type for the item in each IterableDiffer change record.
5757
*/
5858
export type _ViewRepeaterItemValueResolver<T, R> = (record: IterableChangeRecord<R>) => T;
5959

60-
/** Indicates how a view was changed by a {@link _ViewRepeater}. */
60+
/** Indicates how a view was changed by a `_ViewRepeater`. */
6161
export enum _ViewRepeaterOperation {
6262
/** The content of an existing view was replaced with another item. */
6363
REPLACED,
@@ -70,8 +70,7 @@ export enum _ViewRepeaterOperation {
7070
}
7171

7272
/**
73-
* Meta data describing the state of a view after it was updated by a
74-
* {@link _ViewRepeater}.
73+
* Meta data describing the state of a view after it was updated by a `_ViewRepeater`.
7574
*
7675
* @template R The type for the item in each IterableDiffer change record.
7776
* @template C The type for the context passed to each embedded view.
@@ -94,7 +93,7 @@ export interface _ViewRepeaterItemChange<R, C> {
9493
export type _ViewRepeaterItemChanged<R, C> = (change: _ViewRepeaterItemChange<R, C>) => void;
9594

9695
/**
97-
* Describes a strategy for rendering items in a {@link ViewContainerRef}.
96+
* Describes a strategy for rendering items in a `ViewContainerRef`.
9897
*
9998
* @template T The type for the embedded view's $implicit property.
10099
* @template R The type for the item in each IterableDiffer change record.
@@ -113,7 +112,7 @@ export interface _ViewRepeater<T, R, C extends _ViewRepeaterItemContext<T>> {
113112
}
114113

115114
/**
116-
* Injection token for {@link _ViewRepeater}. This token is for use by Angular Material only.
115+
* Injection token for `_ViewRepeater`. This token is for use by Angular Material only.
117116
* @docs-private
118117
*/
119118
export const _VIEW_REPEATER_STRATEGY = new InjectionToken<

src/cdk/scrolling/virtual-scrollable.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {CdkScrollable} from './scrollable';
1212
export const VIRTUAL_SCROLLABLE = new InjectionToken<CdkVirtualScrollable>('VIRTUAL_SCROLLABLE');
1313

1414
/**
15-
* Extending the {@link CdkScrollable} to be used as scrolling container for virtual scrolling.
15+
* Extending the `CdkScrollable` to be used as scrolling container for virtual scrolling.
1616
*/
1717
@Directive()
1818
export abstract class CdkVirtualScrollable extends CdkScrollable {

src/cdk/table/table.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ export class CdkTable<T>
389389
/**
390390
* Whether the sticky styler should recalculate cell widths when applying sticky styles. If
391391
* `false`, cached values will be used instead. This is only applicable to tables with
392-
* {@link fixedLayout} enabled. For other tables, cell widths will always be recalculated.
392+
* `_fixedLayout` enabled. For other tables, cell widths will always be recalculated.
393393
*/
394394
private _forceRecalculateCellWidths = true;
395395

src/google-maps/map-marker-clusterer/map-marker-clusterer-types.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,16 @@ export type onClusterClickHandler = (
6868
export interface MarkerClustererOptions {
6969
markers?: Marker[];
7070
/**
71-
* An algorithm to cluster markers. Default is {@link SuperClusterAlgorithm}. Must
72-
* provide a `calculate` method accepting {@link AlgorithmInput} and returning
73-
* an array of {@link Cluster}.
71+
* An algorithm to cluster markers. Default is `SuperClusterAlgorithm`. Must
72+
* provide a `calculate` method accepting `AlgorithmInput` and returning
73+
* an array of `Cluster`.
7474
*/
7575
algorithm?: Algorithm;
7676
algorithmOptions?: AlgorithmOptions;
7777
map?: google.maps.Map | null;
7878
/**
79-
* An object that converts a {@link Cluster} into a `google.maps.Marker`.
80-
* Default is {@link DefaultRenderer}.
79+
* An object that converts a `Cluster` into a `google.maps.Marker`.
80+
* Default is `DefaultRenderer`.
8181
*/
8282
renderer?: Renderer;
8383
onClusterClick?: onClusterClickHandler;
@@ -93,7 +93,7 @@ export declare const defaultOnClusterClickHandler: onClusterClickHandler;
9393

9494
export interface Renderer {
9595
/**
96-
* Turn a {@link Cluster} into a `Marker`.
96+
* Turn a `Cluster` into a `Marker`.
9797
*
9898
* Below is a simple example to create a marker with the number of markers in the cluster as a label.
9999
*
@@ -125,7 +125,7 @@ export interface ClusterStats {
125125

126126
export interface Algorithm {
127127
/**
128-
* Calculates an array of {@link Cluster}.
128+
* Calculates an array of `Cluster`.
129129
*/
130130
calculate: ({markers, map}: AlgorithmInput) => AlgorithmOutput;
131131
}
@@ -156,7 +156,7 @@ export interface AlgorithmInput {
156156

157157
export interface AlgorithmOutput {
158158
/**
159-
* The clusters returned based upon the {@link AlgorithmInput}.
159+
* The clusters returned based upon the `AlgorithmInput`.
160160
*/
161161
clusters: Cluster[];
162162
/**

src/material/datepicker/datepicker-base.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ export interface MatDatepickerControl<D> {
352352
stateChanges: Observable<void>;
353353
}
354354

355-
/** A datepicker that can be attached to a {@link MatDatepickerControl}. */
355+
/** A datepicker that can be attached to a `MatDatepickerControl`. */
356356
export interface MatDatepickerPanel<
357357
C extends MatDatepickerControl<D>,
358358
S,

0 commit comments

Comments
 (0)