org.codehaus.plexus.javadoc
Class PlexusComponentTaglet

java.lang.Object
  extended by org.codehaus.plexus.javadoc.AbstractPlexusTaglet
      extended by org.codehaus.plexus.javadoc.PlexusComponentTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet

public class PlexusComponentTaglet
extends AbstractPlexusTaglet

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

Version:
$Id: PlexusComponentTaglet.java 7277 2008-04-11 18:12:21Z bentmann $
Author:
Vincent Siveton
See Also:
http://plexus.codehaus.org/guides/developer-guide/appendices/javadoc-tags-reference.html

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

PlexusComponentTaglet

public PlexusComponentTaglet()
Method Detail

getHeader

public java.lang.String getHeader()

Specified by:
getHeader in class AbstractPlexusTaglet
Returns:
the header to display

getName

public java.lang.String getName()


inConstructor

public boolean inConstructor()


inField

public boolean inField()


inMethod

public boolean inMethod()


inOverview

public boolean inOverview()


inPackage

public boolean inPackage()


inType

public boolean inType()


isInlineTag

public boolean isInlineTag()


register

public static void register(java.util.Map tagletMap)
Register this Taglet.

Parameters:
tagletMap - the map to register this tag to.


Copyright © 2007-2010. All Rights Reserved.