org.apache.maven.tools.plugin.javadoc
Class MojoRequiresDependencyCollectionTypeTaglet
java.lang.Object
org.apache.maven.tools.plugin.javadoc.AbstractMojoTaglet
org.apache.maven.tools.plugin.javadoc.AbstractMojoTypeTaglet
org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet
- All Implemented Interfaces:
- com.sun.tools.doclets.Taglet
public class MojoRequiresDependencyCollectionTypeTaglet
- extends AbstractMojoTypeTaglet
The @requiresDependencyCollection tag is used to specify the required dependencies in the specified scope
and has parameter.
The following is a sample declaration:
/**
* Dummy Mojo.
*
* @requiresDependencyCollection <requiredScope>
* ...
*/
public class MyMojo extends AbstractMojo{}
To use it, calling the Javadoc
tool with the following:
javadoc ... -taglet 'org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyCollectionTypeTaglet'
Note: This taglet is similar to call the Javadoc
tool with the following:
javadoc ... -tag 'requiresDependencyCollection:t:Requires the collection of the dependencies in this specified scope:'
- Version:
- $Id$
- Author:
- Kristian Rosenvold
- 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
MojoRequiresDependencyCollectionTypeTaglet
public MojoRequiresDependencyCollectionTypeTaglet()
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 @requiresDependencyCollection
has value.- See Also:
AbstractMojoTaglet.getAllowedValue()
getAllowedParameterNames
public String[] getAllowedParameterNames()
- Specified by:
getAllowedParameterNames
in class AbstractMojoTaglet
- Returns:
null
since @requiresDependencyCollection
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 © 2004-2012 The Apache Software Foundation. All Rights Reserved.