Wed, 10 Oct 2012 16:48:21 -0700
8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy
duke@1 | 1 | /* |
jjg@1359 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.taglets; |
duke@1 | 27 | |
duke@1 | 28 | /** |
duke@1 | 29 | * The interface for taglet output. This interface is needed because |
duke@1 | 30 | * different doclets work with different formats of output. A single taglet can |
duke@1 | 31 | * work with any doclet that provides an implementation of taglet output. |
duke@1 | 32 | * |
jjg@1359 | 33 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 34 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 35 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 36 | * deletion without notice.</b> |
jjg@1359 | 37 | * |
duke@1 | 38 | * @author Jamie Ho |
duke@1 | 39 | * @since 1.5 |
duke@1 | 40 | */ |
duke@1 | 41 | public interface TagletOutput { |
duke@1 | 42 | |
duke@1 | 43 | /** |
duke@1 | 44 | * Set the output for the taglet. |
duke@1 | 45 | * @param o an object representing the output. |
duke@1 | 46 | */ |
duke@1 | 47 | public abstract void setOutput(Object o); |
duke@1 | 48 | |
duke@1 | 49 | /** |
duke@1 | 50 | * Append the given output to this output. |
duke@1 | 51 | * @param o a TagletOutput representing the output. |
duke@1 | 52 | */ |
duke@1 | 53 | public abstract void appendOutput(TagletOutput o); |
duke@1 | 54 | |
duke@1 | 55 | /** |
duke@1 | 56 | * Return true if this output has any occurances of @inheritDoc. |
duke@1 | 57 | * @return true if inheritDoc tag is found. |
duke@1 | 58 | */ |
duke@1 | 59 | public abstract boolean hasInheritDocTag(); |
duke@1 | 60 | } |