public class MojoRequiresDependencyResolutionTypeTaglet extends AbstractMojoTypeTaglet
/** * Dummy Mojo. * * @requiresDependencyResolution <requiredScope> * ... */ public class MyMojo extends AbstractMojo{}To use it, calling the
Javadoc
tool with the following:
javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet'Note: This taglet is similar to call the
Javadoc
tool with the following:
javadoc ... -tag 'requiresDependencyResolution:t:Requires the dependencies in this specified scope:'
Modifier and Type | Field and Description |
---|---|
protected static String |
HEADER
The Javadoc text which will be added to the generated page.
|
Constructor and Description |
---|
MojoRequiresDependencyResolutionTypeTaglet() |
Modifier and Type | Method and Description |
---|---|
String[] |
getAllowedParameterNames() |
String |
getAllowedValue() |
String |
getHeader() |
String |
getName() |
static void |
register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
Register this Taglet.
|
inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag
hasAnnotationParameters, hasAnnotationValue, toString, toString
protected static final String HEADER
public MojoRequiresDependencyResolutionTypeTaglet()
public String getHeader()
getHeader
in class AbstractMojoTaglet
AbstractMojoTaglet.getHeader()
,
HEADER
public String getAllowedValue()
getAllowedValue
in class AbstractMojoTaglet
"*"
since @requiresDependencyResolution
has value.AbstractMojoTaglet.getAllowedValue()
public String[] getAllowedParameterNames()
getAllowedParameterNames
in class AbstractMojoTaglet
null
since @requiresDependencyResolution
has no parameter.AbstractMojoTaglet.getAllowedParameterNames()
public String getName()
Taglet.getName()
,
NAME
Copyright © 2008–2014 The Apache Software Foundation. All rights reserved.