Package org.apache.maven.tools.plugin.extractor.annotations.converter.tag

Class JavadocTagToHtmlConverter

java.lang.Object

org.apache.maven.tools.plugin.extractor.annotations.converter.tag.JavadocTagToHtmlConverter

Direct Known Subclasses:

JavadocBlockTagToHtmlConverter, JavadocInlineTagToHtmlConverter

public abstract class JavadocTagToHtmlConverter
extends Object

Common base class of both JavadocBlockTagToHtmlConverter and JavadocInlineTagToHtmlConverter.

Constructor Summary

Constructors

Constructor	Description
JavadocTagToHtmlConverter()

Method Summary

Modifier and Type	Method	Description
abstract String	convert(String text, ConverterContext context)
protected static String	escapeXmlElement(String text)	Mostly a copy of org.codehaus.plexus.util.xml.PrettyPrintXMLWriter#escapeXml(String).

Methods inherited from class java.lang.Object

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

Constructor Details

JavadocTagToHtmlConverter

public JavadocTagToHtmlConverter()

Method Details

convert

public abstract String convert(String text,
 ConverterContext context)

Parameters:

text - the value of the tag

context - the content of the tag (may be empty in case there was no content given)

Returns:

the converted text which represents the tag with the given value in html

escapeXmlElement

protected static String escapeXmlElement(String text)

Mostly a copy of org.codehaus.plexus.util.xml.PrettyPrintXMLWriter#escapeXml(String).