com.sun.tools.doclets.internal.toolkit.util
Class DocFinder.Output

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.util.DocFinder.Output

Enclosing class:

DocFinder

public static class DocFinder.Output
extends java.lang.Object

The class that encapsulates the output.

Field Summary

Doc	holder The Doc object that holds the documentation.
Tag	holderTag The tag that holds the documentation.
Tag[]	inlineTags The inherited documentation.
boolean	isValidInheritDocTag False if documentation could not be inherited.
java.util.List<Tag>	tagList When automatically inheriting throws tags, you sometime must inherit more than one tag.

Constructor Summary

DocFinder.Output()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

holderTag

public Tag holderTag

The tag that holds the documentation. Null if documentation is not held by a tag.

holder

public Doc holder

The Doc object that holds the documentation.

inlineTags

public Tag[] inlineTags

The inherited documentation.

isValidInheritDocTag

public boolean isValidInheritDocTag

False if documentation could not be inherited.

tagList

public java.util.List<Tag> tagList

When automatically inheriting throws tags, you sometime must inherit more than one tag. For example if the method declares that it throws IOException and the overidden method has throws tags for IOException and ZipException, both tags would be inherited because ZipException is a subclass of IOException. This subclass of DocFinder.Output allows multiple tag inheritence.

Constructor Detail

DocFinder.Output

public DocFinder.Output()