author | jjg |
Mon, 22 Aug 2016 16:32:40 -0700 | |
changeset 40587 | 1c355ea550ed |
parent 40303 | 96a1226aca18 |
child 45599 | 8bc3a019f948 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
2 |
* Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.toolkit.builders; |
10 | 27 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
28 |
import javax.lang.model.element.PackageElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
29 |
import javax.lang.model.element.TypeElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
30 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
31 |
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeWriter; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
32 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
40587 | 33 |
import jdk.javadoc.internal.doclets.toolkit.DocletException; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
34 |
|
10 | 35 |
|
36 |
/** |
|
37 |
* Builds the summary for a given annotation type. |
|
38 |
* |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
39 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
40 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
41 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
42 |
* deletion without notice.</b> |
10 | 43 |
* |
44 |
* @author Jamie Ho |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
45 |
* @author Bhavesh Patel (Modified) |
10 | 46 |
*/ |
47 |
public class AnnotationTypeBuilder extends AbstractBuilder { |
|
48 |
||
49 |
/** |
|
50 |
* The root element of the annotation type XML is {@value}. |
|
51 |
*/ |
|
52 |
public static final String ROOT = "AnnotationTypeDoc"; |
|
53 |
||
54 |
/** |
|
55 |
* The annotation type being documented. |
|
56 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
57 |
private final TypeElement annotationType; |
10 | 58 |
|
59 |
/** |
|
60 |
* The doclet specific writer. |
|
61 |
*/ |
|
14542 | 62 |
private final AnnotationTypeWriter writer; |
10 | 63 |
|
64 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
65 |
* The content tree for the annotation documentation. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
66 |
*/ |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
67 |
private Content contentTree; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
68 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
69 |
/** |
10 | 70 |
* Construct a new ClassBuilder. |
71 |
* |
|
14542 | 72 |
* @param context the build context. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
73 |
* @param annotationTypeElement the class being documented. |
14542 | 74 |
* @param writer the doclet specific writer. |
10 | 75 |
*/ |
14542 | 76 |
private AnnotationTypeBuilder(Context context, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
77 |
TypeElement annotationTypeElement, |
14542 | 78 |
AnnotationTypeWriter writer) { |
79 |
super(context); |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
80 |
this.annotationType = annotationTypeElement; |
14542 | 81 |
this.writer = writer; |
10 | 82 |
} |
83 |
||
84 |
/** |
|
40587 | 85 |
* Construct a new AnnotationTypeBuilder. |
10 | 86 |
* |
14542 | 87 |
* @param context the build context. |
10 | 88 |
* @param annotationTypeDoc the class being documented. |
89 |
* @param writer the doclet specific writer. |
|
40587 | 90 |
* @return an AnnotationTypeBuilder |
10 | 91 |
*/ |
14542 | 92 |
public static AnnotationTypeBuilder getInstance(Context context, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
93 |
TypeElement annotationTypeDoc, |
40587 | 94 |
AnnotationTypeWriter writer) { |
14542 | 95 |
return new AnnotationTypeBuilder(context, annotationTypeDoc, writer); |
10 | 96 |
} |
97 |
||
98 |
/** |
|
99 |
* {@inheritDoc} |
|
100 |
*/ |
|
40587 | 101 |
@Override |
102 |
public void build() throws DocletException { |
|
14542 | 103 |
build(layoutParser.parseXML(ROOT), contentTree); |
10 | 104 |
} |
105 |
||
106 |
/** |
|
107 |
* {@inheritDoc} |
|
108 |
*/ |
|
40587 | 109 |
@Override |
10 | 110 |
public String getName() { |
111 |
return ROOT; |
|
112 |
} |
|
113 |
||
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
114 |
/** |
40587 | 115 |
* Build the annotation type documentation. |
116 |
* |
|
117 |
* @param node the XML element that specifies which components to document |
|
118 |
* @param contentTree the content tree to which the documentation will be added |
|
119 |
* @throws DocletException if there is a problem building the documentation |
|
120 |
*/ |
|
121 |
public void buildAnnotationTypeDoc(XMLNode node, Content contentTree) throws DocletException { |
|
122 |
contentTree = writer.getHeader(configuration.getText("doclet.AnnotationType") + |
|
123 |
" " + utils.getSimpleName(annotationType)); |
|
124 |
Content annotationContentTree = writer.getAnnotationContentHeader(); |
|
125 |
buildChildren(node, annotationContentTree); |
|
126 |
writer.addAnnotationContentTree(contentTree, annotationContentTree); |
|
127 |
writer.addFooter(contentTree); |
|
128 |
writer.printDocument(contentTree); |
|
129 |
copyDocFiles(); |
|
130 |
} |
|
10 | 131 |
|
40587 | 132 |
/** |
133 |
* Copy the doc files for the current TypeElement if necessary. |
|
134 |
* |
|
135 |
* @throws DocletException if there is a problem building the documentation |
|
136 |
*/ |
|
137 |
private void copyDocFiles() throws DocletException { |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
138 |
PackageElement containingPackage = utils.containingPackage(annotationType); |
10 | 139 |
if((configuration.packages == null || |
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
20237
diff
changeset
|
140 |
!configuration.packages.contains(containingPackage) && |
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
20237
diff
changeset
|
141 |
!containingPackagesSeen.contains(containingPackage))){ |
10 | 142 |
//Only copy doc files dir if the containing package is not |
143 |
//documented AND if we have not documented a class from the same |
|
144 |
//package already. Otherwise, we are making duplicate copies. |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
145 |
utils.copyDocFiles(containingPackage); |
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
20237
diff
changeset
|
146 |
containingPackagesSeen.add(containingPackage); |
10 | 147 |
} |
40587 | 148 |
} |
10 | 149 |
|
150 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
151 |
* Build the annotation information tree documentation. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
152 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
153 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
154 |
* @param annotationContentTree the content tree to which the documentation will be added |
40587 | 155 |
* @throws DocletException if there is a problem building the documentation |
10 | 156 |
*/ |
40587 | 157 |
public void buildAnnotationTypeInfo(XMLNode node, Content annotationContentTree) |
158 |
throws DocletException { |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
159 |
Content annotationInfoTree = writer.getAnnotationInfoTreeHeader(); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
160 |
buildChildren(node, annotationInfoTree); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
161 |
annotationContentTree.addContent(writer.getAnnotationInfo(annotationInfoTree)); |
10 | 162 |
} |
163 |
||
164 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
165 |
* If this annotation is deprecated, build the appropriate information. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
166 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
167 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
168 |
* @param annotationInfoTree the content tree to which the documentation will be added |
10 | 169 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
170 |
public void buildDeprecationInfo (XMLNode node, Content annotationInfoTree) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
171 |
writer.addAnnotationTypeDeprecationInfo(annotationInfoTree); |
10 | 172 |
} |
173 |
||
174 |
/** |
|
175 |
* Build the signature of the current annotation type. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
176 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
177 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
178 |
* @param annotationInfoTree the content tree to which the documentation will be added |
10 | 179 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
180 |
public void buildAnnotationTypeSignature(XMLNode node, Content annotationInfoTree) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
181 |
writer.addAnnotationTypeSignature(utils.modifiersToString(annotationType, true), |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
182 |
annotationInfoTree); |
10 | 183 |
} |
184 |
||
185 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
186 |
* Build the annotation type description. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
187 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
188 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
189 |
* @param annotationInfoTree the content tree to which the documentation will be added |
10 | 190 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
191 |
public void buildAnnotationTypeDescription(XMLNode node, Content annotationInfoTree) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
192 |
writer.addAnnotationTypeDescription(annotationInfoTree); |
10 | 193 |
} |
194 |
||
195 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
196 |
* Build the tag information for the current annotation type. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
197 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
198 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
199 |
* @param annotationInfoTree the content tree to which the documentation will be added |
10 | 200 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
201 |
public void buildAnnotationTypeTagInfo(XMLNode node, Content annotationInfoTree) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
202 |
writer.addAnnotationTypeTagInfo(annotationInfoTree); |
10 | 203 |
} |
204 |
||
205 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
206 |
* Build the member summary contents of the page. |
10 | 207 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
208 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
209 |
* @param annotationContentTree the content tree to which the documentation will be added |
40587 | 210 |
* @throws DocletException if there is a problem building the documentation |
10 | 211 |
*/ |
40587 | 212 |
public void buildMemberSummary(XMLNode node, Content annotationContentTree) throws DocletException { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
213 |
Content memberSummaryTree = writer.getMemberTreeHeader(); |
10 | 214 |
configuration.getBuilderFactory(). |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
215 |
getMemberSummaryBuilder(writer).buildChildren(node, memberSummaryTree); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
216 |
annotationContentTree.addContent(writer.getMemberSummaryTree(memberSummaryTree)); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
217 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
218 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
219 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
220 |
* Build the member details contents of the page. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
221 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
222 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
223 |
* @param annotationContentTree the content tree to which the documentation will be added |
40587 | 224 |
* @throws DocletException if there is a problem building the documentation |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
225 |
*/ |
40587 | 226 |
public void buildAnnotationTypeMemberDetails(XMLNode node, Content annotationContentTree) |
227 |
throws DocletException { |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
228 |
Content memberDetailsTree = writer.getMemberTreeHeader(); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
229 |
buildChildren(node, memberDetailsTree); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
230 |
if (memberDetailsTree.isValid()) { |
20237
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
231 |
annotationContentTree.addContent(writer.getMemberDetailsTree(memberDetailsTree)); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
232 |
} |
10 | 233 |
} |
234 |
||
235 |
/** |
|
20237
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
236 |
* Build the annotation type field documentation. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
237 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
238 |
* @param node the XML element that specifies which components to document |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
239 |
* @param memberDetailsTree the content tree to which the documentation will be added |
40587 | 240 |
* @throws DocletException if there is a problem building the documentation |
20237
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
241 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
242 |
public void buildAnnotationTypeFieldDetails(XMLNode node, Content memberDetailsTree) |
40587 | 243 |
throws DocletException { |
20237
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
244 |
configuration.getBuilderFactory(). |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
245 |
getAnnotationTypeFieldsBuilder(writer).buildChildren(node, memberDetailsTree); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
246 |
} |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
247 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
16560
diff
changeset
|
248 |
/** |
10 | 249 |
* Build the annotation type optional member documentation. |
250 |
* |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
251 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
252 |
* @param memberDetailsTree the content tree to which the documentation will be added |
40587 | 253 |
* @throws DocletException if there is a problem building the documentation |
10 | 254 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
255 |
public void buildAnnotationTypeOptionalMemberDetails(XMLNode node, Content memberDetailsTree) |
40587 | 256 |
throws DocletException { |
10 | 257 |
configuration.getBuilderFactory(). |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
258 |
getAnnotationTypeOptionalMemberBuilder(writer).buildChildren(node, memberDetailsTree); |
10 | 259 |
} |
260 |
||
261 |
/** |
|
262 |
* Build the annotation type required member documentation. |
|
263 |
* |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
264 |
* @param node the XML element that specifies which components to document |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
265 |
* @param memberDetailsTree the content tree to which the documentation will be added |
40587 | 266 |
* @throws DocletException if there is a problem building the documentation |
10 | 267 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
268 |
public void buildAnnotationTypeRequiredMemberDetails(XMLNode node, Content memberDetailsTree) |
40587 | 269 |
throws DocletException { |
10 | 270 |
configuration.getBuilderFactory(). |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5855
diff
changeset
|
271 |
getAnnotationTypeRequiredMemberBuilder(writer).buildChildren(node, memberDetailsTree); |
10 | 272 |
} |
273 |
} |