author | jjg |
Fri, 27 May 2016 13:06:58 -0700 | |
changeset 38617 | d93a7f64e231 |
parent 25874 | 83c19f00452c |
permissions | -rw-r--r-- |
20237
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
1 |
/* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
2 |
* Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
4 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
10 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
15 |
* accompanied this code). |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
16 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
20 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
23 |
* questions. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
24 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
25 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
26 |
package com.sun.tools.doclets.internal.toolkit; |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
27 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
28 |
import java.io.*; |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
29 |
import com.sun.javadoc.*; |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
30 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
31 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
32 |
* The interface for writing annotation type field output. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
33 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
34 |
* <p><b>This is NOT part of any supported API. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
35 |
* If you write code that depends on this, you do so at your own risk. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
36 |
* This code and its internal interfaces are subject to change or |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
37 |
* deletion without notice.</b> |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
38 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
39 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
40 |
* @author Bhavesh Patel |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
41 |
* @since 1.8 |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
42 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
43 |
|
38617 | 44 |
@Deprecated |
20237
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
45 |
public interface AnnotationTypeFieldWriter { |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
46 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
47 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
48 |
* Add the annotation type member tree header. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
49 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
50 |
* @return content tree for the member tree header |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
51 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
52 |
public Content getMemberTreeHeader(); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
53 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
54 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
55 |
* Add the annotation type field details marker. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
56 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
57 |
* @param memberDetails the content tree representing field details marker |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
58 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
59 |
public void addAnnotationFieldDetailsMarker(Content memberDetails); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
60 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
61 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
62 |
* Add the annotation type details tree header. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
63 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
64 |
* @param classDoc the annotation type being documented |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
65 |
* @param memberDetailsTree the content tree representing member details |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
66 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
67 |
public void addAnnotationDetailsTreeHeader(ClassDoc classDoc, |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
68 |
Content memberDetailsTree); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
69 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
70 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
71 |
* Get the annotation type documentation tree header. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
72 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
73 |
* @param member the annotation type being documented |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
74 |
* @param annotationDetailsTree the content tree representing annotation type details |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
75 |
* @return content tree for the annotation type documentation header |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
76 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
77 |
public Content getAnnotationDocTreeHeader(MemberDoc member, |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
78 |
Content annotationDetailsTree); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
79 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
80 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
81 |
* Get the annotation type details tree. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
82 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
83 |
* @param annotationDetailsTree the content tree representing annotation type details |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
84 |
* @return content tree for the annotation type details |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
85 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
86 |
public Content getAnnotationDetails(Content annotationDetailsTree); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
87 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
88 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
89 |
* Get the annotation type documentation. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
90 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
91 |
* @param annotationDocTree the content tree representing annotation type documentation |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
92 |
* @param isLastContent true if the content to be added is the last content |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
93 |
* @return content tree for the annotation type documentation |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
94 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
95 |
public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
96 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
97 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
98 |
* Get the signature for the given member. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
99 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
100 |
* @param member the member being documented |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
101 |
* @return content tree for the annotation type signature |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
102 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
103 |
public Content getSignature(MemberDoc member); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
104 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
105 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
106 |
* Add the deprecated output for the given member. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
107 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
108 |
* @param member the member being documented |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
109 |
* @param annotationDocTree content tree to which the deprecated information will be added |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
110 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
111 |
public void addDeprecated(MemberDoc member, Content annotationDocTree); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
112 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
113 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
114 |
* Add the comments for the given member. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
115 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
116 |
* @param member the member being documented |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
117 |
* @param annotationDocTree the content tree to which the comments will be added |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
118 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
119 |
public void addComments(MemberDoc member, Content annotationDocTree); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
120 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
121 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
122 |
* Add the tags for the given member. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
123 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
124 |
* @param member the member being documented |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
125 |
* @param annotationDocTree the content tree to which the tags will be added |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
126 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
127 |
public void addTags(MemberDoc member, Content annotationDocTree); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
128 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
129 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
130 |
* Close the writer. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
131 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
132 |
public void close() throws IOException; |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
diff
changeset
|
133 |
} |