Skip to content

Commit

Permalink
fix(jsii-pacmak): emit correct @return tag for JavaDocs (#4095)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
rix0rrr committed May 12, 2023
1 parent bb07f0b commit fc7ab7c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion packages/jsii-pacmak/lib/targets/java.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2226,7 +2226,7 @@ class JavaGenerator extends Generator {
this.code.line();
this.code.line('/**');
this.code.line(
` * @returns a newly built instance of {@link ${builtType}}.`,
` * @return a newly built instance of {@link ${builtType}}.`,
);
this.code.line(' */');
this.emitStabilityAnnotations(cls.initializer);
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fc7ab7c

Please sign in to comment.