com.github.antlrjavaparser.api.visitor

Class CommentFormatter

java.lang.Object

com.github.antlrjavaparser.api.visitor.CommentFormatter

public class CommentFormatter
extends Object

Author:

Mike De Haan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommentFormatter.CommentLocation

Constructor Summary

Constructors

Constructor and Description
CommentFormatter()

Method Summary

Methods

Modifier and Type	Method and Description
String	format(Comment comment, int indentLevel, CommentFormatter.CommentLocation commentLocation) Format a given comment with the indent level specified.
String	format(String comment, int indentLevel, CommentFormatter.CommentLocation commentLocation) Format a given comment string with the indent level specified.
String	formatStringAsJavadoc(String input) Formats a plain string (including newlines) and formats it as Javadoc.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentFormatter

public CommentFormatter()

Method Detail

format

public String format(Comment comment,
            int indentLevel,
            CommentFormatter.CommentLocation commentLocation)

Format a given comment with the indent level specified.

Parameters:

comment -

indentLevel -

Returns:

format

public String format(String comment,
            int indentLevel,
            CommentFormatter.CommentLocation commentLocation)

Format a given comment string with the indent level specified.

Parameters:

comment -

indentLevel -

Returns:

formatStringAsJavadoc

public String formatStringAsJavadoc(String input)

Formats a plain string (including newlines) and formats it as Javadoc.

Parameters:

input - Plain string (including newlines) to be formatted as Javadoc

Returns:

Formatted Javadoc