com.palantir.javaformat.java.javadoc

Class JavadocFormatter

java.lang.Object

com.palantir.javaformat.java.javadoc.JavadocFormatter

public final class JavadocFormatter
extends java.lang.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.

Constructor Summary

Constructors

Constructor and Description
JavadocFormatter(int maxLineLength)

Method Summary

Modifier and Type	Method and Description
java.lang.String	formatJavadoc(java.lang.String input, int blockIndent) 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

Constructor Detail

JavadocFormatter

public JavadocFormatter(int maxLineLength)

Method Detail

formatJavadoc

public java.lang.String formatJavadoc(java.lang.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.