org.freehep.tools.doclet.tags
Class DocRootTaglet

java.lang.Object
  org.freehep.tools.doclet.tags.AbstractInlineTaglet
      org.freehep.tools.doclet.tags.DocRootTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class DocRootTaglet

extends AbstractInlineTaglet

An inline Taglet representing {@docRoot}. This taglet is used to get the relative path to the document's root output directory.

Since:

1.4

Author:

Jamie Ho, Doug Kramer

Source Code:

DocRootTaglet.java

Field Summary

Fields inherited from class org.freehep.tools.doclet.tags.AbstractInlineTaglet

name

Constructor Summary

DocRootTaglet()
Construct a new DocRootTaglet.

Method Summary

String

toString(com.sun.javadoc.Tag tag, com.sun.javadoc.Doc doc, HtmlStandardWriter writer) Given the Tag representation of this custom tag, return its string representation.

Methods inherited from class org.freehep.tools.doclet.tags.AbstractInlineTaglet

getName, inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DocRootTaglet

public DocRootTaglet()

Construct a new DocRootTaglet.

Method Detail

toString

public String toString(com.sun.javadoc.Tag tag,
                       com.sun.javadoc.Doc doc,
                       HtmlStandardWriter writer)

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

Specified by:

toString in class AbstractInlineTaglet

Parameters:

tag - the Tag representation of this custom tag.

doc - the doc that holds this tag.

writer - the HtmlStandardWriter used to write this inline tag.