Skip to content

Commit fc7ab7c

Browse files
authored
fix(jsii-pacmak): emit correct @return tag for JavaDocs (#4095)
We are currently emitting `@returns`, but: ``` error: unknown tag: returns * @returns a newly built instance of {@link software.amazon.awscdk.services.codedeploy.EcsDeploymentConfig}. ``` It should be `@return`. --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license]. [Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
1 parent bb07f0b commit fc7ab7c

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

packages/jsii-pacmak/lib/targets/java.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2226,7 +2226,7 @@ class JavaGenerator extends Generator {
22262226
this.code.line();
22272227
this.code.line('/**');
22282228
this.code.line(
2229-
` * @returns a newly built instance of {@link ${builtType}}.`,
2229+
` * @return a newly built instance of {@link ${builtType}}.`,
22302230
);
22312231
this.code.line(' */');
22322232
this.emitStabilityAnnotations(cls.initializer);

packages/jsii-pacmak/test/generated-code/__snapshots__/target-java.test.js.snap

Lines changed: 11 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)