Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java@9d9f26857129 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java
Tue, 25 May 2010 15:54:51 -0700
- author
- ohair
- date
- Tue, 25 May 2010 15:54:51 -0700
- changeset 554
- 9d9f26857129
- parent 1
- 9a66ca7c79fa
- child 766
- 90af8d87741f
- permissions
- -rw-r--r--
6943119: Rebrand source copyright notices
Reviewed-by: darcy
| 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; |
| duke@1 | 27 | |
| duke@1 | 28 | import java.io.*; |
| duke@1 | 29 | import com.sun.javadoc.*; |
| duke@1 | 30 | |
| duke@1 | 31 | /** |
| duke@1 | 32 | * The interface for writing annotation type required member output. |
| duke@1 | 33 | * |
| duke@1 | 34 | * This code is not part of an API. |
| duke@1 | 35 | * It is implementation that is subject to change. |
| duke@1 | 36 | * Do not use it as an API |
| duke@1 | 37 | * |
| duke@1 | 38 | * @author Jamie Ho |
| duke@1 | 39 | * @since 1.5 |
| duke@1 | 40 | */ |
| duke@1 | 41 | |
| duke@1 | 42 | public interface AnnotationTypeRequiredMemberWriter { |
| duke@1 | 43 | |
| duke@1 | 44 | /** |
| duke@1 | 45 | * Write the header for the member documentation. |
| duke@1 | 46 | * |
| duke@1 | 47 | * @param classDoc the annotation type that the members belong to. |
| duke@1 | 48 | * @param header the header to write. |
| duke@1 | 49 | */ |
| duke@1 | 50 | public void writeHeader(ClassDoc classDoc, String header); |
| duke@1 | 51 | |
| duke@1 | 52 | /** |
| duke@1 | 53 | * Write the member header for the given member. |
| duke@1 | 54 | * |
| duke@1 | 55 | * @param member the member being documented. |
| duke@1 | 56 | * @param isFirst the flag to indicate whether or not the member is |
| duke@1 | 57 | * the first to be documented. |
| duke@1 | 58 | */ |
| duke@1 | 59 | public void writeMemberHeader(MemberDoc member, boolean isFirst); |
| duke@1 | 60 | |
| duke@1 | 61 | /** |
| duke@1 | 62 | * Write the signature for the given member. |
| duke@1 | 63 | * |
| duke@1 | 64 | * @param member the member being documented. |
| duke@1 | 65 | */ |
| duke@1 | 66 | public void writeSignature(MemberDoc member); |
| duke@1 | 67 | |
| duke@1 | 68 | /** |
| duke@1 | 69 | * Write the deprecated output for the given member. |
| duke@1 | 70 | * |
| duke@1 | 71 | * @param member the member being documented. |
| duke@1 | 72 | */ |
| duke@1 | 73 | public void writeDeprecated(MemberDoc member); |
| duke@1 | 74 | |
| duke@1 | 75 | /** |
| duke@1 | 76 | * Write the comments for the given member. |
| duke@1 | 77 | * |
| duke@1 | 78 | * @param member the member being documented. |
| duke@1 | 79 | */ |
| duke@1 | 80 | public void writeComments(MemberDoc member); |
| duke@1 | 81 | |
| duke@1 | 82 | /** |
| duke@1 | 83 | * Write the tag output for the given member. |
| duke@1 | 84 | * |
| duke@1 | 85 | * @param member the member being documented. |
| duke@1 | 86 | */ |
| duke@1 | 87 | public void writeTags(MemberDoc member); |
| duke@1 | 88 | |
| duke@1 | 89 | /** |
| duke@1 | 90 | * Write the member footer. |
| duke@1 | 91 | */ |
| duke@1 | 92 | public void writeMemberFooter(); |
| duke@1 | 93 | |
| duke@1 | 94 | /** |
| duke@1 | 95 | * Write the footer for the member documentation. |
| duke@1 | 96 | * |
| duke@1 | 97 | * @param classDoc the class that the member belong to. |
| duke@1 | 98 | */ |
| duke@1 | 99 | public void writeFooter(ClassDoc classDoc); |
| duke@1 | 100 | |
| duke@1 | 101 | /** |
| duke@1 | 102 | * Close the writer. |
| duke@1 | 103 | */ |
| duke@1 | 104 | public void close() throws IOException; |
| duke@1 | 105 | } |
