duke@1: /*
duke@1:  * Copyright 2003 Sun Microsystems, Inc.  All Rights Reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1: 
duke@1: import com.sun.tools.doclets.internal.toolkit.util.DocFinder;
duke@1: 
duke@1: /**
duke@1:  * A taglet should implement this interface if it supports the inheritDoc
duke@1:  * tag or is automatically inherited if it is missing.
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  * @since 1.5
duke@1:  */
duke@1: public interface InheritableTaglet extends Taglet {
duke@1: 
duke@1:     /**
duke@1:      * Given an {@link com.sun.tools.doclets.internal.toolkit.util.DocFinder.Output}
duke@1:      * object, set its values with the appropriate information to inherit
duke@1:      * documentation.
duke@1:      *
duke@1:      * @param input  the input for documentation search.
duke@1:      * @param output the output for documentation search.
duke@1:      */
duke@1:     void inherit(DocFinder.Input input, DocFinder.Output output);
duke@1: }