程序包 com.palantir.javaformat.java.javadoc

类 JavadocFormatter

java.lang.Object
com.palantir.javaformat.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.

  • 构造器详细资料

    • JavadocFormatter

      public JavadocFormatter(int maxLineLength)

  • 方法详细资料

    • formatJavadoc

      public String formatJavadoc(String input, int blockIndent)
      Formats the given Javadoc comment, which must start with ∕✱✱ and end with ✱∕. The output will start and end with the same characters.