org.apache.maven.tools.plugin.javadoc
Class MojoConfiguratorTypeTaglet
java.lang.Object
org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet
- All Implemented Interfaces:
- com.sun.tools.doclets.Taglet
public class MojoConfiguratorTypeTaglet
- extends AbstractMojoTypeTaglet
The @configurator tag is used to inject parameter values into the Mojo and has annotation parameter.
The following is a sample declaration:
/**
* Dummy Mojo.
*
* @configurator <roleHint>
* ...
*/
public class MyMojo extends AbstractMojo{}
To use it, calling the Javadoc
tool with the following:
javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet'
Note: This taglet is similar to call the Javadoc
tool with the following:
javadoc ... -tag 'configurator:t:Is configured to the role hint:'
- Version:
- $Id: MojoConfiguratorTypeTaglet.java 1133707 2011-06-09 08:28:59Z stephenc $
- Author:
- Vincent Siveton
- See Also:
- package-summary.html
Field Summary |
protected static String |
HEADER
The Javadoc text which will be added to the generated page. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
HEADER
protected static final String HEADER
- The Javadoc text which will be added to the generated page.
- See Also:
- Constant Field Values
MojoConfiguratorTypeTaglet
public MojoConfiguratorTypeTaglet()
getHeader
public String getHeader()
- Specified by:
getHeader
in class AbstractMojoTaglet
- Returns:
- By default, return the string defined in HEADER.
- See Also:
AbstractMojoTaglet.getHeader()
,
HEADER
getAllowedValue
public String getAllowedValue()
- Specified by:
getAllowedValue
in class AbstractMojoTaglet
- Returns:
"*"
since @configurator
has a value.- See Also:
AbstractMojoTaglet.getAllowedValue()
getAllowedParameterNames
public String[] getAllowedParameterNames()
- Specified by:
getAllowedParameterNames
in class AbstractMojoTaglet
- Returns:
null
since @configurator
has no parameter.- See Also:
AbstractMojoTaglet.getAllowedParameterNames()
getName
public String getName()
- Returns:
- By default, return the name of this taglet.
- See Also:
Taglet.getName()
,
NAME
register
public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
- Register this Taglet.
- Parameters:
tagletMap
- the map to register this tag to.
Copyright © 2008-2012 The Apache Software Foundation. All Rights Reserved.