org.odftoolkit.odfdom.taglet
Class OdfElementTaglet

java.lang.Object
  org.odftoolkit.odfdom.taglet.OdfElementTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

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

This class implements a custom taglet to the map the ODF element to the declaration of the ODF element in the OpenDocument specification. The position of the OpenDocument specification in HTML can be provided using an environment variable or java system property, while the system property overrides the environment variable. In case nothing is been a default path within the JavaDoc doc-files directory is being used. For example the taglet {@odf.element text:span} would be resolved without variable settings to JAVA_DOC_BASE/doc-files/OpenDocument-v1.2-part1.html#element-text_span .

Constructor Summary

OdfElementTaglet()

Method Summary

String	getName() Return the name of this custom tag.
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag() Will return true since this is an inline tag.
static void	register(Map<String,com.sun.tools.doclets.Taglet> tagletMap) Register this Taglet.
String	toString(com.sun.javadoc.Tag tag) Given the Tag representation of this custom tag, return its string representation.
String	toString(com.sun.javadoc.Tag[] tags) This method should not be called since arrays of inline tags do not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

OdfElementTaglet

public OdfElementTaglet()

Method Detail

getName

public String getName()

Return the name of this custom tag.

Specified by:

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

inField

public boolean inField()

Specified by:

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

Returns:

true since this tag can be used in a field doc comment

inConstructor

public boolean inConstructor()

Specified by:

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

Returns:

true since this tag can be used in a constructor doc comment

inMethod

public boolean inMethod()

Specified by:

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

Returns:

true since this tag can be used in a method doc comment

inOverview

public boolean inOverview()

Specified by:

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

Returns:

true since this tag can be used in an overview doc comment

inPackage

public boolean inPackage()

Specified by:

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

Returns:

true since this tag can be used in a package doc comment

inType

public boolean inType()

Specified by:

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

Returns:

true since this

isInlineTag

public boolean isInlineTag()

Will return true since this is an inline tag.

Specified by:

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

Returns:

true since this is an inline tag.

register

public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)

Register this Taglet.

Parameters:

tagletMap - the map to register this tag to.

toString

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

Given the Tag representation of this custom tag, return its string representation.

Specified by:

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

Parameters:

tag - he Tag representation of this custom tag.

toString

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

This method should not be called since arrays of inline tags do not exist. Method should be used to convert this inline tag to a string.

Specified by:

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

Parameters:

tags - the array of Tags representing of this custom tag.