author | hannesw |
Wed, 05 Jun 2019 16:26:13 +0200 | |
changeset 55232 | 9b392b044f64 |
parent 54596 | 86c1da00dd6a |
permissions | -rw-r--r-- |
10 | 1 |
/* |
45599 | 2 |
* Copyright (c) 2003, 2017, 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:
25874
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.toolkit; |
10 | 27 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
28 |
import javax.lang.model.element.Element; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
29 |
import javax.lang.model.element.TypeElement; |
45599 | 30 |
|
10 | 31 |
/** |
32 |
* The interface for writing annotation type required member output. |
|
33 |
* |
|
14260 | 34 |
* <p><b>This is NOT part of any supported API. |
35 |
* If you write code that depends on this, you do so at your own risk. |
|
36 |
* This code and its internal interfaces are subject to change or |
|
37 |
* deletion without notice.</b> |
|
38 |
* |
|
10 | 39 |
* |
40 |
* @author Jamie Ho |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
41 |
* @author Bhavesh Patel (Modified) |
10 | 42 |
*/ |
43 |
||
44 |
public interface AnnotationTypeRequiredMemberWriter { |
|
45 |
||
46 |
/** |
|
20237
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
47 |
* Add the annotation type member tree header. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
48 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
49 |
* @return content tree for the member tree header |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
50 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
51 |
public Content getMemberTreeHeader(); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
52 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
53 |
/** |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
54 |
* Add the annotation type details marker. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
55 |
* |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
56 |
* @param memberDetails the content tree representing details marker |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
57 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
58 |
public void addAnnotationDetailsMarker(Content memberDetails); |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
59 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
14260
diff
changeset
|
60 |
/** |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
61 |
* Add the annotation type details tree header. |
10 | 62 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
63 |
* @param typeElement the annotation type being documented |
10 | 64 |
*/ |
54596
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47216
diff
changeset
|
65 |
public Content getAnnotationDetailsTreeHeader(TypeElement typeElement); |
10 | 66 |
|
67 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
68 |
* Get the annotation type documentation tree header. |
10 | 69 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
70 |
* @param member the annotation type being documented |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
71 |
* @param annotationDetailsTree the content tree representing annotation type details |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
72 |
* @return content tree for the annotation type documentation header |
10 | 73 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
74 |
public Content getAnnotationDocTreeHeader(Element member, |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
75 |
Content annotationDetailsTree); |
10 | 76 |
|
77 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
78 |
* Get the annotation type details tree. |
10 | 79 |
* |
54596
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47216
diff
changeset
|
80 |
* @param annotationDetailsTreeHeader the content tree representing annotation type details header |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
81 |
* @param annotationDetailsTree the content tree representing annotation type details |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
82 |
* @return content tree for the annotation type details |
10 | 83 |
*/ |
54596
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47216
diff
changeset
|
84 |
public Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree); |
10 | 85 |
|
86 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
87 |
* Get the annotation type documentation. |
10 | 88 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
89 |
* @param annotationDocTree the content tree representing annotation type documentation |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
90 |
* @return content tree for the annotation type documentation |
10 | 91 |
*/ |
55232 | 92 |
public Content getAnnotationDoc(Content annotationDocTree); |
10 | 93 |
|
94 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
95 |
* Get the signature for the given member. |
10 | 96 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
97 |
* @param member the member being documented |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
98 |
* @return content tree for the annotation type signature |
10 | 99 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
100 |
public Content getSignature(Element member); |
10 | 101 |
|
102 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
103 |
* Add the deprecated output for the given member. |
10 | 104 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
105 |
* @param member the member being documented |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
106 |
* @param annotationDocTree content tree to which the deprecated information will be added |
10 | 107 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
108 |
public void addDeprecated(Element member, Content annotationDocTree); |
10 | 109 |
|
110 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
111 |
* Add the comments for the given member. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
112 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
113 |
* @param member the member being documented |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
114 |
* @param annotationDocTree the content tree to which the comments will be added |
10 | 115 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
116 |
public void addComments(Element member, Content annotationDocTree); |
10 | 117 |
|
118 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
119 |
* Add the tags for the given member. |
10 | 120 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
121 |
* @param member the member being documented |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
122 |
* @param annotationDocTree the content tree to which the tags will be added |
10 | 123 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
124 |
public void addTags(Element member, Content annotationDocTree); |
10 | 125 |
} |