Repository navigation
Strip trailing asterisks before */ in Javadoc comments - #115
Merged
Merged
Conversation
Decorative closing delimiters such as `/** ... **/` previously had the trailing asterisk retained as comment body content, resulting in `/** ... * */`. Ported from google/google-java-format#1474 (commit 2957b192). In this fork stripJavadocBeginAndEnd lives in JavadocLexer; the tests were written first and failed with `* */` before the change.
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.
Port of google/google-java-format#1474 (Liam Miller-Cushon, merged upstream 2026-10-06; author kept on the commit).
With Javadoc formatting on, a decorative closing delimiter such as
/** ... **/kept the extra asterisk as comment text and came out as/** ... * */.stripJavadocBeginAndEndnow drops any run of*directly before the closing*/.In this fork the method lives in
JavadocLexer, notJavadocFormatter, otherwise the change is upstream's four lines.Done test-first:
trailingAsterisksBeforeClose(upstream's case) andtrailingAsterisksOnTheirOwnLine(***/on its own line) both failed with* */before the fix. Full module suite: 1611 tests, 0 failures.Only reachable through
JavaFormatterOptions.formatJavadoc(true); the CLI and plugins are unaffected.