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*
aws · Oct 23, 2024 · 1e73ac5 · 1e73ac5
1 parent d1d179f
commit 1e73ac5
Show file tree

Hide file tree

Showing 43 changed files with 411 additions and 411 deletions.
diff --git a/packages/@aws-cdk/aws-apprunner-alpha/lib/auto-scaling-configuration.ts b/packages/@aws-cdk/aws-apprunner-alpha/lib/auto-scaling-configuration.ts
@@ -133,15 +133,15 @@ export class AutoScalingConfiguration extends cdk.Resource implements IAutoScali
   }
 
   /**
-    * The ARN of the Auto Scaling Configuration.
-    * @attribute
-    */
+   * The ARN of the Auto Scaling Configuration.
+   * @attribute
+   */
   readonly autoScalingConfigurationArn: string;
 
   /**
-    * The name of the Auto Scaling Configuration.
-    * @attribute
-    */
+   * The name of the Auto Scaling Configuration.
+   * @attribute
+   */
   readonly autoScalingConfigurationName: string;
 
   /**

diff --git a/packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts b/packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts
@@ -435,8 +435,8 @@ export abstract class Source {
   }
 
   /**
-    * Called when the Job is initialized to allow this object to bind.
-    */
+   * Called when the Job is initialized to allow this object to bind.
+   */
   public abstract bind(scope: Construct): SourceConfig;
 }
 

diff --git a/packages/@aws-cdk/aws-apprunner-alpha/lib/vpc-connector.ts b/packages/@aws-cdk/aws-apprunner-alpha/lib/vpc-connector.ts
@@ -28,10 +28,10 @@ export interface VpcConnectorProps {
   readonly securityGroups?: ec2.ISecurityGroup[];
 
   /**
-    * The name for the VpcConnector.
-    *
-    * @default - a name generated by CloudFormation
-    */
+   * The name for the VpcConnector.
+   *
+   * @default - a name generated by CloudFormation
+   */
   readonly vpcConnectorName?: string;
 }
 
@@ -109,9 +109,9 @@ export class VpcConnector extends cdk.Resource implements IVpcConnector {
   }
 
   /**
-    * The ARN of the VPC connector.
-    * @attribute
-    */
+   * The ARN of the VPC connector.
+   * @attribute
+   */
   readonly vpcConnectorArn: string;
 
   /**
@@ -121,9 +121,9 @@ export class VpcConnector extends cdk.Resource implements IVpcConnector {
   readonly vpcConnectorRevision: number;
 
   /**
-    * The name of the VPC connector.
-    * @attribute
-    */
+   * The name of the VPC connector.
+   * @attribute
+   */
   readonly vpcConnectorName: string;
 
   /**

diff --git a/packages/@aws-cdk/aws-gamelift-alpha/lib/alias.ts b/packages/@aws-cdk/aws-gamelift-alpha/lib/alias.ts
@@ -186,8 +186,8 @@ export class Alias extends AliasBase {
   public readonly aliasId: string;
 
   /**
-    * The ARN of the alias.
-    */
+   * The ARN of the alias.
+   */
   public readonly aliasArn: string;
 
   /**

diff --git a/packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts b/packages/@aws-cdk/aws-gamelift-alpha/lib/build.ts
@@ -122,10 +122,10 @@ export interface BuildProps {
   readonly buildName?: string;
 
   /**
-    * Version of this build
-    *
-    * @default No version
-    */
+   * Version of this build
+   *
+   * @default No version
+   */
   readonly buildVersion?: string;
 
   /**

diff --git a/packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts b/packages/@aws-cdk/aws-gamelift-alpha/lib/fleet-base.ts
@@ -443,8 +443,8 @@ export abstract class FleetBase extends cdk.Resource implements IFleet {
   }
 
   /**
-    * The Identifier of the fleet.
-    */
+   * The Identifier of the fleet.
+   */
   public abstract readonly fleetId: string;
 
   /**

diff --git a/packages/@aws-cdk/aws-gamelift-alpha/lib/game-server-group.ts b/packages/@aws-cdk/aws-gamelift-alpha/lib/game-server-group.ts
@@ -319,10 +319,10 @@ export interface GameServerGroupProps {
   readonly deleteOption?: DeleteOption;
 
   /**
-    * Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
-    *
-    * @default SPOT_PREFERRED
-    */
+   * Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
+   *
+   * @default SPOT_PREFERRED
+   */
   readonly balancingStrategy?: BalancingStrategy;
 }
 

diff --git a/packages/@aws-cdk/aws-gamelift-alpha/lib/ingress-rule.ts b/packages/@aws-cdk/aws-gamelift-alpha/lib/ingress-rule.ts
@@ -15,25 +15,25 @@ export enum Protocol {
  */
 export interface PortProps {
   /**
-     * The protocol for the range
-     */
+   * The protocol for the range
+   */
   readonly protocol: Protocol;
 
   /**
-     * A starting value for a range of allowed port numbers.
-     *
-     * For fleets using Windows and Linux builds, only ports 1026-60000 are valid.
-     */
+   * A starting value for a range of allowed port numbers.
+   *
+   * For fleets using Windows and Linux builds, only ports 1026-60000 are valid.
+   */
   readonly fromPort: number;
 
   /**
-     * An ending value for a range of allowed port numbers. Port numbers are end-inclusive.
-     * This value must be higher than `fromPort`.
-     *
-     * For fleets using Windows and Linux builds, only ports 1026-60000 are valid.
-     *
-     * @default the `fromPort` value
-     */
+   * An ending value for a range of allowed port numbers. Port numbers are end-inclusive.
+   * This value must be higher than `fromPort`.
+   *
+   * For fleets using Windows and Linux builds, only ports 1026-60000 are valid.
+   *
+   * @default the `fromPort` value
+   */
   readonly toPort?: number;
 }
 
@@ -42,8 +42,8 @@ export interface PortProps {
  */
 export class Port {
   /**
-     * A single TCP port
-     */
+   * A single TCP port
+   */
   public static tcp(port: number): Port {
     return new Port({
       protocol: Protocol.TCP,
@@ -53,8 +53,8 @@ export class Port {
   }
 
   /**
-     * A TCP port range
-     */
+   * A TCP port range
+   */
   public static tcpRange(startPort: number, endPort: number) {
     return new Port({
       protocol: Protocol.TCP,
@@ -64,8 +64,8 @@ export class Port {
   }
 
   /**
-     * Any TCP traffic
-     */
+   * Any TCP traffic
+   */
   public static allTcp() {
     return new Port({
       protocol: Protocol.TCP,
@@ -75,8 +75,8 @@ export class Port {
   }
 
   /**
-     * A single UDP port
-     */
+   * A single UDP port
+   */
   public static udp(port: number): Port {
     return new Port({
       protocol: Protocol.UDP,
@@ -86,8 +86,8 @@ export class Port {
   }
 
   /**
-     * A UDP port range
-     */
+   * A UDP port range
+   */
   public static udpRange(startPort: number, endPort: number) {
     return new Port({
       protocol: Protocol.UDP,
@@ -97,8 +97,8 @@ export class Port {
   }
 
   /**
-     * Any UDP traffic
-     */
+   * Any UDP traffic
+   */
   public static allUdp() {
     return new Port({
       protocol: Protocol.UDP,
@@ -127,13 +127,13 @@ export class Port {
 export interface IPeer {
 
   /**
-     * A unique identifier for this connection peer
-     */
+   * A unique identifier for this connection peer
+   */
   readonly uniqueId: string;
 
   /**
-     * Produce the ingress rule JSON for the given connection
-     */
+   * Produce the ingress rule JSON for the given connection
+   */
   toJson(): any;
 }
 
@@ -147,15 +147,15 @@ export interface IPeer {
    */
 export class Peer {
   /**
-     * Create an IPv4 peer from a CIDR
-     */
+   * Create an IPv4 peer from a CIDR
+   */
   public static ipv4(cidrIp: string): IPeer {
     return new CidrIPv4(cidrIp);
   }
 
   /**
-     * Any IPv4 address
-     */
+   * Any IPv4 address
+   */
   public static anyIpv4(): IPeer {
     return new AnyIPv4();
   }
@@ -188,8 +188,8 @@ class CidrIPv4 implements IPeer {
   }
 
   /**
-     * Produce the ingress rule JSON for the given connection
-     */
+   * Produce the ingress rule JSON for the given connection
+   */
   public toJson(): any {
     return { ipRange: this.cidrIp };
   }
@@ -213,8 +213,8 @@ class AnyIPv4 extends CidrIPv4 {
  */
 export interface IngressRule {
   /**
-     * The port range used for ingress traffic
-     */
+   * The port range used for ingress traffic
+   */
   readonly port: Port;
 
   /**

diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/source.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/source.ts
@@ -8,21 +8,21 @@ import * as kinesis from 'aws-cdk-lib/aws-kinesis';
  */
 interface SourceConfig {
   /**
-     * Configuration for using a Kinesis Data Stream as a source for the delivery stream.
-     *
-     * This will be returned by the _bind method depending on what type of Source class is specified.
-     *
-     * @default - Kinesis Data Stream Source configuration property is not provided.
-     */
+   * Configuration for using a Kinesis Data Stream as a source for the delivery stream.
+   *
+   * This will be returned by the _bind method depending on what type of Source class is specified.
+   *
+   * @default - Kinesis Data Stream Source configuration property is not provided.
+   */
   readonly kinesisStreamSourceConfiguration?: CfnDeliveryStream.KinesisStreamSourceConfigurationProperty;
 
   /**
-     * Configuration for using an MSK (Managed Streaming for Kafka) cluster as a source for the delivery stream.
-     *
-     * This will be returned by the _bind method depending on what type of Source class is specified.
-     *
-     * @default - MSK Source configuration property is not provided.
-     */
+   * Configuration for using an MSK (Managed Streaming for Kafka) cluster as a source for the delivery stream.
+   *
+   * This will be returned by the _bind method depending on what type of Source class is specified.
+   *
+   * @default - MSK Source configuration property is not provided.
+   */
   readonly mskSourceConfiguration?: CfnDeliveryStream.MSKSourceConfigurationProperty;
 }
 

diff --git a/packages/@aws-cdk/aws-kinesisfirehose-destinations-alpha/lib/logging-config.ts b/packages/@aws-cdk/aws-kinesisfirehose-destinations-alpha/lib/logging-config.ts
@@ -8,17 +8,17 @@ import * as logs from 'aws-cdk-lib/aws-logs';
  */
 export interface ILoggingConfig {
   /**
-     * If true, log errors when data transformation or data delivery fails.
-     *
-     * `true` when using `EnableLogging`, `false` when using `DisableLogging`.
-     */
+   * If true, log errors when data transformation or data delivery fails.
+   *
+   * `true` when using `EnableLogging`, `false` when using `DisableLogging`.
+   */
   readonly logging: boolean;
 
   /**
-     * The CloudWatch log group where log streams will be created to hold error logs.
-     *
-     * @default - if `logging` is set to `true`, a log group will be created for you.
-     */
+   * The CloudWatch log group where log streams will be created to hold error logs.
+   *
+   * @default - if `logging` is set to `true`, a log group will be created for you.
+   */
   readonly logGroup?: logs.ILogGroup;
 }
 

diff --git a/packages/@aws-cdk/aws-pipes-alpha/lib/pipe.ts b/packages/@aws-cdk/aws-pipes-alpha/lib/pipe.ts
@@ -115,25 +115,25 @@ export interface PipeProps {
   readonly logDestinations?: ILogDestination[];
 
   /**
-    * The level of logging detail to include.
-    *
-    * This applies to all log destinations for the pipe.
-    *
-    * @see https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html
-    * @default - LogLevel.ERROR
-    */
+   * The level of logging detail to include.
+   *
+   * This applies to all log destinations for the pipe.
+   *
+   * @see https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html
+   * @default - LogLevel.ERROR
+   */
   readonly logLevel?: LogLevel;
 
   /**
-    * Whether the execution data (specifically, the `payload` , `awsRequest` , and `awsResponse` fields) is included in the log messages for this pipe.
-    *
-    * This applies to all log destinations for the pipe.
-    *
-    * 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* .
-    *
-    * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata
-    * @default - none
-    */
+   * Whether the execution data (specifically, the `payload` , `awsRequest` , and `awsResponse` fields) is included in the log messages for this pipe.
+   *
+   * This applies to all log destinations for the pipe.
+   *
+   * 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* .
+   *
+   * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata
+   * @default - none
+   */
   readonly logIncludeExecutionData?: IncludeExecutionData[];
 
   /**