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.

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

fix(java): missing remarks in builder documentation #1111

Merged
merged 1 commit into from
Dec 10, 2019
Merged

Conversation

RomainMuller
Copy link
Contributor

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


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

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 requested a review from a team as a code owner December 10, 2019 23:01
@RomainMuller RomainMuller self-assigned this Dec 10, 2019
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Copy link
Contributor

@MrArnoldPalmer MrArnoldPalmer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<p>NOTE: Looks good to me.</p>

@mergify
Copy link
Contributor

mergify bot commented Dec 10, 2019

Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it!

@mergify mergify bot merged commit 33e820c into master Dec 10, 2019
@mergify mergify bot deleted the rmuller/fix/1094 branch December 10, 2019 23:26
@mergify mergify bot removed the ready-to-merge label Dec 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

javadoc truncated on converting from Props -> Builder
3 participants