com.github.therapi.runtimejavadoc

Class CommentFormatter

java.lang.Object

com.github.therapi.runtimejavadoc.CommentFormatter

public class CommentFormatter
extends java.lang.Object

Performs basic conversion of a Comment into a String.

Reusable and thread-safe.

Constructor Summary

Constructors

Constructor and Description
CommentFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(Comment comment) Render the comment as an HTML String.

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 java.lang.String format(Comment comment)

Render the comment as an HTML String.

Parameters:

comment - the comment to render (may be null in which case an empty string is returned)

Returns:

the HTML String representation of the comment