Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets

Class DocRootTaglet

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseInlineTaglet

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.DocRootTaglet

All Implemented Interfaces:

Taglet

@Deprecated
public class DocRootTaglet
extends BaseInlineTaglet

Deprecated.

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

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:

1.4

Field Summary

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet

name

Constructor Summary

Constructors

Constructor	Description
DocRootTaglet()	Deprecated. Construct a new DocRootTaglet.

Method Summary

Modifier and Type	Method	Description
Content	getTagletOutput(Tag tag, TagletWriter writer)	Deprecated. Given a Doc object, check if it holds any tags of this type.

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseInlineTaglet

isInlineTag

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet

getName, getTagletOutput, inConstructor, inField, inMethod, inOverview, inPackage, inType

Methods inherited from class java.lang.Object

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

Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.Taglet

toString

Constructor Details

DocRootTaglet

public DocRootTaglet()

Deprecated.

Construct a new DocRootTaglet.

Method Details

getTagletOutput

public Content getTagletOutput(Tag tag,
 TagletWriter writer)

Deprecated.

Given a Doc object, check if it holds any tags of this type. If it does, return the string representing the output. If it does not, return null.

Specified by:

getTagletOutput in interface Taglet

Overrides:

getTagletOutput in class BaseTaglet

Parameters:

tag - a tag representing the custom tag.

writer - a TagletWriter Taglet writer.

Returns:

the string representation of this Tag.