org.apache.maven.tools.plugin.javadoc

Class AbstractMojoFieldTaglet

java.lang.Object

org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet

org.apache.maven.tools.plugin.javadoc.AbstractMojoFieldTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

Direct Known Subclasses:

MojoComponentFieldTaglet, MojoParameterFieldTaglet, MojoReadOnlyFieldTaglet, MojoRequiredFieldTaglet

public abstract class AbstractMojoFieldTaglet
extends AbstractMojoTaglet

Abstract Taglet for annotations specified at the Mojo parameter level.

Version:

$Id$

Author:

Vincent Siveton

Constructor Summary

Constructors

Constructor and Description
AbstractMojoFieldTaglet()

Method Summary

Modifier and Type	Method and Description
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()

Methods inherited from class org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet

getAllowedParameterNames, getAllowedValue, getHeader, hasAnnotationParameters, hasAnnotationValue, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.tools.doclets.Taglet

getName

Constructor Detail

AbstractMojoFieldTaglet

public AbstractMojoFieldTaglet()

Method Detail

inConstructor

public final boolean inConstructor()

Returns:

false since this annotation can NOT be used in constructor documentation.

See Also:

Taglet.inConstructor()

inField

public final boolean inField()

Returns:

true since this annotation can NOT be used in field documentation.

See Also:

Taglet.inField()

inMethod

public final boolean inMethod()

Returns:

false since this annotation can NOT be used in method documentation.

See Also:

Taglet.inMethod()

inOverview

public final boolean inOverview()

Returns:

false since this annotation can NOT be used in overview documentation.

See Also:

Taglet.inOverview()

inPackage

public final boolean inPackage()

Returns:

false since this annotation can NOT be used in package documentation.

See Also:

Taglet.inPackage()

inType

public final boolean inType()

Returns:

false since this annotation can be used in type documentation.

See Also:

Taglet.inType()

isInlineTag

public final boolean isInlineTag()

Returns:

false since this annotation can NOT be used in inline tag.

See Also:

Taglet.isInlineTag()