Class DocFinder
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.DocFinder
-
@Deprecated public class DocFinder extends Object
Deprecated.Search for the requested documentation. Inherit documentation if necessary.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.5
- Author:
- Jamie Ho
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DocFinder.Input
Deprecated.The class that encapsulates the input.static class
DocFinder.Output
Deprecated.The class that encapsulates the output.
-
Constructor Summary
Constructors Constructor Description DocFinder()
Deprecated.
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static DocFinder.Output
search(Configuration configuration, DocFinder.Input input)
Deprecated.Search for the requested comments in the given element.
-
-
-
Method Detail
-
search
public static DocFinder.Output search(Configuration configuration, DocFinder.Input input)
Deprecated.Search for the requested comments in the given element. If it does not have comments, return documentation from the overriden element if possible. If the overriden element 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.
-
-