Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derbyBuild >> [ javadoc overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.derbyBuild.javadoc
Class PurposeTaglet  

java.lang.Object
  org.apache.derbyBuild.javadoc.PurposeTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

---

public class PurposeTaglet

extends java.lang.Object

implements com.sun.tools.doclets.Taglet

---

Field Summary
private  java.lang.String	NAME
private  java.lang.String	ROWNAME

 

Constructor Summary

PurposeTaglet()

 

Method Summary
java.lang.String	getName()           Returns the name of this taglet
boolean	inConstructor()           purpose not expected to be used in constructor documentation.
boolean	inField()           purpose not expected to be used in field documentation.
boolean	inMethod()           purpose not expected to be used in method documentation.
boolean	inOverview()           purpose can be used in overview documentation.
boolean	inPackage()           purpose can be used in package documentation.
boolean	inType()           purpose can be used in type documentation.
boolean	isInlineTag()           purpose is not an inline tag.
static void	register(java.util.Map tagletMap)           Register this Taglet.
java.lang.String	toString(com.sun.javadoc.Tag tag)           Embed the contents of the purpose tag as a row in the disk format table.
java.lang.String	toString(com.sun.javadoc.Tag[] tags)           Embed multiple purpose tags as cells in the disk format table.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

NAME

private java.lang.String NAME

---

ROWNAME

private java.lang.String ROWNAME

Constructor Detail

PurposeTaglet

public PurposeTaglet()

Method Detail

getName

public java.lang.String getName()

Returns the name of this taglet

Specified by:

getName in interface com.sun.tools.doclets.Taglet

---

inField

public boolean inField()

purpose not expected to be used in field documentation.

Specified by:

inField in interface com.sun.tools.doclets.Taglet

---

inConstructor

public boolean inConstructor()

purpose not expected to be used in constructor documentation.

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

---

inMethod

public boolean inMethod()

purpose not expected to be used in method documentation.

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

---

inOverview

public boolean inOverview()

purpose can be used in overview documentation.

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

---

inPackage

public boolean inPackage()

purpose can be used in package documentation.

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

---

inType

public boolean inType()

purpose can be used in type documentation.

Specified by:

inType in interface com.sun.tools.doclets.Taglet

---

isInlineTag

public boolean isInlineTag()

purpose is not an inline tag.

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet

---

register

public static void register(java.util.Map tagletMap)

Register this Taglet.

---

toString

public java.lang.String toString(com.sun.javadoc.Tag tag)

Embed the contents of the purpose tag as a row in the disk format table.

Specified by:

toString in interface com.sun.tools.doclets.Taglet

---

toString

public java.lang.String toString(com.sun.javadoc.Tag[] tags)

Embed multiple purpose tags as cells in the disk format table.

Specified by:

toString in interface com.sun.tools.doclets.Taglet

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derbyBuild >> [ javadoc overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---