public class MojoComponentFieldTaglet extends AbstractMojoFieldTaglet
public class MyMojo extends AbstractMojo
{
/**
* Dummy parameter.
*
* @component <role="..."> <roleHint="...">
* ...
*/
private Object parameterName;
}
To use it, calling the Javadoc tool with the following:
javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet'
| Modifier and Type | Field and Description |
|---|---|
protected static String |
HEADER
The Javadoc text which will be added to the generated page.
|
| Constructor and Description |
|---|
MojoComponentFieldTaglet() |
| 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, isInlineTaghasAnnotationParameters, hasAnnotationValue, toString, toStringprotected static final String HEADER
public MojoComponentFieldTaglet()
public String getHeader()
getHeader in class AbstractMojoTagletAbstractMojoTaglet.getHeader(),
HEADERpublic String getAllowedValue()
getAllowedValue in class AbstractMojoTagletnull since @component has no value.AbstractMojoTaglet.getAllowedValue()public String[] getAllowedParameterNames()
getAllowedParameterNames in class AbstractMojoTagletMojoComponentFieldTaglet#COMPONENTS_NAME since @component has parameters.AbstractMojoTaglet.getAllowedParameterNames()public String getName()
Taglet.getName(),
NAMECopyright © 2004–2018 The Apache Software Foundation. All rights reserved.