Preserve /// markers when wrapping long line comments - #1434
Open
arimu1 wants to merge 1 commit into
Open
Conversation
When wrapping line comments that start with ///, reuse that marker on continuation lines instead of hardcoding //. Also treat the full marker length as non-breakable so long unbreakable tokens (e.g. markdown links) are left intact rather than splitting after the leading ///. Fixes google#1369
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
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
Fixes #1369
wrapLineCommentsalways continued wrapped line comments with//, and treated the non-breakable prefix as length 2. For///comments that meant://in the middle of a///block.///) were split into a bare///line plus a// ...line containing the link.Fix
In
JavaCommentsHelper.wrapLineComments://,///, …) and reuse that marker on continuations.//behavior so unbreakable content after///is left as a single over-length line rather than mangled.Tests
FormatterTest.wrapTripleSlashLineCommentPreservesPrefix— wrappable///text continues with///FormatterTest.doNotBreakLongUnbreakableTripleSlashLink— regression for the issue example (100/101-char markdown links)JavadocFormattingTest.simpleMarkdownexpected output for non-javadoc///lines (previously encoded the buggy//wrap)Test plan
mvn -pl core teston Temurin 25 — 1624 tests, 0 failures//