Skip to content

Strip trailing asterisks before */ in Javadoc comments #115

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.

Sign up for GitHub

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
abashev merged 1 commit into from
Oct 9, 2026
Merged

Strip trailing asterisks before */ in Javadoc comments #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/JavadocLexer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,11 @@ private static String stripJavadocBeginAndEnd(String input) {
*/
checkArgument(input.startsWith("/**"), "Missing /**: %s", input);
checkArgument(input.endsWith("*/") && input.length() > 4, "Missing */: %s", input);
return input.substring("/**".length(), input.length() - "*/".length());
int end = input.length() - "*/".length();
while (end > "/**".length() && input.charAt(end - 1) == '*') {
end--;
}
return input.substring("/**".length(), end);
}

private final CharStream input;
Expand Down
29 changes: 29 additions & 0 deletions open-java-format/src/test/java/com/palantir/javaformat/java/JavadocFormattingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,6 +570,35 @@ void significantAsterisks() {
doFormatTest(input, expected);
}

@Test
void trailingAsterisksBeforeClose() {
String[] input = {
"/** Version information for all the QuotaKeys that we have data for **/", //
"class Test {}",
};
String[] expected = {
"/** Version information for all the QuotaKeys that we have data for */", //
"class Test {}",
};
doFormatTest(input, expected);
}

@Test
void trailingAsterisksOnTheirOwnLine() {
String[] input = {
"/**", //
" * Summary line",
" * continues here.",
" ***/",
"class Test {}",
};
String[] expected = {
"/** Summary line continues here. */", //
"class Test {}",
};
doFormatTest(input, expected);
}

@Test
void links() {
String[] input = {
Expand Down
Loading