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

Class JavadocBlockTagsToXhtmlConverter

java.lang.Object

org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocBlockTagsToXhtmlConverter

@Named
@Singleton
public class JavadocBlockTagsToXhtmlConverter
extends Object

Converts a given javadoc block taglet to HTML. The implementations have a name equal to the supported doclet name. Must be called for each block tag individually.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,JavadocBlockTagToHtmlConverter>	blockTagConverters
private final JavadocInlineTagsToXhtmlConverter	inlineTagsConverter
private static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
JavadocBlockTagsToXhtmlConverter(JavadocInlineTagsToXhtmlConverter inlineTagsConverter, Map<String,JavadocBlockTagToHtmlConverter> blockTagConverters)

Method Summary

Modifier and Type	Method	Description
String	convert(com.thoughtworks.qdox.model.DocletTag docletTag, ConverterContext context)
String	convert(String name, String text, ConverterContext context)
private static String	getOriginalTag(String name, String text)

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

inlineTagsConverter

private final JavadocInlineTagsToXhtmlConverter inlineTagsConverter

blockTagConverters

private final Map<String,JavadocBlockTagToHtmlConverter> blockTagConverters

Constructor Details

JavadocBlockTagsToXhtmlConverter

@Inject
public JavadocBlockTagsToXhtmlConverter(JavadocInlineTagsToXhtmlConverter inlineTagsConverter,
 Map<String,JavadocBlockTagToHtmlConverter> blockTagConverters)

Method Details

convert

public String convert(com.thoughtworks.qdox.model.DocletTag docletTag,
 ConverterContext context)

convert

public String convert(String name,
 String text,
 ConverterContext context)

getOriginalTag

private static String getOriginalTag(String name,
 String text)