src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/InheritableTaglet.java

Thu, 02 Oct 2008 19:58:40 -0700

author
xdono
date
Thu, 02 Oct 2008 19:58:40 -0700
changeset 117
24a47c3062fe
parent 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell

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

mercurial