-
Notifications
You must be signed in to change notification settings - Fork 906
Use Javadoc snippets #6091
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
Use Javadoc snippets #6091
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Minor comment but otherwise looks good!
@@ -40,11 +39,10 @@ | |||
* } | |||
* | |||
* public void setInternalKey(String internalKey) { | |||
* return this.internalKey = internalKey;} | |||
* return this.internalKey = internalKey; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this example code correct? This is a void method (and a setter), so probably shouldn't be returning here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed the extra curly, but not the return
on a setter 🤦🏻♀️
Fixed now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Though why all github build fail after several seconds
@Fred1155 The codebuilds run different when the PR is from a forked repo, don't know why they show duplicate. |
|
Motivation and Context
Some code examples in DynamoDB Enhanced Javadoc are not rendering correctly, like this one in DynamoDbIgnoreNulls:
Modifications
Replace
@code
with@snippet
to avoid issues with formatting, improve readability and display examples in a code block.Also fixed some typos and indentation.
Testing
> mvn clean install -pl :dynamodb-enhanced
target/apidocs
folderScreenshots (if appropriate)
Types of changes
License