net.sourceforge.taglets.simple
Interface InlineTaglet

All Superinterfaces:

SimpleTaglet

All Known Implementing Classes:

ClassNameInlineTaglet, IgnoreInlineTaglet, ParamInlineTaglet, RegexInlineTaglet, TableInlineTaglet, TextFilterInlineTaglet

public interface InlineTaglet
extends SimpleTaglet

Interface for "simple" inline taglets.

An inline taglet describes output conversion of an inline tag like {@test some text}.

Version:

1.6 (2008/03/30 12:43:13)

Maintainer:

Bruno Essmann <essmann@sourceforge.net>

Since:

1.3.0

Method Summary

String

getOutput(Logger logger, Parameter parameter, String text) Returns the output for the specified input text.

Methods inherited from interface net.sourceforge.taglets.simple.SimpleTaglet

configure, getName

Method Detail

getOutput

String getOutput(Logger logger,
                 Parameter parameter,
                 String text)

Returns the output for the specified input text.

The input text is fully resolved, i.e. if it contains further inline tags they are first resolved before being passed to this method.

Parameters:

logger - the logger to use for emiting messages.

parameter - the parameter for the tag currently processed.

text - the fully resolved tag text.

Returns:

the output text to use in the documentation.

Since:

1.3.0