Skip to content

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

Merged
merged 3 commits into from
May 7, 2025
Merged

Use Javadoc snippets #6091

merged 3 commits into from
May 7, 2025

Conversation

debora-ito
Copy link
Member

Motivation and Context

Some code examples in DynamoDB Enhanced Javadoc are not rendering correctly, like this one in DynamoDbIgnoreNulls:

Screenshot 2025-05-05 at 5 20 06 PM

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

  • Run > mvn clean install -pl :dynamodb-enhanced
  • Check the target/apidocs folder

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

License

  • I confirm that this pull request can be released under the Apache 2 license

@debora-ito debora-ito requested a review from a team as a code owner May 6, 2025 18:48
@debora-ito debora-ito added the no-changelog Indicate changelog entry is not required for a specific PR label May 6, 2025
Copy link
Contributor

@alextwoods alextwoods left a 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;
Copy link
Contributor

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.

Copy link
Member Author

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.

Copy link
Contributor

@Fred1155 Fred1155 left a 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

@debora-ito
Copy link
Member Author

@Fred1155 The codebuilds run different when the PR is from a forked repo, don't know why they show duplicate.

Copy link

sonarqubecloud bot commented May 7, 2025

@debora-ito debora-ito enabled auto-merge May 7, 2025 01:45
@debora-ito debora-ito added this pull request to the merge queue May 7, 2025
Merged via the queue into aws:master with commit 6bfc3ef May 7, 2025
11 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Indicate changelog entry is not required for a specific PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants