org.weborganic.xmldoclet
Class CustomTag

java.lang.Object
  org.weborganic.xmldoclet.CustomTag

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public final class CustomTag
extends Object
implements com.sun.tools.doclets.Taglet

A custom tag for tags specified using the -tag option.

Constructor Summary

CustomTag(String name, boolean inline)
Creates a custom tag.

CustomTag(String name, boolean inline, String title)
Creates a custom tag.

Method Summary

String	getName()
String	getTitle()
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
void	setScope(String scope) Reuses the same scope attributes as used by the standard Javadoc doclet.
void	setTitle(String title) Sets the title to use for this tag.
String	toString(Tag tag)
String	toString(Tag[] tags)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomTag

public CustomTag(String name,
                 boolean inline)

Creates a custom tag.

Parameters:

name - the name of the tag.

inline - true for inline tags; false otherwise.

CustomTag

public CustomTag(String name,
                 boolean inline,
                 String title)

Creates a custom tag.

Parameters:

name - the name of the tag.

inline - true for inline tags; false otherwise.

title - the title of the tag

Method Detail

setScope

public void setScope(String scope)

Reuses the same scope attributes as used by the standard Javadoc doclet.

  a (all)
  o (overview)
  p (packages)
  t (types, that is classes and interfaces)
  c (constructors)
  m (methods)
  f (fields)
 

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

getName

public String getName()

Specified by:

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

setTitle

public void setTitle(String title)

Sets the title to use for this tag.

Parameters:

title - the title to use for this tag.

getTitle

public String getTitle()

Returns:

the title to use for this tag.

isInlineTag

public boolean isInlineTag()

Specified by:

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

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