|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.plexus.javadoc.AbstractPlexusTaglet
org.codehaus.plexus.javadoc.PlexusComponentTaglet
public class PlexusComponentTaglet
The @plexus.component tag is used to show that the class it annotates is a plexus component. This will add a <component> element to the <components> in components.xml. The following parameters are available, but remember the role is required. The text in the javadoc tag describing this class is copied into the component's <description> tag.
Parameter | Required | Description |
role | Yes | The role that this class provides an implementation for (usually the class name of an implemented Interface |
role-hint | No | The hints are used to differentiate multiple implementations of the same role |
version | No | Set the version of the component |
Constructor Summary | |
---|---|
PlexusComponentTaglet()
|
Method Summary | |
---|---|
java.lang.String |
getHeader()
|
java.lang.String |
getName()
|
boolean |
inConstructor()
|
boolean |
inField()
|
boolean |
inMethod()
|
boolean |
inOverview()
|
boolean |
inPackage()
|
boolean |
inType()
|
boolean |
isInlineTag()
|
static void |
register(java.util.Map tagletMap)
Register this Taglet. |
Methods inherited from class org.codehaus.plexus.javadoc.AbstractPlexusTaglet |
---|
toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PlexusComponentTaglet()
Method Detail |
---|
public java.lang.String getHeader()
getHeader
in class AbstractPlexusTaglet
public java.lang.String getName()
public boolean inConstructor()
public boolean inField()
public boolean inMethod()
public boolean inOverview()
public boolean inPackage()
public boolean inType()
public boolean isInlineTag()
public static void register(java.util.Map tagletMap)
tagletMap
- the map to register this tag to.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |