Describe the bug
Queue Base exports the interface QueueAttributes .
The interface QueueAttributes defines the queueUrl property among other interface properties.
The QueueAttributes are documented in JSDoc annotation.
In the documentation about queueUrl property as JSDoc annotation, the bug is found.
The @see tag of JSDoc points to a falsy http documentation location.
Expected Behavior
The property queueUrl of the QueueAttributes interface is expected to be documented as JSDoc annotation correctly.
Current Behavior
Below the @see tag of JSDoc annotation for queueUrl as defined in the current code base.
The line of code in the repository is located here
export interface QueueAttributes {
...
/**
* The URL of the queue.
* @see https://docs.aws.amazon.com/sdk-for-net/v2/developer-guide/QueueURL.html
*
* @default - 'https://sqs.<region-endpoint>/<account-ID>/<queue-name>'
*/
readonly queueUrl?: string;
...
} Reproduction Steps
Visit
the lines of code in the current repository here
And use the http resource defined in the JSDoc @see tag, which navigates to the following http location
Possible Solution
2 possible solutions:
- The
@see JSDoc tag should be removed
export interface QueueAttributes {
...
/**
* The URL of the queue.
*
* @default - 'https://sqs.<region-endpoint>/<account-ID>/<queue-name>'
*/
readonly queueUrl?: string;
...
}
- correct the
@see tag of JSDoc to point to the following http location
export interface QueueAttributes {
...
/**
* The URL of the queue.
* @see https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html#SQS-GetQueueUrl-response-QueueUrl
*
* @default - 'https://sqs.<region-endpoint>/<account-ID>/<queue-name>'
*/
readonly queueUrl?: string;
...
}
### Additional Information/Context
_No response_
### CDK CLI Version
2.121.1 (build d86bb1a)
### Framework Version
_No response_
### Node.js Version
v20.11.0
### OS
ubuntu
### Language
TypeScript
### Language Version
_No response_
### Other information
_No response_
Describe the bug
Queue Base exports the interface
QueueAttributes.The interface
QueueAttributesdefines thequeueUrlproperty among other interface properties.The
QueueAttributesare documented in JSDoc annotation.In the documentation about
queueUrlproperty as JSDoc annotation, the bug is found.The
@seetag of JSDoc points to a falsy http documentation location.Expected Behavior
The property
queueUrlof theQueueAttributesinterface is expected to be documented as JSDoc annotation correctly.Current Behavior
Below the
@seetag of JSDoc annotation forqueueUrlas defined in the current code base.The line of code in the repository is located here
Reproduction Steps
Visit
the lines of code in the current repository here
And use the http resource defined in the JSDoc
@seetag, which navigates to the following http locationPossible Solution
2 possible solutions:
@seeJSDoc tag should be removed@seetag of JSDoc to point to the following http location