Add missing Javadoc paragraph tags#931
Open
pratheeknaidu wants to merge 4 commits into
Open
Conversation
- Remove redundant changed flag since withBody is idempotent - Skip injecting <p> before block-level HTML elements and inside <pre>
DocComment.withBody uses reference equality (this.body == body), so returning a freshly-built list unconditionally reports a change on every cycle. Restore the guard that returns the original DocComment when no <p> was inserted, matching the RemoveJavaDocAuthorTag idiom. Add regression tests confirming <p> is not injected before block-level HTML nor inside <pre> blocks, and that prose after a </pre> is still tagged.
flatMap returns the original list reference when no element changes, so withBody's identity check makes the visitor idempotent without a changed flag; the flatMap 1-to-many mapping covers the <p>-insertion case.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
JavadocParagraphrecipe that inserts missing<p>tags after blank Javadoc lines<p>tags, block-tag sections, whitespace, and line endingsTesting
./gradlew test --rerun-tasksAddresses JavadocParagraph #545.