fix: use single-line comments for SNIP markers to avoid NotJavadoc warnings #765
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rnings ErrorProne's NotJavadoc check flags `/**` block comments that aren't actual Javadoc. The SNIP markers are for documentation extraction, not Javadoc, so use `//` single-line comments instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
/**block comments to//single-line comments in envconfig samples-WerrorFiles Changed
core/src/main/java/io/temporal/samples/envconfig/LoadFromFile.javacore/src/main/java/io/temporal/samples/envconfig/LoadProfile.javaTest plan
./gradlew :core:compileJavapasses./gradlew build -x :springboot:testpasses (excluding pre-existing test failure)Note:
HelloSampleTestMockedActivitytest failure is a pre-existing issue unrelated to this change.