Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletOutput.java@fa85af323d97 (annotated)
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
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 2003, 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 | * |
| duke@1 | 33 | * @author Jamie Ho |
| duke@1 | 34 | * @since 1.5 |
| duke@1 | 35 | */ |
| duke@1 | 36 | public interface TagletOutput { |
| duke@1 | 37 | |
| duke@1 | 38 | /** |
| duke@1 | 39 | * Set the output for the taglet. |
| duke@1 | 40 | * @param o an object representing the output. |
| duke@1 | 41 | */ |
| duke@1 | 42 | public abstract void setOutput(Object o); |
| duke@1 | 43 | |
| duke@1 | 44 | /** |
| duke@1 | 45 | * Append the given output to this output. |
| duke@1 | 46 | * @param o a TagletOutput representing the output. |
| duke@1 | 47 | */ |
| duke@1 | 48 | public abstract void appendOutput(TagletOutput o); |
| duke@1 | 49 | |
| duke@1 | 50 | /** |
| duke@1 | 51 | * Return true if this output has any occurances of @inheritDoc. |
| duke@1 | 52 | * @return true if inheritDoc tag is found. |
| duke@1 | 53 | */ |
| duke@1 | 54 | public abstract boolean hasInheritDocTag(); |
| duke@1 | 55 | } |
