Tue, 28 Dec 2010 15:54:52 -0800
6962318: Update copyright year
Reviewed-by: xdono
1 /*
2 * Copyright (c) 2003, 2010, 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;
28 import java.io.*;
29 import com.sun.javadoc.*;
31 /**
32 * The interface for writing annotation type required member output.
33 *
34 * This code is not part of an API.
35 * It is implementation that is subject to change.
36 * Do not use it as an API
37 *
38 * @author Jamie Ho
39 * @author Bhavesh Patel (Modified)
40 * @since 1.5
41 */
43 public interface AnnotationTypeRequiredMemberWriter {
45 /**
46 * Add the annotation type details tree header.
47 *
48 * @param classDoc the annotation type being documented
49 * @param memberDetailsTree the content tree representing member details
50 */
51 public void addAnnotationDetailsTreeHeader(ClassDoc classDoc,
52 Content memberDetailsTree);
54 /**
55 * Get the annotation type documentation tree header.
56 *
57 * @param member the annotation type being documented
58 * @param annotationDetailsTree the content tree representing annotation type details
59 * @return content tree for the annotation type documentation header
60 */
61 public Content getAnnotationDocTreeHeader(MemberDoc member,
62 Content annotationDetailsTree);
64 /**
65 * Get the annotation type details tree.
66 *
67 * @param annotationDetailsTree the content tree representing annotation type details
68 * @return content tree for the annotation type details
69 */
70 public Content getAnnotationDetails(Content annotationDetailsTree);
72 /**
73 * Get the annotation type documentation.
74 *
75 * @param annotationDocTree the content tree representing annotation type documentation
76 * @param isLastContent true if the content to be added is the last content
77 * @return content tree for the annotation type documentation
78 */
79 public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);
81 /**
82 * Get the signature for the given member.
83 *
84 * @param member the member being documented
85 * @return content tree for the annotation type signature
86 */
87 public Content getSignature(MemberDoc member);
89 /**
90 * Add the deprecated output for the given member.
91 *
92 * @param member the member being documented
93 * @param annotationDocTree content tree to which the deprecated information will be added
94 */
95 public void addDeprecated(MemberDoc member, Content annotationDocTree);
97 /**
98 * Add the comments for the given member.
99 *
100 * @param member the member being documented
101 * @param annotationDocTree the content tree to which the comments will be added
102 */
103 public void addComments(MemberDoc member, Content annotationDocTree);
105 /**
106 * Add the tags for the given member.
107 *
108 * @param member the member being documented
109 * @param annotationDocTree the content tree to which the tags will be added
110 */
111 public void addTags(MemberDoc member, Content annotationDocTree);
113 /**
114 * Close the writer.
115 */
116 public void close() throws IOException;
117 }