Class Option

java.lang.Object
  Option

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class Option
extends Object
implements com.sun.tools.doclets.Taglet

Author:

Matthew Pocock

Constructor Summary

Option(String name, String headline)

Method Summary

String	getHeadline()
String	getName()
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
static void	register(Map tagletMap)
String	toString(Tag tag)
String	toString(Tag[] tags)

Methods inherited from class java.lang.Object

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

Constructor Detail

Option

public Option(String name,
              String headline)

Method Detail

register

public static void register(Map tagletMap)

inConstructor

public boolean inConstructor()

Specified by:

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

inField

public boolean inField()

Specified by:

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

inMethod

public boolean inMethod()

Specified by:

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

inOverview

public boolean inOverview()

Specified by:

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

inPackage

public boolean inPackage()

Specified by:

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

inType

public boolean inType()

Specified by:

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

isInlineTag

public boolean isInlineTag()

Specified by:

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

getName

public String getName()

Specified by:

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

getHeadline

public String getHeadline()

toString

public String toString(Tag tag)

Specified by:

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

toString

public String toString(Tag[] tags)

Specified by:

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