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

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

public class DocFinder
extends java.lang.Object

Search for the requested documentation. Inherit documentation if necessary.

Since:

1.5

Nested Class Summary

static class	DocFinder.Input The class that encapsulates the input.
static class	DocFinder.Output The class that encapsulates the output.

Constructor Summary

DocFinder()

Method Summary

static DocFinder.Output

search(DocFinder.Input input) Search for the requested comments in the given method.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocFinder

public DocFinder()

Method Detail

search

public static DocFinder.Output search(DocFinder.Input input)

Search for the requested comments in the given method. If it does not have comments, return documentation from the overriden method if possible. If the overriden method does not exist or does not have documentation to inherit, search for documentation to inherit from implemented methods.

Parameters:

input - the input object used to perform the search.

Returns:

an Output object representing the documentation that was found.