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

Class JavadocInlineTagsToXhtmlConverter

java.lang.Object

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

@Named
@Singleton
public class JavadocInlineTagsToXhtmlConverter
extends java.lang.Object

Replaces inline javadoc taglets by their according XHTML representation.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,JavadocInlineTagToHtmlConverter>	converters
private static int	GROUP_REFERENCE
private static int	GROUP_TAG_NAME
private static java.util.regex.Pattern	INLINE_TAG_PATTERN
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
JavadocInlineTagsToXhtmlConverter(java.util.Map<java.lang.String,JavadocInlineTagToHtmlConverter> converters)

Method Summary

Modifier and Type	Method	Description
java.lang.String	convert(java.lang.String text, ConverterContext context)	Converts the given text containing arbitrarily many inline javadoc tags with their according HTML replacement.
(package private) static java.lang.String	toXHTML(java.lang.String bodySnippet)

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

converters

private final java.util.Map<java.lang.String,JavadocInlineTagToHtmlConverter> converters

INLINE_TAG_PATTERN

private static final java.util.regex.Pattern INLINE_TAG_PATTERN

GROUP_TAG_NAME

private static final int GROUP_TAG_NAME

See Also:

Constant Field Values

GROUP_REFERENCE

private static final int GROUP_REFERENCE

See Also:

Constant Field Values

Constructor Detail

JavadocInlineTagsToXhtmlConverter

@Inject
public JavadocInlineTagsToXhtmlConverter(java.util.Map<java.lang.String,JavadocInlineTagToHtmlConverter> converters)

Method Detail

convert

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

Converts the given text containing arbitrarily many inline javadoc tags with their according HTML replacement.

Parameters:

text -

context -

Returns:

toXHTML

static java.lang.String toXHTML(java.lang.String bodySnippet)