com.github.chhorz.javadoc.replacements

Class InlineTagReplacement

java.lang.Object

com.github.chhorz.javadoc.replacements.InlineTagReplacement

All Implemented Interfaces:

Replacement

public class InlineTagReplacement
extends Object
implements Replacement

Constructor Summary

Constructors

Constructor and Description
InlineTagReplacement(InlineTag inlineTag)
InlineTagReplacement(InlineTag inlineTag, String wrapperString)
InlineTagReplacement(InlineTag inlineTag, String prefix, String suffix)

Method Summary

Modifier and Type	Method and Description
String	perform(String input) Action that performs a replacement on a javadoc string.

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineTagReplacement

public InlineTagReplacement(InlineTag inlineTag)

InlineTagReplacement

public InlineTagReplacement(InlineTag inlineTag,
                            String wrapperString)

InlineTagReplacement

public InlineTagReplacement(InlineTag inlineTag,
                            String prefix,
                            String suffix)

Method Detail

perform

public String perform(String input)

Description copied from interface: Replacement

Action that performs a replacement on a javadoc string.

Specified by:

perform in interface Replacement

Parameters:

input - the javadoc input string

Returns:

the javadoc string after the replacement