public class MojoParameterFieldTaglet extends AbstractMojoFieldTaglet
public class MyMojo extends AbstractMojo { /** * Dummy parameter. * * @parameter <name="..."> <alias="..."> <default-value="..."> <expression="..."> * <implementation="..."> <property="..."> * ... */ private Object parameterName; }To use it, calling the
Javadoc
tool with the following:
javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet'
Modifier and Type | Field and Description |
---|---|
protected static String |
HEADER
The Javadoc text which will be added to the generated page.
|
Constructor and Description |
---|
MojoParameterFieldTaglet() |
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 MojoParameterFieldTaglet()
public String getHeader()
getHeader
in class AbstractMojoTaglet
AbstractMojoTaglet.getHeader()
,
HEADER
public String getAllowedValue()
getAllowedValue
in class AbstractMojoTaglet
null
since @parameter
has no value.AbstractMojoTaglet.getAllowedValue()
public String[] getAllowedParameterNames()
getAllowedParameterNames
in class AbstractMojoTaglet
MojoParameterFieldTaglet#PARAMETERS_NAME
since @parameter
has parameters.AbstractMojoTaglet.getAllowedParameterNames()
public String getName()
Taglet.getName()
,
NAME
Copyright © 2004–2015 The Apache Software Foundation. All rights reserved.