Interface InheritableTaglet

  • All Superinterfaces:
    Taglet
    All Known Implementing Classes:
    ParamTaglet, ReturnTaglet, SeeTaglet, SimpleTaglet, ThrowsTaglet

    @Deprecated
    public interface InheritableTaglet
    extends Taglet
    Deprecated.
    A taglet should implement this interface if it supports the inheritDoc tag or is automatically inherited if it is missing.

    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
    • Method Detail

      • inherit

        void inherit​(DocFinder.Input input,
                     DocFinder.Output output)
        Deprecated.
        Given an DocFinder.Output object, set its values with the appropriate information to inherit documentation.
        Parameters:
        input - the input for documentation search.
        output - the output for documentation search.