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 java.lang.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 java.util.Map<java.lang.String,JavadocBlockTagToHtmlConverter>	blockTagConverters
private JavadocInlineTagsToXhtmlConverter	inlineTagsConverter
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
JavadocBlockTagsToXhtmlConverter(JavadocInlineTagsToXhtmlConverter inlineTagsConverter, java.util.Map<java.lang.String,JavadocBlockTagToHtmlConverter> blockTagConverters)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

inlineTagsConverter

private final JavadocInlineTagsToXhtmlConverter inlineTagsConverter

blockTagConverters

private final java.util.Map<java.lang.String,JavadocBlockTagToHtmlConverter> blockTagConverters

Constructor Detail

JavadocBlockTagsToXhtmlConverter

@Inject
public JavadocBlockTagsToXhtmlConverter(JavadocInlineTagsToXhtmlConverter inlineTagsConverter,
                                        java.util.Map<java.lang.String,JavadocBlockTagToHtmlConverter> blockTagConverters)

Method Detail

convert

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

convert

public java.lang.String convert(java.lang.String name,
                                java.lang.String text,
                                ConverterContext context)

getOriginalTag

private static java.lang.String getOriginalTag(java.lang.String name,
                                               java.lang.String text)