com.google.googlejavaformat.java.javadoc

Class JavadocFormatter

java.lang.Object

com.google.googlejavaformat.java.javadoc.JavadocFormatter

public final class JavadocFormatter
extends Object

Entry point for formatting Javadoc.

This stateless class reads tokens from the stateful lexer and translates them to "requests" and "writes" to the stateful writer. It also munges tokens into "standardized" forms. Finally, it performs postprocessing to convert the written Javadoc to a one-liner if possible or to leave a single blank line if it's empty.

Method Summary

Modifier and Type	Method and Description
static String	formatJavadoc(String input, int blockIndent, JavaFormatterOptions options) Formats the given Javadoc comment, which must start with ∕✱✱ and end with ✱∕.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

formatJavadoc

public static String formatJavadoc(String input,
                                   int blockIndent,
                                   JavaFormatterOptions options)

Formats the given Javadoc comment, which must start with ∕✱✱ and end with ✱∕. The output will start and end with the same characters.