org.inria.ns.reflex.javadoc
Class DocumentTaglet

java.lang.Object
  extended by org.inria.ns.reflex.javadoc.ActiveTagsTaglet
      extended by org.inria.ns.reflex.javadoc.DocumentTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet

public class DocumentTaglet
extends ActiveTagsTaglet

DocumentTaglet represents {@at-document ...}. ... is the name of the Active Tags document, such as doc:anchor, followed by a space and the text of the link. The anchor may be omitted. A link to the reference of this element is displayed : "<a href="http://.../mySpec.html#anchor">text</a>"

Author:
Philippe Poulard

Constructor Summary
DocumentTaglet()
           
 
Method Summary
 String getName()
          Return the name of this taglet.
static void register(Map tagletMap)
          Register this taglet.
 
Methods inherited from class org.inria.ns.reflex.javadoc.ActiveTagsTaglet
inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, toString, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentTaglet

public DocumentTaglet()
Method Detail

register

public static void register(Map tagletMap)
Register this taglet.

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

getName

public String getName()
Return the name of this taglet.

Returns:
"at-document".
See Also:
Taglet.getName()