Skip to content

Commit 57967f7

Browse files
cushongoogle-java-format Team
authored andcommitted
Migrate from traditional Javadoc /** ... */ to Markdown Javadoc /// ...
PiperOrigin-RevId: 999216394
1 parent 332bbc2 commit 57967f7

70 files changed

Lines changed: 1171 additions & 1628 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎core/src/main/java/com/google/googlejavaformat/CloseOp.java‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,15 @@
1616

1717
import com.google.common.base.MoreObjects;
1818

19-
/**
20-
* A {@code CloseOp} closes a level. It is an {@link Op} in the sequence of {@link Op}s generated by
21-
* {@link OpsBuilder}. When the sequence is turned into a {@link Doc} by {@link DocBuilder}, ranges
22-
* delimited by {@link OpenOp}-{@code CloseOp} pairs turn into nested {@link Doc.Level}s.
23-
*/
19+
/// A `CloseOp` closes a level. It is an [Op] in the sequence of [Op]s generated by [OpsBuilder].
20+
/// When the sequence is turned into a [Doc] by [DocBuilder], ranges delimited by [OpenOp]-`CloseOp`
21+
/// pairs turn into nested [Doc.Level]s.
2422
public enum CloseOp implements Op {
2523
CLOSE;
2624

27-
/**
28-
* Make a {@code CloseOp}, returning a singleton since they are all the same.
29-
*
30-
* @return the singleton {@code CloseOp}
31-
*/
25+
/// Make a `CloseOp`, returning a singleton since they are all the same.
26+
///
27+
/// @return the singleton `CloseOp`
3228
public static Op make() {
3329
return CLOSE;
3430
}

‎core/src/main/java/com/google/googlejavaformat/CommentsHelper.java‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,15 @@
1818
import java.util.Optional;
1919
import java.util.regex.Pattern;
2020

21-
/**
22-
* Rewrite comments. This interface is implemented by {@link
23-
* com.google.googlejavaformat.java.JavaCommentsHelper JavaCommentsHelper}.
24-
*/
21+
/// Rewrite comments. This interface is implemented by
22+
/// [`JavaCommentsHelper`][com.google.googlejavaformat.java.JavaCommentsHelper].
2523
public interface CommentsHelper {
26-
/**
27-
* Try to rewrite comments, returning rewritten text.
28-
*
29-
* @param tok the comment's tok
30-
* @param maxWidth the line length for the output
31-
* @param column0 the current column
32-
* @return the rewritten comment
33-
*/
24+
/// Try to rewrite comments, returning rewritten text.
25+
///
26+
/// @param tok the comment's tok
27+
/// @param maxWidth the line length for the output
28+
/// @param column0 the current column
29+
/// @return the rewritten comment
3430
String rewrite(Input.Tok tok, int maxWidth, int column0);
3531

3632
static Optional<String> reformatParameterComment(Tok tok) {

0 commit comments

Comments
 (0)