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

Sat, 08 Sep 2012 22:43:38 -0700

author
bpatel
date
Sat, 08 Sep 2012 22:43:38 -0700
changeset 1324
fa85af323d97
parent 554
9d9f26857129
child 1359
25e14ad23cef
permissions
-rw-r--r--

7180906: Javadoc tool does not apply parameter -nosince
Reviewed-by: jjg

     1 /*
     2  * Copyright (c) 2003, Oracle and/or its affiliates. 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.  Oracle designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  * or visit www.oracle.com if you need additional information or have any
    23  * questions.
    24  */
    26 package com.sun.tools.doclets.internal.toolkit.taglets;
    28 /**
    29  * The interface for taglet output.  This interface is needed because
    30  * different doclets work with different formats of output.  A single taglet can
    31  * work with any doclet that provides an implementation of taglet output.
    32  *
    33  * @author Jamie Ho
    34  * @since 1.5
    35  */
    36 public interface TagletOutput {
    38     /**
    39      * Set the output for the taglet.
    40      * @param o an object representing the output.
    41      */
    42     public abstract void setOutput(Object o);
    44     /**
    45      * Append the given output to this output.
    46      * @param o a TagletOutput representing the output.
    47      */
    48     public abstract void appendOutput(TagletOutput o);
    50     /**
    51      * Return true if this output has any occurances of @inheritDoc.
    52      * @return true if inheritDoc tag is found.
    53      */
    54     public abstract boolean hasInheritDocTag();
    55 }

mercurial