Skip to content

Commit bbbd9b2

Browse files
authored
chore(docs): remove {@link} everywhere (#23572)
The `{@link }` annotation doesn't work and has never worked, yet has cropped up in a lot of places in our docstrings, and it will only get worse as people look around and copy/paste. Do a mass removal of the `{@link}` tags. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent ac2dd48 commit bbbd9b2

File tree

121 files changed

+440
-440
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+440
-440
lines changed

packages/@aws-cdk/aws-apigateway/lib/authorizers/lambda.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ export interface LambdaAuthorizerProps {
2020
/**
2121
* The handler for the authorizer lambda function.
2222
*
23-
* The handler must follow a very specific protocol on the input it receives and the output it needs to produce.
24-
* API Gateway has documented the handler's input specification
25-
* {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html | here} and output specification
26-
* {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html | here}.
23+
* The handler must follow a very specific protocol on the input it receives
24+
* and the output it needs to produce. API Gateway has documented the
25+
* handler's [input specification](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html)
26+
* and [output specification](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html).
2727
*/
2828
readonly handler: lambda.IFunction;
2929

packages/@aws-cdk/aws-apigateway/lib/lambda-api.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export interface LambdaRestApiProps extends RestApiProps {
1717
/**
1818
* Specific Lambda integration options.
1919
*
20-
* @default see defaults defined in {@link LambdaIntegrationOptions}.
20+
* @default see defaults defined in `LambdaIntegrationOptions`.
2121
*/
2222
readonly integrationOptions?: LambdaIntegrationOptions;
2323

packages/@aws-cdk/aws-apigateway/lib/method.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ export interface MethodOptions {
2525
* Method authorization.
2626
* If the value is set of `Custom`, an `authorizer` must also be specified.
2727
*
28-
* If you're using one of the authorizers that are available via the {@link Authorizer} class, such as {@link Authorizer#token()},
28+
* If you're using one of the authorizers that are available via the `Authorizer` class, such as `Authorizer#token()`,
2929
* it is recommended that this option not be specified. The authorizer will take care of setting the correct authorization type.
30-
* However, specifying an authorization type using this property that conflicts with what is expected by the {@link Authorizer}
30+
* However, specifying an authorization type using this property that conflicts with what is expected by the `Authorizer`
3131
* will result in an error.
3232
*
3333
* @default - open access unless `authorizer` is specified

packages/@aws-cdk/aws-apigateway/lib/restapi.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ export abstract class RestApiBase extends Resource implements IRestApi {
616616
/**
617617
* Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.
618618
*
619-
* Some properties normally accessible on @see {@link RestApi} - such as the description -
619+
* Some properties normally accessible on @see `RestApi` - such as the description -
620620
* must be declared in the specification. All Resources and Methods need to be defined as
621621
* part of the OpenAPI specification file, and cannot be added via the CDK.
622622
*

packages/@aws-cdk/aws-appmesh/lib/http-route-path-match.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { Construct } from 'constructs';
22
import { CfnGatewayRoute, CfnRoute } from './appmesh.generated';
33

44
/**
5-
* The type returned from the `bind()` method in {@link HttpRoutePathMatch}.
5+
* The type returned from the `bind()` method in `HttpRoutePathMatch`.
66
*/
77
export interface HttpRoutePathMatchConfig {
88
/**
@@ -94,7 +94,7 @@ class HttpRouteWholePathMatch extends HttpRoutePathMatch {
9494
}
9595

9696
/**
97-
* The type returned from the `bind()` method in {@link HttpGatewayRoutePathMatch}.
97+
* The type returned from the `bind()` method in `HttpGatewayRoutePathMatch`.
9898
*/
9999
export interface HttpGatewayRoutePathMatchConfig {
100100
/**

packages/@aws-cdk/aws-appmesh/lib/tls-certificate.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { Construct } from 'constructs';
33
import { CfnVirtualNode } from './appmesh.generated';
44

55
/**
6-
* A wrapper for the tls config returned by {@link TlsCertificate.bind}
6+
* A wrapper for the tls config returned by `TlsCertificate.bind`
77
*/
88
export interface TlsCertificateConfig {
99
/**

packages/@aws-cdk/aws-autoscaling/lib/volume.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,22 +48,22 @@ export interface EbsDeviceOptionsBase {
4848
/**
4949
* The number of I/O operations per second (IOPS) to provision for the volume.
5050
*
51-
* Must only be set for {@link volumeType}: {@link EbsDeviceVolumeType.IO1}
51+
* Must only be set for `volumeType`: `EbsDeviceVolumeType.IO1`
5252
*
5353
* The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS,
5454
* you need at least 100 GiB storage on the volume.
5555
*
5656
* @see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
5757
*
58-
* @default - none, required for {@link EbsDeviceVolumeType.IO1}
58+
* @default - none, required for `EbsDeviceVolumeType.IO1`
5959
*/
6060
readonly iops?: number;
6161

6262
/**
6363
* The EBS volume type
6464
* @see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
6565
*
66-
* @default {@link EbsDeviceVolumeType.GP2}
66+
* @default `EbsDeviceVolumeType.GP2`
6767
*/
6868
readonly volumeType?: EbsDeviceVolumeType;
6969

packages/@aws-cdk/aws-batch/lib/job-definition-image-config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ interface TaskDefinitionProps {
1919
* Batch Job Task Definition
2020
*
2121
* Defines a Batch Job Task Definition. The properties of this task definition mirrors
22-
* those of an {@link ecs.ContainerDefinition}. This class is a wrapper on that structure.
22+
* those of an `ecs.ContainerDefinition`. This class is a wrapper on that structure.
2323
*/
2424
class TaskDefinition {
2525
/**

packages/@aws-cdk/aws-batch/lib/job-definition.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ export interface JobDefinitionContainer {
244244
}
245245

246246
/**
247-
* Construction properties of the {@link JobDefinition} construct.
247+
* Construction properties of the `JobDefinition` construct.
248248
*/
249249
export interface JobDefinitionProps {
250250
/**
@@ -361,14 +361,14 @@ export interface INodeRangeProps {
361361
* to the number of nodes associated with the job. You may nest node ranges, for example 0:10 and 4:5,
362362
* in which case the 4:5 range properties override the 0:10 properties.
363363
*
364-
* @default {@link IMultiNodeprops.count}
364+
* @default `IMultiNodeprops.count`
365365
*/
366366
toNodeIndex?: number;
367367
}
368368

369369
/**
370370
* An interface representing a job definition - either a new one, created with the CDK, *using the
371-
* {@link JobDefinition} class, or existing ones, referenced using the {@link JobDefinition.fromJobDefinitionArn} method.
371+
* `JobDefinition` class, or existing ones, referenced using the `JobDefinition.fromJobDefinitionArn` method.
372372
*/
373373
export interface IJobDefinition extends IResource {
374374
/**

packages/@aws-cdk/aws-cloudformation/lib/custom-resource.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export type Properties = {[key: string]: any};
1313
/**
1414
* Configuration options for custom resource providers.
1515
*
16-
* @deprecated used in {@link ICustomResourceProvider} which is now deprecated
16+
* @deprecated used in `ICustomResourceProvider` which is now deprecated
1717
*/
1818
export interface CustomResourceProviderConfig {
1919
/**

packages/@aws-cdk/aws-cloudfront-origins/lib/origin-group.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as cloudfront from '@aws-cdk/aws-cloudfront';
22
import { Construct } from 'constructs';
33

4-
/** Construction properties for {@link OriginGroup}. */
4+
/** Construction properties for `OriginGroup`. */
55
export interface OriginGroupProps {
66
/**
77
* The primary origin that should serve requests for this group.

packages/@aws-cdk/aws-cloudfront/lib/distribution.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ export enum LambdaEdgeEventType {
707707

708708
/**
709709
* Represents a Lambda function version and event type when using Lambda@Edge.
710-
* The type of the {@link AddBehaviorOptions.edgeLambdas} property.
710+
* The type of the `AddBehaviorOptions.edgeLambdas` property.
711711
*/
712712
export interface EdgeLambda {
713713
/**

packages/@aws-cdk/aws-cloudfront/lib/function.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ export enum FunctionEventType {
202202

203203
/**
204204
* Represents a CloudFront function and event type when using CF Functions.
205-
* The type of the {@link AddBehaviorOptions.functionAssociations} property.
205+
* The type of the `AddBehaviorOptions.functionAssociations` property.
206206
*/
207207
export interface FunctionAssociation {
208208
/**

packages/@aws-cdk/aws-cloudfront/lib/origin.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { CfnDistribution } from './cloudfront.generated';
44

55
/**
66
* The failover configuration used for Origin Groups,
7-
* returned in {@link OriginBindConfig.failoverConfig}.
7+
* returned in `OriginBindConfig.failoverConfig`.
88
*/
99
export interface OriginFailoverConfig {
1010
/** The origin to use as the fallback origin. */
@@ -18,7 +18,7 @@ export interface OriginFailoverConfig {
1818
readonly statusCodes?: number[];
1919
}
2020

21-
/** The struct returned from {@link IOrigin.bind}. */
21+
/** The struct returned from `IOrigin.bind`. */
2222
export interface OriginBindConfig {
2323
/**
2424
* The CloudFormation OriginProperty configuration for this Origin.

packages/@aws-cdk/aws-cloudfront/lib/web-distribution.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export enum FailoverStatusCode {
5454
* "cloudfront.net" domain. To use this feature you must provide the list of
5555
* additional domains, and the ACM Certificate that CloudFront should use for
5656
* these additional domains.
57-
* @deprecated see {@link CloudFrontWebDistributionProps#viewerCertificate} with {@link ViewerCertificate#acmCertificate}
57+
* @deprecated see `CloudFrontWebDistributionProps#viewerCertificate` with `ViewerCertificate#acmCertificate`
5858
*/
5959
export interface AliasConfiguration {
6060
/**
@@ -557,7 +557,7 @@ export class ViewerCertificate {
557557
/**
558558
* Generate a viewer certifcate configuration using
559559
* the CloudFront default certificate (e.g. d111111abcdef8.cloudfront.net)
560-
* and a {@link SecurityPolicyProtocol.TLS_V1} security policy.
560+
* and a `SecurityPolicyProtocol.TLS_V1` security policy.
561561
*
562562
* @param aliases Alternative CNAME aliases
563563
* You also must create a CNAME record with your DNS service to route queries
@@ -577,7 +577,7 @@ export interface CloudFrontWebDistributionProps {
577577
* AliasConfiguration is used to configured CloudFront to respond to requests on custom domain names.
578578
*
579579
* @default - None.
580-
* @deprecated see {@link CloudFrontWebDistributionProps#viewerCertificate} with {@link ViewerCertificate#acmCertificate}
580+
* @deprecated see `CloudFrontWebDistributionProps#viewerCertificate` with `ViewerCertificate#acmCertificate`
581581
*/
582582
readonly aliasConfiguration?: AliasConfiguration;
583583

packages/@aws-cdk/aws-codebuild/lib/artifacts.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { CfnProject } from './codebuild.generated';
44
import { IProject } from './project';
55

66
/**
7-
* The type returned from {@link IArtifacts#bind}.
7+
* The type returned from `IArtifacts#bind`.
88
*/
99
export interface ArtifactsConfig {
1010
/**
@@ -15,7 +15,7 @@ export interface ArtifactsConfig {
1515

1616
/**
1717
* The abstract interface of a CodeBuild build output.
18-
* Implemented by {@link Artifacts}.
18+
* Implemented by `Artifacts`.
1919
*/
2020
export interface IArtifacts {
2121
/**
@@ -75,7 +75,7 @@ export abstract class Artifacts implements IArtifacts {
7575
}
7676

7777
/**
78-
* Construction properties for {@link S3Artifacts}.
78+
* Construction properties for `S3Artifacts`.
7979
*/
8080
export interface S3ArtifactsProps extends ArtifactsProps {
8181
/**

packages/@aws-cdk/aws-codebuild/lib/file-location.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { CfnProject } from './codebuild.generated';
33
import { IProject } from './project';
44

55
/**
6-
* The type returned from {@link IFileSystemLocation#bind}.
6+
* The type returned from `IFileSystemLocation#bind`.
77
*/
88
export interface FileSystemConfig {
99
/**
@@ -15,7 +15,7 @@ export interface FileSystemConfig {
1515

1616
/**
1717
* The interface of a CodeBuild FileSystemLocation.
18-
* Implemented by {@link EfsFileSystemLocation}.
18+
* Implemented by `EfsFileSystemLocation`.
1919
*/
2020
export interface IFileSystemLocation {
2121
/**
@@ -58,7 +58,7 @@ class EfsFileSystemLocation implements IFileSystemLocation {
5858
}
5959

6060
/**
61-
* Construction properties for {@link EfsFileSystemLocation}.
61+
* Construction properties for `EfsFileSystemLocation`.
6262
*/
6363
export interface EfsFileSystemLocationProps {
6464
/**
@@ -83,4 +83,4 @@ export interface EfsFileSystemLocationProps {
8383
* The location in the container where you mount the file system.
8484
*/
8585
readonly mountPoint: string;
86-
}
86+
}

packages/@aws-cdk/aws-codebuild/lib/linux-arm-build-image.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import { runScriptLinuxBuildSpec } from './private/run-script-linux-build-spec';
55
import { BuildEnvironment, ComputeType, IBuildImage, ImagePullPrincipalType } from './project';
66

77
/**
8-
* Construction properties of {@link LinuxArmBuildImage}.
9-
* Module-private, as the constructor of {@link LinuxArmBuildImage} is private.
8+
* Construction properties of `LinuxArmBuildImage`.
9+
* Module-private, as the constructor of `LinuxArmBuildImage` is private.
1010
*/
1111
interface LinuxArmBuildImageProps {
1212
readonly imageId: string;

0 commit comments

Comments
 (0)