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:
-
Support source license and doc license. |
Support preferences-based customization. |
- Issue(s):
-
- What to expand the shorthand license name to?
- Since:
- January, 2002
- Author:
- Patrick Tullmann <taglets@tullmann.org>
Constructor Summary |
License()
Create a new License tag. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
License
public License()
- Create a new License tag.
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