nesstar.javadoc
Class ATaglet

java.lang.Object
  extended by nesstar.javadoc.ATaglet
Direct Known Subclasses:
BugTaglet, NoteTaglet, ToDoTaglet

public abstract class ATaglet
extends Object

Root class for taglets. This is a slightly modified version of the sample Taglet with the same name from Sun.

Author:
Jamie Ho, Titto Assini

Constructor Summary
ATaglet()
           
 
Method Summary
 boolean inConstructor()
           
 boolean inField()
           
 boolean inMethod()
           
 boolean inOverview()
           
 boolean inPackage()
           
 boolean inType()
           
 boolean isInlineTag()
           
static void register(Map tagletMap)
          Register this Taglet.
static void register(Map tagletMap, Taglet tag)
          Register a Taglet.
 String toString(Tag tag)
          Given the Tag representation of this custom tag, return its string representation.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ATaglet

public ATaglet()
Method Detail

inField

public boolean inField()
Returns:
true by default

inConstructor

public boolean inConstructor()
Returns:
true by default

inMethod

public boolean inMethod()
Returns:
true by default

inOverview

public boolean inOverview()
Returns:
true by default

inPackage

public boolean inPackage()
Returns:
true by default

inType

public boolean inType()
Returns:
true by default

isInlineTag

public boolean isInlineTag()
Returns:
true by default

register

public static void register(Map tagletMap,
                            Taglet tag)
Register a Taglet.

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

register

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

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

toString

public String toString(Tag tag)
Given the Tag representation of this custom tag, return its string representation.

Parameters:
tag - the Tag representation of this custom tag.

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved