Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

javadoc truncated on converting from Props -> Builder #1094

Closed
1 of 4 tasks
nija-at opened this issue Dec 8, 2019 · 1 comment · Fixed by #1111
Closed
1 of 4 tasks

javadoc truncated on converting from Props -> Builder #1094

nija-at opened this issue Dec 8, 2019 · 1 comment · Fixed by #1111
Labels
bug This issue is a bug.

Comments

@nija-at
Copy link
Contributor

nija-at commented Dec 8, 2019

🐛 Bug Report

Affected Languages

  • TypeScript or Javascript
  • Python
  • Java
  • .NET (C#, F#, ...)

What is the problem?

Compare FunctionProps.handler in typescript vs java

Screenshot 2019-12-07 at 17 01 43

Screenshot 2019-12-07 at 17 01 19
@nija-at nija-at added the bug This issue is a bug. label Dec 8, 2019
@nija-at nija-at changed the title javadoc concatenated on converting from Props -> Builder javadoc truncated on converting from Props -> Builder Dec 8, 2019
@RomainMuller
Copy link
Contributor

This is because the second paragraph and further gets into a "remarks" section and is not in the "summary" section. Code generation appears to ignore remarks.

RomainMuller added a commit that referenced this issue Dec 10, 2019
@RomainMuller
fix(java): missing remarks in builder documentation
ab7b098 
The Javadoc entries for setting methods on the generated `Builder`
classes did not represent the `remarks` section of the `docs` object,
resulting in only partial documentation being available on the builders.

This makes sure the `remarks` section gets rendered correctly in all the
locations that previously ignored it, and the fix is demonstrated good
by virtue of the changes it induced in the regression test improvements.

Fixes #1094
@RomainMuller RomainMuller mentioned this issue Dec 10, 2019
Merged
@mergify mergify bot closed this as completed in #1111 Dec 10, 2019
mergify bot pushed a commit that referenced this issue Dec 10, 2019
@RomainMuller @mergify
fix(java): missing remarks in builder documentation (#1111)
33e820c 
The Javadoc entries for setting methods on the generated `Builder`
classes did not represent the `remarks` section of the `docs` object,
resulting in only partial documentation being available on the builders.

This makes sure the `remarks` section gets rendered correctly in all the
locations that previously ignored it, and the fix is demonstrated good
by virtue of the changes it induced in the regression test improvements.

Fixes #1094
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug This issue is a bug.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(java): missing remarks in builder documentation aws/jsii
2 participants
@RomainMuller @nija-at