Repository navigation
Commit 0030c96
committed
Drop the <p> tags that end a Javadoc comment
A <p> with nothing after it was written on a line of its own after a
blank one, so a comment whose last line was a bare <p> kept it, and
one that would otherwise fit on a line stayed on several. The lexer
now removes the <p> tags at the end of the comment, with the
whitespace and </p> tags among them, before the writer sees them.
google-java-format#1526 proposes the same pass upstream, still
unreviewed. This one differs in three ways:
- Every trailing <p> goes, not only the last: with two, removing one
left the other for the next run, so formatting was not idempotent.
- A </p> among them is skipped, so a closing "<p></p>" goes too.
- A <p> with attributes stays: its id may be the target of a link.
The tests were written first: removeTrailingParagraphTag and
removeEveryTrailingParagraphTag failed before the change. Of the
129,775 Javadoc comments in the 15,747 JDK 21 sources, 9 change, each
losing a trailing <p>; the comments that a second run changes are the
same 28 as before, at 120 columns.
Closes #2371 parent 9b11043 commit 0030c96
2 files changed
Lines changed: 98 additions & 1 deletion
File tree
- open-java-format/src
- main/java/com/palantir/javaformat/java/javadoc
- test/java/com/palantir/javaformat/java
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
173 | 173 | | |
174 | 174 | | |
175 | 175 | | |
176 | | - | |
| 176 | + | |
| 177 | + | |
177 | 178 | | |
178 | 179 | | |
179 | 180 | | |
| |||
574 | 575 | | |
575 | 576 | | |
576 | 577 | | |
| 578 | + | |
| 579 | + | |
| 580 | + | |
| 581 | + | |
| 582 | + | |
| 583 | + | |
| 584 | + | |
| 585 | + | |
| 586 | + | |
| 587 | + | |
| 588 | + | |
| 589 | + | |
| 590 | + | |
| 591 | + | |
| 592 | + | |
| 593 | + | |
| 594 | + | |
| 595 | + | |
| 596 | + | |
| 597 | + | |
| 598 | + | |
| 599 | + | |
| 600 | + | |
| 601 | + | |
| 602 | + | |
| 603 | + | |
| 604 | + | |
| 605 | + | |
| 606 | + | |
577 | 607 | | |
578 | 608 | | |
579 | 609 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1028 | 1028 | | |
1029 | 1029 | | |
1030 | 1030 | | |
| 1031 | + | |
| 1032 | + | |
| 1033 | + | |
| 1034 | + | |
| 1035 | + | |
| 1036 | + | |
| 1037 | + | |
| 1038 | + | |
| 1039 | + | |
| 1040 | + | |
| 1041 | + | |
| 1042 | + | |
| 1043 | + | |
| 1044 | + | |
| 1045 | + | |
| 1046 | + | |
| 1047 | + | |
| 1048 | + | |
| 1049 | + | |
| 1050 | + | |
| 1051 | + | |
| 1052 | + | |
| 1053 | + | |
| 1054 | + | |
| 1055 | + | |
| 1056 | + | |
| 1057 | + | |
| 1058 | + | |
| 1059 | + | |
| 1060 | + | |
| 1061 | + | |
| 1062 | + | |
| 1063 | + | |
| 1064 | + | |
| 1065 | + | |
| 1066 | + | |
| 1067 | + | |
| 1068 | + | |
| 1069 | + | |
| 1070 | + | |
| 1071 | + | |
| 1072 | + | |
| 1073 | + | |
| 1074 | + | |
| 1075 | + | |
| 1076 | + | |
| 1077 | + | |
| 1078 | + | |
| 1079 | + | |
| 1080 | + | |
| 1081 | + | |
| 1082 | + | |
| 1083 | + | |
| 1084 | + | |
| 1085 | + | |
| 1086 | + | |
| 1087 | + | |
| 1088 | + | |
| 1089 | + | |
| 1090 | + | |
| 1091 | + | |
| 1092 | + | |
| 1093 | + | |
| 1094 | + | |
| 1095 | + | |
| 1096 | + | |
| 1097 | + | |
1031 | 1098 | | |
1032 | 1099 | | |
1033 | 1100 | | |
| |||
0 commit comments