Class 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
    • Constructor Detail

      • DocFinder

        public DocFinder()
        Deprecated.
    • 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.