com.github.therapi.runtimejavadoc

Class ToHtmlStringCommentVisitor

java.lang.Object

com.github.therapi.runtimejavadoc.ToHtmlStringCommentVisitor

All Implemented Interfaces:

CommentVisitor

public class ToHtmlStringCommentVisitor
extends java.lang.Object
implements CommentVisitor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.StringBuilder	buf

Constructor Summary

Constructors

Constructor and Description
ToHtmlStringCommentVisitor()

Method Summary

Modifier and Type	Method and Description
java.lang.String	build()
void	commentText(java.lang.String value)
protected static java.lang.String	escapeHtml(java.lang.String value) Escapes the HTML special characters: " & < >
void	inlineLink(Link link)
void	inlineTag(java.lang.String name, java.lang.String value)
void	inlineValue(Value value)

Methods inherited from class java.lang.Object

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

Field Detail

buf

protected java.lang.StringBuilder buf

Constructor Detail

ToHtmlStringCommentVisitor

public ToHtmlStringCommentVisitor()

Method Detail

commentText

public void commentText(java.lang.String value)

Specified by:

commentText in interface CommentVisitor

inlineLink

public void inlineLink(Link link)

Specified by:

inlineLink in interface CommentVisitor

inlineTag

public void inlineTag(java.lang.String name,
                      java.lang.String value)

Specified by:

inlineTag in interface CommentVisitor

inlineValue

public void inlineValue(Value value)

Specified by:

inlineValue in interface CommentVisitor

build

public java.lang.String build()

escapeHtml

protected static java.lang.String escapeHtml(java.lang.String value)

Escapes the HTML special characters: " & < >

Parameters:

value - The value to escape

Returns:

the input value with any instances of HTML special characters converted to character entities.