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 bothJavadocBlockTagToHtmlConverter
andJavadocInlineTagToHtmlConverter
.
-
-
Constructor Summary
Constructors Constructor Description JavadocTagToHtmlConverter()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract String
convert(String text, ConverterContext context)
protected static String
escapeXmlElement(String text)
Mostly a copy oforg.codehaus.plexus.util.xml.PrettyPrintXMLWriter#escapeXml(String)
.
-
-
-
Constructor Detail
-
JavadocTagToHtmlConverter
public JavadocTagToHtmlConverter()
-
-
Method Detail
-
convert
public abstract String convert(String text, ConverterContext context)
- Parameters:
text
- the value of the tagcontext
- 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 oforg.codehaus.plexus.util.xml.PrettyPrintXMLWriter#escapeXml(String)
.
-
-