Skip to content

Commit 1e73ac5

Browse files
docs: fix improper JSDoc formatting (#31820)
### Issue # (if applicable) None ### Reason for this change There are some improper JSDoc formatting. ### Description of changes I have corrected multiple instances of improper JSDoc formatting. ```diff /** - * description - * - * @default - xxx - */ + * description + * + * @default - xxx + */ ``` ### Description of how you validated changes None ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent d1d179f commit 1e73ac5

File tree

43 files changed

+411
-411
lines changed

Some content is hidden

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

43 files changed

+411
-411
lines changed

packages/@aws-cdk/aws-apprunner-alpha/lib/auto-scaling-configuration.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -133,15 +133,15 @@ export class AutoScalingConfiguration extends cdk.Resource implements IAutoScali
133133
}
134134

135135
/**
136-
* The ARN of the Auto Scaling Configuration.
137-
* @attribute
138-
*/
136+
* The ARN of the Auto Scaling Configuration.
137+
* @attribute
138+
*/
139139
readonly autoScalingConfigurationArn: string;
140140

141141
/**
142-
* The name of the Auto Scaling Configuration.
143-
* @attribute
144-
*/
142+
* The name of the Auto Scaling Configuration.
143+
* @attribute
144+
*/
145145
readonly autoScalingConfigurationName: string;
146146

147147
/**

packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -435,8 +435,8 @@ export abstract class Source {
435435
}
436436

437437
/**
438-
* Called when the Job is initialized to allow this object to bind.
439-
*/
438+
* Called when the Job is initialized to allow this object to bind.
439+
*/
440440
public abstract bind(scope: Construct): SourceConfig;
441441
}
442442

packages/@aws-cdk/aws-apprunner-alpha/lib/vpc-connector.ts

+10-10
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ export interface VpcConnectorProps {
2828
readonly securityGroups?: ec2.ISecurityGroup[];
2929

3030
/**
31-
* The name for the VpcConnector.
32-
*
33-
* @default - a name generated by CloudFormation
34-
*/
31+
* The name for the VpcConnector.
32+
*
33+
* @default - a name generated by CloudFormation
34+
*/
3535
readonly vpcConnectorName?: string;
3636
}
3737

@@ -109,9 +109,9 @@ export class VpcConnector extends cdk.Resource implements IVpcConnector {
109109
}
110110

111111
/**
112-
* The ARN of the VPC connector.
113-
* @attribute
114-
*/
112+
* The ARN of the VPC connector.
113+
* @attribute
114+
*/
115115
readonly vpcConnectorArn: string;
116116

117117
/**
@@ -121,9 +121,9 @@ export class VpcConnector extends cdk.Resource implements IVpcConnector {
121121
readonly vpcConnectorRevision: number;
122122

123123
/**
124-
* The name of the VPC connector.
125-
* @attribute
126-
*/
124+
* The name of the VPC connector.
125+
* @attribute
126+
*/
127127
readonly vpcConnectorName: string;
128128

129129
/**

packages/@aws-cdk/aws-gamelift-alpha/lib/alias.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ export class Alias extends AliasBase {
186186
public readonly aliasId: string;
187187

188188
/**
189-
* The ARN of the alias.
190-
*/
189+
* The ARN of the alias.
190+
*/
191191
public readonly aliasArn: string;
192192

193193
/**

packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,10 @@ export interface BuildProps {
122122
readonly buildName?: string;
123123

124124
/**
125-
* Version of this build
126-
*
127-
* @default No version
128-
*/
125+
* Version of this build
126+
*
127+
* @default No version
128+
*/
129129
readonly buildVersion?: string;
130130

131131
/**

packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -443,8 +443,8 @@ export abstract class FleetBase extends cdk.Resource implements IFleet {
443443
}
444444

445445
/**
446-
* The Identifier of the fleet.
447-
*/
446+
* The Identifier of the fleet.
447+
*/
448448
public abstract readonly fleetId: string;
449449

450450
/**

packages/@aws-cdk/aws-gamelift-alpha/lib/game-server-group.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -319,10 +319,10 @@ export interface GameServerGroupProps {
319319
readonly deleteOption?: DeleteOption;
320320

321321
/**
322-
* Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
323-
*
324-
* @default SPOT_PREFERRED
325-
*/
322+
* Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
323+
*
324+
* @default SPOT_PREFERRED
325+
*/
326326
readonly balancingStrategy?: BalancingStrategy;
327327
}
328328

packages/@aws-cdk/aws-gamelift-alpha/lib/ingress-rule.ts

+37-37
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ export enum Protocol {
1515
*/
1616
export interface PortProps {
1717
/**
18-
* The protocol for the range
19-
*/
18+
* The protocol for the range
19+
*/
2020
readonly protocol: Protocol;
2121

2222
/**
23-
* A starting value for a range of allowed port numbers.
24-
*
25-
* For fleets using Windows and Linux builds, only ports 1026-60000 are valid.
26-
*/
23+
* A starting value for a range of allowed port numbers.
24+
*
25+
* For fleets using Windows and Linux builds, only ports 1026-60000 are valid.
26+
*/
2727
readonly fromPort: number;
2828

2929
/**
30-
* An ending value for a range of allowed port numbers. Port numbers are end-inclusive.
31-
* This value must be higher than `fromPort`.
32-
*
33-
* For fleets using Windows and Linux builds, only ports 1026-60000 are valid.
34-
*
35-
* @default the `fromPort` value
36-
*/
30+
* An ending value for a range of allowed port numbers. Port numbers are end-inclusive.
31+
* This value must be higher than `fromPort`.
32+
*
33+
* For fleets using Windows and Linux builds, only ports 1026-60000 are valid.
34+
*
35+
* @default the `fromPort` value
36+
*/
3737
readonly toPort?: number;
3838
}
3939

@@ -42,8 +42,8 @@ export interface PortProps {
4242
*/
4343
export class Port {
4444
/**
45-
* A single TCP port
46-
*/
45+
* A single TCP port
46+
*/
4747
public static tcp(port: number): Port {
4848
return new Port({
4949
protocol: Protocol.TCP,
@@ -53,8 +53,8 @@ export class Port {
5353
}
5454

5555
/**
56-
* A TCP port range
57-
*/
56+
* A TCP port range
57+
*/
5858
public static tcpRange(startPort: number, endPort: number) {
5959
return new Port({
6060
protocol: Protocol.TCP,
@@ -64,8 +64,8 @@ export class Port {
6464
}
6565

6666
/**
67-
* Any TCP traffic
68-
*/
67+
* Any TCP traffic
68+
*/
6969
public static allTcp() {
7070
return new Port({
7171
protocol: Protocol.TCP,
@@ -75,8 +75,8 @@ export class Port {
7575
}
7676

7777
/**
78-
* A single UDP port
79-
*/
78+
* A single UDP port
79+
*/
8080
public static udp(port: number): Port {
8181
return new Port({
8282
protocol: Protocol.UDP,
@@ -86,8 +86,8 @@ export class Port {
8686
}
8787

8888
/**
89-
* A UDP port range
90-
*/
89+
* A UDP port range
90+
*/
9191
public static udpRange(startPort: number, endPort: number) {
9292
return new Port({
9393
protocol: Protocol.UDP,
@@ -97,8 +97,8 @@ export class Port {
9797
}
9898

9999
/**
100-
* Any UDP traffic
101-
*/
100+
* Any UDP traffic
101+
*/
102102
public static allUdp() {
103103
return new Port({
104104
protocol: Protocol.UDP,
@@ -127,13 +127,13 @@ export class Port {
127127
export interface IPeer {
128128

129129
/**
130-
* A unique identifier for this connection peer
131-
*/
130+
* A unique identifier for this connection peer
131+
*/
132132
readonly uniqueId: string;
133133

134134
/**
135-
* Produce the ingress rule JSON for the given connection
136-
*/
135+
* Produce the ingress rule JSON for the given connection
136+
*/
137137
toJson(): any;
138138
}
139139

@@ -147,15 +147,15 @@ export interface IPeer {
147147
*/
148148
export class Peer {
149149
/**
150-
* Create an IPv4 peer from a CIDR
151-
*/
150+
* Create an IPv4 peer from a CIDR
151+
*/
152152
public static ipv4(cidrIp: string): IPeer {
153153
return new CidrIPv4(cidrIp);
154154
}
155155

156156
/**
157-
* Any IPv4 address
158-
*/
157+
* Any IPv4 address
158+
*/
159159
public static anyIpv4(): IPeer {
160160
return new AnyIPv4();
161161
}
@@ -188,8 +188,8 @@ class CidrIPv4 implements IPeer {
188188
}
189189

190190
/**
191-
* Produce the ingress rule JSON for the given connection
192-
*/
191+
* Produce the ingress rule JSON for the given connection
192+
*/
193193
public toJson(): any {
194194
return { ipRange: this.cidrIp };
195195
}
@@ -213,8 +213,8 @@ class AnyIPv4 extends CidrIPv4 {
213213
*/
214214
export interface IngressRule {
215215
/**
216-
* The port range used for ingress traffic
217-
*/
216+
* The port range used for ingress traffic
217+
*/
218218
readonly port: Port;
219219

220220
/**

packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/source.ts

+12-12
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,21 @@ import * as kinesis from 'aws-cdk-lib/aws-kinesis';
88
*/
99
interface SourceConfig {
1010
/**
11-
* Configuration for using a Kinesis Data Stream as a source for the delivery stream.
12-
*
13-
* This will be returned by the _bind method depending on what type of Source class is specified.
14-
*
15-
* @default - Kinesis Data Stream Source configuration property is not provided.
16-
*/
11+
* Configuration for using a Kinesis Data Stream as a source for the delivery stream.
12+
*
13+
* This will be returned by the _bind method depending on what type of Source class is specified.
14+
*
15+
* @default - Kinesis Data Stream Source configuration property is not provided.
16+
*/
1717
readonly kinesisStreamSourceConfiguration?: CfnDeliveryStream.KinesisStreamSourceConfigurationProperty;
1818

1919
/**
20-
* Configuration for using an MSK (Managed Streaming for Kafka) cluster as a source for the delivery stream.
21-
*
22-
* This will be returned by the _bind method depending on what type of Source class is specified.
23-
*
24-
* @default - MSK Source configuration property is not provided.
25-
*/
20+
* Configuration for using an MSK (Managed Streaming for Kafka) cluster as a source for the delivery stream.
21+
*
22+
* This will be returned by the _bind method depending on what type of Source class is specified.
23+
*
24+
* @default - MSK Source configuration property is not provided.
25+
*/
2626
readonly mskSourceConfiguration?: CfnDeliveryStream.MSKSourceConfigurationProperty;
2727
}
2828

packages/@aws-cdk/aws-kinesisfirehose-destinations-alpha/lib/logging-config.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ import * as logs from 'aws-cdk-lib/aws-logs';
88
*/
99
export interface ILoggingConfig {
1010
/**
11-
* If true, log errors when data transformation or data delivery fails.
12-
*
13-
* `true` when using `EnableLogging`, `false` when using `DisableLogging`.
14-
*/
11+
* If true, log errors when data transformation or data delivery fails.
12+
*
13+
* `true` when using `EnableLogging`, `false` when using `DisableLogging`.
14+
*/
1515
readonly logging: boolean;
1616

1717
/**
18-
* The CloudWatch log group where log streams will be created to hold error logs.
19-
*
20-
* @default - if `logging` is set to `true`, a log group will be created for you.
21-
*/
18+
* The CloudWatch log group where log streams will be created to hold error logs.
19+
*
20+
* @default - if `logging` is set to `true`, a log group will be created for you.
21+
*/
2222
readonly logGroup?: logs.ILogGroup;
2323
}
2424

packages/@aws-cdk/aws-pipes-alpha/lib/pipe.ts

+16-16
Original file line numberDiff line numberDiff line change
@@ -115,25 +115,25 @@ export interface PipeProps {
115115
readonly logDestinations?: ILogDestination[];
116116

117117
/**
118-
* The level of logging detail to include.
119-
*
120-
* This applies to all log destinations for the pipe.
121-
*
122-
* @see https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html
123-
* @default - LogLevel.ERROR
124-
*/
118+
* The level of logging detail to include.
119+
*
120+
* This applies to all log destinations for the pipe.
121+
*
122+
* @see https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html
123+
* @default - LogLevel.ERROR
124+
*/
125125
readonly logLevel?: LogLevel;
126126

127127
/**
128-
* Whether the execution data (specifically, the `payload` , `awsRequest` , and `awsResponse` fields) is included in the log messages for this pipe.
129-
*
130-
* This applies to all log destinations for the pipe.
131-
*
132-
* For more information, see [Including execution data in logs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data) and the [message schema](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs-schema.html) in the *Amazon EventBridge User Guide* .
133-
*
134-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata
135-
* @default - none
136-
*/
128+
* Whether the execution data (specifically, the `payload` , `awsRequest` , and `awsResponse` fields) is included in the log messages for this pipe.
129+
*
130+
* This applies to all log destinations for the pipe.
131+
*
132+
* For more information, see [Including execution data in logs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data) and the [message schema](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs-schema.html) in the *Amazon EventBridge User Guide* .
133+
*
134+
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata
135+
* @default - none
136+
*/
137137
readonly logIncludeExecutionData?: IncludeExecutionData[];
138138

139139
/**

0 commit comments

Comments
 (0)