Copyright (C) 2002, Patrick Tullmann <taglets@tullmann.org>

org.tullmann.taglets
Class License

java.lang.Object
  |
  +--org.tullmann.taglets.License
All Implemented Interfaces:
com.sun.tools.doclets.Taglet

public class License
extends java.lang.Object
implements com.sun.tools.doclets.Taglet

A Taglet that defines the @license tag for Javadoc comments.

Defined at package and type scope (not field, method, etc).

To Do:
Issue(s):
Since:
January, 2002
Author:
Patrick Tullmann <taglets@tullmann.org>

Constructor Summary
License()
          Create a new License tag.
 
Method Summary
 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 with the given name.
 java.lang.String toString(com.sun.javadoc.Tag tag)
           
 java.lang.String toString(com.sun.javadoc.Tag[] tags)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

License

public License()
Create a new License tag.

Method Detail

register

public static void register(java.util.Map tagletMap)
Register this taglet with the given name.


getName

public java.lang.String getName()
Specified by:
getName in interface com.sun.tools.doclets.Taglet

isInlineTag

public boolean isInlineTag()
Specified by:
isInlineTag in interface com.sun.tools.doclets.Taglet

inField

public boolean inField()
Specified by:
inField in interface com.sun.tools.doclets.Taglet

inConstructor

public boolean inConstructor()
Specified by:
inConstructor in interface com.sun.tools.doclets.Taglet

inMethod

public boolean inMethod()
Specified by:
inMethod in interface com.sun.tools.doclets.Taglet

inType

public boolean inType()
Specified by:
inType in interface com.sun.tools.doclets.Taglet

inPackage

public boolean inPackage()
Specified by:
inPackage in interface com.sun.tools.doclets.Taglet

inOverview

public boolean inOverview()
Specified by:
inOverview in interface com.sun.tools.doclets.Taglet

toString

public java.lang.String toString(com.sun.javadoc.Tag tag)
Specified by:
toString in interface com.sun.tools.doclets.Taglet

toString

public java.lang.String toString(com.sun.javadoc.Tag[] tags)
Specified by:
toString in interface com.sun.tools.doclets.Taglet

See http://www.tullmann.org/pat/taglets/ for the latest and greatest version.