Wed, 27 Apr 2016 01:34:52 +0800
Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.tools.doclets.internal.toolkit.taglets; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import com.sun.tools.doclets.internal.toolkit.util.DocFinder; |
aoqi@0 | 29 | |
aoqi@0 | 30 | /** |
aoqi@0 | 31 | * A taglet should implement this interface if it supports the inheritDoc |
aoqi@0 | 32 | * tag or is automatically inherited if it is missing. |
aoqi@0 | 33 | * |
aoqi@0 | 34 | * <p><b>This is NOT part of any supported API. |
aoqi@0 | 35 | * If you write code that depends on this, you do so at your own risk. |
aoqi@0 | 36 | * This code and its internal interfaces are subject to change or |
aoqi@0 | 37 | * deletion without notice.</b> |
aoqi@0 | 38 | * |
aoqi@0 | 39 | * @author Jamie Ho |
aoqi@0 | 40 | * @since 1.5 |
aoqi@0 | 41 | */ |
aoqi@0 | 42 | public interface InheritableTaglet extends Taglet { |
aoqi@0 | 43 | |
aoqi@0 | 44 | /** |
aoqi@0 | 45 | * Given an {@link com.sun.tools.doclets.internal.toolkit.util.DocFinder.Output} |
aoqi@0 | 46 | * object, set its values with the appropriate information to inherit |
aoqi@0 | 47 | * documentation. |
aoqi@0 | 48 | * |
aoqi@0 | 49 | * @param input the input for documentation search. |
aoqi@0 | 50 | * @param output the output for documentation search. |
aoqi@0 | 51 | */ |
aoqi@0 | 52 | void inherit(DocFinder.Input input, DocFinder.Output output); |
aoqi@0 | 53 | } |