author | chegar |
Thu, 17 Oct 2019 20:54:25 +0100 | |
branch | datagramsocketimpl-branch |
changeset 58679 | 9c3209ff7550 |
parent 58678 | 9cf78a70fa4f |
parent 55266 | fb250e9cfe67 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2 |
* Copyright (c) 1998, 2019, 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:
33920
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.formats.html; |
10 | 27 |
|
54610 | 28 |
import java.util.ArrayList; |
54936 | 29 |
import java.util.Collections; |
55266
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
30 |
import java.util.HashMap; |
54610 | 31 |
import java.util.LinkedList; |
32 |
import java.util.List; |
|
33 |
import java.util.ListIterator; |
|
34 |
import java.util.Locale; |
|
35 |
import java.util.Map; |
|
36 |
import java.util.Set; |
|
24603
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
37 |
import java.util.regex.Matcher; |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
38 |
import java.util.regex.Pattern; |
10 | 39 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
40 |
import javax.lang.model.element.AnnotationMirror; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
41 |
import javax.lang.model.element.AnnotationValue; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
42 |
import javax.lang.model.element.Element; |
47328
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
43 |
import javax.lang.model.element.ElementKind; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
44 |
import javax.lang.model.element.ExecutableElement; |
36526 | 45 |
import javax.lang.model.element.ModuleElement; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
46 |
import javax.lang.model.element.Name; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
47 |
import javax.lang.model.element.PackageElement; |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
48 |
import javax.lang.model.element.QualifiedNameable; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
49 |
import javax.lang.model.element.TypeElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
50 |
import javax.lang.model.element.VariableElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
51 |
import javax.lang.model.type.DeclaredType; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
52 |
import javax.lang.model.type.TypeMirror; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
53 |
import javax.lang.model.util.SimpleAnnotationValueVisitor9; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
54 |
import javax.lang.model.util.SimpleElementVisitor9; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
55 |
import javax.lang.model.util.SimpleTypeVisitor9; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
56 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
57 |
import com.sun.source.doctree.AttributeTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
58 |
import com.sun.source.doctree.AttributeTree.ValueKind; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
59 |
import com.sun.source.doctree.CommentTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
60 |
import com.sun.source.doctree.DocRootTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
61 |
import com.sun.source.doctree.DocTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
62 |
import com.sun.source.doctree.DocTree.Kind; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
63 |
import com.sun.source.doctree.EndElementTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
64 |
import com.sun.source.doctree.EntityTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
65 |
import com.sun.source.doctree.ErroneousTree; |
40587 | 66 |
import com.sun.source.doctree.IndexTree; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
67 |
import com.sun.source.doctree.InheritDocTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
68 |
import com.sun.source.doctree.LinkTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
69 |
import com.sun.source.doctree.LiteralTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
70 |
import com.sun.source.doctree.SeeTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
71 |
import com.sun.source.doctree.StartElementTree; |
46184
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
72 |
import com.sun.source.doctree.SummaryTree; |
52487
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
73 |
import com.sun.source.doctree.SystemPropertyTree; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
74 |
import com.sun.source.doctree.TextTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
75 |
import com.sun.source.util.SimpleDocTreeVisitor; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
76 |
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder; |
54610 | 77 |
import jdk.javadoc.internal.doclets.formats.html.markup.Entity; |
78 |
import jdk.javadoc.internal.doclets.formats.html.markup.Head; |
|
79 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlAttr; |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
80 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlDocument; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
81 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
82 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
83 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; |
47850 | 84 |
import jdk.javadoc.internal.doclets.formats.html.markup.Links; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
85 |
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml; |
47847 | 86 |
import jdk.javadoc.internal.doclets.formats.html.markup.Script; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
87 |
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; |
54610 | 88 |
import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
89 |
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeWriter; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
90 |
import jdk.javadoc.internal.doclets.toolkit.ClassWriter; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
91 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
40303 | 92 |
import jdk.javadoc.internal.doclets.toolkit.Messages; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
93 |
import jdk.javadoc.internal.doclets.toolkit.PackageSummaryWriter; |
40303 | 94 |
import jdk.javadoc.internal.doclets.toolkit.Resources; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
95 |
import jdk.javadoc.internal.doclets.toolkit.taglets.DocRootTaglet; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
96 |
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletWriter; |
40587 | 97 |
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
98 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFile; |
40587 | 99 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
100 |
import jdk.javadoc.internal.doclets.toolkit.util.DocLink; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
101 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
102 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
103 |
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
104 |
import jdk.javadoc.internal.doclets.toolkit.util.Utils; |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
105 |
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
106 |
|
54610 | 107 |
import static com.sun.source.doctree.DocTree.Kind.CODE; |
108 |
import static com.sun.source.doctree.DocTree.Kind.COMMENT; |
|
109 |
import static com.sun.source.doctree.DocTree.Kind.LINK; |
|
110 |
import static com.sun.source.doctree.DocTree.Kind.LINK_PLAIN; |
|
111 |
import static com.sun.source.doctree.DocTree.Kind.SEE; |
|
112 |
import static com.sun.source.doctree.DocTree.Kind.TEXT; |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
113 |
import static jdk.javadoc.internal.doclets.toolkit.util.CommentHelper.SPACER; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
114 |
|
10 | 115 |
|
116 |
/** |
|
117 |
* Class for the Html Format Code Generation specific to JavaDoc. |
|
118 |
* This Class contains methods related to the Html Code Generation which |
|
119 |
* are used extensively while generating the entire documentation. |
|
120 |
* |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
121 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
122 |
* 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:
14259
diff
changeset
|
123 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
124 |
* deletion without notice.</b> |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
125 |
* |
10 | 126 |
* @author Atul M Dambalkar |
127 |
* @author Robert Field |
|
2216
b124d5c924eb
6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents:
2086
diff
changeset
|
128 |
* @author Bhavesh Patel (Modified) |
10 | 129 |
*/ |
47852 | 130 |
public class HtmlDocletWriter { |
10 | 131 |
|
132 |
/** |
|
133 |
* Relative path from the file getting generated to the destination |
|
134 |
* directory. For example, if the file getting generated is |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
135 |
* "java/lang/Object.html", then the path to the root is "../..". |
10 | 136 |
* This string can be empty if the file getting generated is in |
137 |
* the destination directory. |
|
138 |
*/ |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
139 |
public final DocPath pathToRoot; |
10 | 140 |
|
141 |
/** |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
142 |
* Platform-independent path from the current or the |
10 | 143 |
* destination directory to the file getting generated. |
144 |
* Used when creating the file. |
|
145 |
*/ |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
146 |
public final DocPath path; |
10 | 147 |
|
148 |
/** |
|
149 |
* Name of the file getting generated. If the file getting generated is |
|
150 |
* "java/lang/Object.html", then the filename is "Object.html". |
|
151 |
*/ |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
152 |
public final DocPath filename; |
10 | 153 |
|
154 |
/** |
|
155 |
* The global configuration information for this run. |
|
156 |
*/ |
|
45417 | 157 |
public final HtmlConfiguration configuration; |
10 | 158 |
|
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
24603
diff
changeset
|
159 |
protected final Utils utils; |
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
24603
diff
changeset
|
160 |
|
40303 | 161 |
protected final Contents contents; |
162 |
||
163 |
protected final Messages messages; |
|
164 |
||
165 |
protected final Resources resources; |
|
166 |
||
47850 | 167 |
protected final Links links; |
168 |
||
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
169 |
protected final DocPaths docPaths; |
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
170 |
|
10 | 171 |
/** |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
172 |
* To check whether annotation heading is printed or not. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
173 |
*/ |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
174 |
protected boolean printedAnnotationHeading = false; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
175 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
176 |
/** |
20237
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
19920
diff
changeset
|
177 |
* To check whether annotation field heading is printed or not. |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
19920
diff
changeset
|
178 |
*/ |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
19920
diff
changeset
|
179 |
protected boolean printedAnnotationFieldHeading = false; |
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
19920
diff
changeset
|
180 |
|
b6d89903c867
8015249: javadoc fails to document static final fields in annotation types
bpatel
parents:
19920
diff
changeset
|
181 |
/** |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
182 |
* To check whether the repeated annotations is documented or not. |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
183 |
*/ |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
184 |
private boolean isAnnotationDocumented = false; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
185 |
|
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
186 |
/** |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
187 |
* To check whether the container annotations is documented or not. |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
188 |
*/ |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
189 |
private boolean isContainerDocumented = false; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
190 |
|
33920 | 191 |
HtmlTree fixedNavDiv = new HtmlTree(HtmlTag.DIV); |
192 |
||
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
193 |
/** |
47847 | 194 |
* The window title of this file. |
195 |
*/ |
|
196 |
protected String winTitle; |
|
197 |
||
198 |
protected Script mainBodyScript; |
|
199 |
||
200 |
/** |
|
55266
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
201 |
* A table of the anchors used for at-index and related tags, |
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
202 |
* so that they can be made unique by appending a suitable suffix. |
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
203 |
* (Ideally, javadoc should be tracking all id's generated in a file |
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
204 |
* to avoid generating duplicates.) |
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
205 |
*/ |
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
206 |
Map<String, Integer> indexAnchorTable = new HashMap<>(); |
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
207 |
|
fb250e9cfe67
8225321: Repeated use of {@systemProperty} in a file causes duplicate ids
jjg
parents:
55197
diff
changeset
|
208 |
/** |
10 | 209 |
* Constructor to construct the HtmlStandardWriter object. |
210 |
* |
|
47852 | 211 |
* @param configuration the configuration for this doclet |
212 |
* @param path the file to be generated. |
|
10 | 213 |
*/ |
45417 | 214 |
public HtmlDocletWriter(HtmlConfiguration configuration, DocPath path) { |
10 | 215 |
this.configuration = configuration; |
40303 | 216 |
this.contents = configuration.contents; |
217 |
this.messages = configuration.messages; |
|
218 |
this.resources = configuration.resources; |
|
53562 | 219 |
this.links = new Links(path); |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
24603
diff
changeset
|
220 |
this.utils = configuration.utils; |
10 | 221 |
this.path = path; |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
222 |
this.pathToRoot = path.parent().invert(); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
223 |
this.filename = path.basename(); |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
224 |
this.docPaths = configuration.docPaths; |
54350
4f9772f4403d
8215599: Remove support for javadoc "frames" mode
pmuthuswamy
parents:
54060
diff
changeset
|
225 |
this.mainBodyScript = new Script(); |
47852 | 226 |
|
227 |
messages.notice("doclet.Generating_0", |
|
228 |
DocFile.createFileForOutput(configuration, path).getPath()); |
|
10 | 229 |
} |
230 |
||
231 |
/** |
|
232 |
* Replace {@docRoot} tag used in options that accept HTML text, such |
|
233 |
* as -header, -footer, -top and -bottom, and when converting a relative |
|
234 |
* HREF where commentTagsToString inserts a {@docRoot} where one was |
|
235 |
* missing. (Also see DocRootTaglet for {@docRoot} tags in doc |
|
236 |
* comments.) |
|
237 |
* <p> |
|
238 |
* Replace {@docRoot} tag in htmlstr with the relative path to the |
|
239 |
* destination directory from the directory where the file is being |
|
240 |
* written, looping to handle all such tags in htmlstr. |
|
241 |
* <p> |
|
242 |
* For example, for "-d docs" and -header containing {@docRoot}, when |
|
243 |
* the HTML page for source file p/C1.java is being generated, the |
|
244 |
* {@docRoot} tag would be inserted into the header as "../", |
|
245 |
* the relative path from docs/p/ to docs/ (the document root). |
|
246 |
* <p> |
|
247 |
* Note: This doc comment was written with '&#064;' representing '@' |
|
248 |
* to prevent the inline tag from being interpreted. |
|
249 |
*/ |
|
250 |
public String replaceDocRootDir(String htmlstr) { |
|
251 |
// Return if no inline tags exist |
|
252 |
int index = htmlstr.indexOf("{@"); |
|
253 |
if (index < 0) { |
|
254 |
return htmlstr; |
|
255 |
} |
|
24603
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
256 |
Matcher docrootMatcher = docrootPattern.matcher(htmlstr); |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
257 |
if (!docrootMatcher.find()) { |
10 | 258 |
return htmlstr; |
259 |
} |
|
8631
664f84942e74
6866185: Util.getPackageSourcePath should use lastIndexOf not indexOf and related cleanup
jjg
parents:
7681
diff
changeset
|
260 |
StringBuilder buf = new StringBuilder(); |
24603
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
261 |
int prevEnd = 0; |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
262 |
do { |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
263 |
int match = docrootMatcher.start(); |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
264 |
// append htmlstr up to start of next {@docroot} |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
265 |
buf.append(htmlstr.substring(prevEnd, match)); |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
266 |
prevEnd = docrootMatcher.end(); |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
267 |
if (configuration.docrootparent.length() > 0 && htmlstr.startsWith("/..", prevEnd)) { |
22005
4270ada5dcd1
8025416: doclet not substituting {@docRoot} in some cases
bpatel
parents:
21494
diff
changeset
|
268 |
// Insert the absolute link if {@docRoot} is followed by "/..". |
9608 | 269 |
buf.append(configuration.docrootparent); |
24603
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
270 |
prevEnd += 3; |
9608 | 271 |
} else { |
272 |
// Insert relative path where {@docRoot} was located |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
273 |
buf.append(pathToRoot.isEmpty() ? "." : pathToRoot.getPath()); |
22005
4270ada5dcd1
8025416: doclet not substituting {@docRoot} in some cases
bpatel
parents:
21494
diff
changeset
|
274 |
} |
4270ada5dcd1
8025416: doclet not substituting {@docRoot} in some cases
bpatel
parents:
21494
diff
changeset
|
275 |
// Append slash if next character is not a slash |
24603
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
276 |
if (prevEnd < htmlstr.length() && htmlstr.charAt(prevEnd) != '/') { |
22005
4270ada5dcd1
8025416: doclet not substituting {@docRoot} in some cases
bpatel
parents:
21494
diff
changeset
|
277 |
buf.append('/'); |
10 | 278 |
} |
24603
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
279 |
} while (docrootMatcher.find()); |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
280 |
buf.append(htmlstr.substring(prevEnd)); |
10 | 281 |
return buf.toString(); |
282 |
} |
|
24603
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
283 |
//where: |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
284 |
// Note: {@docRoot} is not case sensitive when passed in w/command line option: |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
285 |
private static final Pattern docrootPattern = |
43e7e44d63da
8043186: javac test langtools/tools/javac/util/StringUtilsTest.java fails
jlahoda
parents:
24221
diff
changeset
|
286 |
Pattern.compile(Pattern.quote("{@docroot}"), Pattern.CASE_INSENSITIVE); |
10 | 287 |
|
288 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
289 |
* Get the script to show or hide the All classes link. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
290 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
291 |
* @param id id of the element to show or hide |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
292 |
* @return a content tree for the script |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
293 |
*/ |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
294 |
public Content getAllClassesLinkScript(String id) { |
47847 | 295 |
Script script = new Script("<!--\n" + |
296 |
" allClassesLink = document.getElementById(") |
|
297 |
.appendStringLiteral(id) |
|
298 |
.append(");\n" + |
|
40303 | 299 |
" if(window==top) {\n" + |
300 |
" allClassesLink.style.display = \"block\";\n" + |
|
301 |
" }\n" + |
|
302 |
" else {\n" + |
|
303 |
" allClassesLink.style.display = \"none\";\n" + |
|
304 |
" }\n" + |
|
47847 | 305 |
" //-->\n"); |
306 |
Content div = HtmlTree.DIV(script.asContent()); |
|
40303 | 307 |
Content div_noscript = HtmlTree.DIV(contents.noScriptMessage); |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26900
diff
changeset
|
308 |
Content noScript = HtmlTree.NOSCRIPT(div_noscript); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
309 |
div.add(noScript); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
310 |
return div; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
311 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
312 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
313 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
314 |
* Add method information. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
315 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
316 |
* @param method the method to be documented |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
317 |
* @param dl the content tree to which the method information will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
318 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
319 |
private void addMethodInfo(ExecutableElement method, Content dl) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
320 |
TypeElement enclosing = utils.getEnclosingTypeElement(method); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
321 |
List<? extends TypeMirror> intfacs = enclosing.getInterfaces(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
322 |
ExecutableElement overriddenMethod = utils.overriddenMethod(method); |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
323 |
VisibleMemberTable vmt = configuration.getVisibleMemberTable(enclosing); |
2216
b124d5c924eb
6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents:
2086
diff
changeset
|
324 |
// Check whether there is any implementation or overridden info to be |
b124d5c924eb
6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents:
2086
diff
changeset
|
325 |
// printed. If no overridden or implementation info needs to be |
b124d5c924eb
6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents:
2086
diff
changeset
|
326 |
// printed, do not print this section. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
327 |
if ((!intfacs.isEmpty() |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
328 |
&& vmt.getImplementedMethods(method).isEmpty() == false) |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
329 |
|| overriddenMethod != null) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
330 |
MethodWriterImpl.addImplementsInfo(this, method, dl); |
10 | 331 |
if (overriddenMethod != null) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
332 |
MethodWriterImpl.addOverridden(this, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
333 |
utils.overriddenType(method), |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
334 |
overriddenMethod, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
335 |
dl); |
10 | 336 |
} |
337 |
} |
|
338 |
} |
|
339 |
||
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
340 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
341 |
* Adds the tags information. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
342 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
343 |
* @param e the Element for which the tags will be generated |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
344 |
* @param htmltree the documentation tree to which the tags will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
345 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
346 |
protected void addTagsInfo(Element e, Content htmltree) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
347 |
if (configuration.nocomment) { |
10 | 348 |
return; |
349 |
} |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
350 |
Content dl = new HtmlTree(HtmlTag.DL); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
351 |
if (utils.isExecutableElement(e) && !utils.isConstructor(e)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
352 |
addMethodInfo((ExecutableElement)e, dl); |
10 | 353 |
} |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17573
diff
changeset
|
354 |
Content output = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
355 |
TagletWriter.genTagOutput(configuration.tagletManager, e, |
50240 | 356 |
configuration.tagletManager.getBlockTaglets(e), |
10 | 357 |
getTagletWriterInstance(false), output); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
358 |
dl.add(output); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
359 |
htmltree.add(dl); |
10 | 360 |
} |
361 |
||
362 |
/** |
|
2216
b124d5c924eb
6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents:
2086
diff
changeset
|
363 |
* Check whether there are any tags for Serialization Overview |
b124d5c924eb
6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents:
2086
diff
changeset
|
364 |
* section to be printed. |
2086
cca2603eab0b
6802694: Javadoc doclet does not display deprecated information with -nocomment option for serialized form
bpatel
parents:
1789
diff
changeset
|
365 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
366 |
* @param field the VariableElement object to check for tags. |
2086
cca2603eab0b
6802694: Javadoc doclet does not display deprecated information with -nocomment option for serialized form
bpatel
parents:
1789
diff
changeset
|
367 |
* @return true if there are tags to be printed else return false. |
cca2603eab0b
6802694: Javadoc doclet does not display deprecated information with -nocomment option for serialized form
bpatel
parents:
1789
diff
changeset
|
368 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
369 |
protected boolean hasSerializationOverviewTags(VariableElement field) { |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17573
diff
changeset
|
370 |
Content output = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
371 |
TagletWriter.genTagOutput(configuration.tagletManager, field, |
50240 | 372 |
configuration.tagletManager.getBlockTaglets(field), |
2086
cca2603eab0b
6802694: Javadoc doclet does not display deprecated information with -nocomment option for serialized form
bpatel
parents:
1789
diff
changeset
|
373 |
getTagletWriterInstance(false), output); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17573
diff
changeset
|
374 |
return !output.isEmpty(); |
2086
cca2603eab0b
6802694: Javadoc doclet does not display deprecated information with -nocomment option for serialized form
bpatel
parents:
1789
diff
changeset
|
375 |
} |
cca2603eab0b
6802694: Javadoc doclet does not display deprecated information with -nocomment option for serialized form
bpatel
parents:
1789
diff
changeset
|
376 |
|
cca2603eab0b
6802694: Javadoc doclet does not display deprecated information with -nocomment option for serialized form
bpatel
parents:
1789
diff
changeset
|
377 |
/** |
10 | 378 |
* Returns a TagletWriter that knows how to write HTML. |
379 |
* |
|
51862 | 380 |
* @param isFirstSentence true if we want to write the first sentence |
10 | 381 |
* @return a TagletWriter that knows how to write HTML. |
382 |
*/ |
|
383 |
public TagletWriter getTagletWriterInstance(boolean isFirstSentence) { |
|
384 |
return new TagletWriterImpl(this, isFirstSentence); |
|
385 |
} |
|
386 |
||
387 |
/** |
|
51862 | 388 |
* Returns a TagletWriter that knows how to write HTML. |
389 |
* |
|
390 |
* @param isFirstSentence true if we want to write the first sentence |
|
391 |
* @param inSummary true if tags are to be added in a summary section |
|
392 |
* @return a TagletWriter |
|
393 |
*/ |
|
394 |
public TagletWriter getTagletWriterInstance(boolean isFirstSentence, boolean inSummary) { |
|
395 |
return new TagletWriterImpl(this, isFirstSentence, inSummary); |
|
396 |
} |
|
397 |
||
398 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
399 |
* Generates the HTML document tree and prints it out. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
400 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
401 |
* @param metakeywords Array of String keywords for META tag. Each element |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
402 |
* of the array is assigned to a separate META tag. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
403 |
* Pass in null for no array |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
404 |
* @param description the content for the description META tag. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
405 |
* @param body the body htmltree to be included in the document |
40587 | 406 |
* @throws DocFileIOException if there is a problem writing the file |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
407 |
*/ |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
408 |
public void printHtmlDocument(List<String> metakeywords, |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
409 |
String description, |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
410 |
Content body) |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
411 |
throws DocFileIOException { |
54936 | 412 |
printHtmlDocument(metakeywords, description, new ContentBuilder(), Collections.emptyList(), body); |
413 |
} |
|
414 |
||
415 |
/** |
|
416 |
* Generates the HTML document tree and prints it out. |
|
417 |
* |
|
418 |
* @param metakeywords Array of String keywords for META tag. Each element |
|
419 |
* of the array is assigned to a separate META tag. |
|
420 |
* Pass in null for no array |
|
421 |
* @param description the content for the description META tag. |
|
422 |
* @param localStylesheets local stylesheets to be included in the HEAD element |
|
423 |
* @param body the body htmltree to be included in the document |
|
424 |
* @throws DocFileIOException if there is a problem writing the file |
|
425 |
*/ |
|
426 |
public void printHtmlDocument(List<String> metakeywords, |
|
427 |
String description, |
|
428 |
List<DocPath> localStylesheets, |
|
429 |
Content body) |
|
430 |
throws DocFileIOException { |
|
431 |
printHtmlDocument(metakeywords, description, new ContentBuilder(), localStylesheets, body); |
|
53164
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
432 |
} |
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
433 |
|
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
434 |
/** |
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
435 |
* Generates the HTML document tree and prints it out. |
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
436 |
* |
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
437 |
* @param metakeywords Array of String keywords for META tag. Each element |
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
438 |
* of the array is assigned to a separate META tag. |
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
439 |
* Pass in null for no array |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
440 |
* @param description the content for the description META tag. |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
441 |
* @param extraHeadContent any additional content to be included in the HEAD element |
54936 | 442 |
* @param localStylesheets local stylesheets to be included in the HEAD element |
53164
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
443 |
* @param body the body htmltree to be included in the document |
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
444 |
* @throws DocFileIOException if there is a problem writing the file |
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
445 |
*/ |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
446 |
public void printHtmlDocument(List<String> metakeywords, |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
447 |
String description, |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
448 |
Content extraHeadContent, |
54936 | 449 |
List<DocPath> localStylesheets, |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
450 |
Content body) |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
451 |
throws DocFileIOException { |
47848 | 452 |
Content htmlComment = contents.newPage; |
54936 | 453 |
List<DocPath> additionalStylesheets = configuration.getAdditionalStylesheets(); |
454 |
additionalStylesheets.addAll(localStylesheets); |
|
53562 | 455 |
Head head = new Head(path, configuration.docletVersion) |
47849 | 456 |
.setTimestamp(!configuration.notimestamp) |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
457 |
.setDescription(description) |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
458 |
.setGenerator(getGenerator(getClass())) |
47849 | 459 |
.setTitle(winTitle) |
460 |
.setCharset(configuration.charset) |
|
461 |
.addKeywords(metakeywords) |
|
54936 | 462 |
.setStylesheets(configuration.getMainStylesheet(), additionalStylesheets) |
53164
f2140eebd91b
8214738: javadoc should honor styles in doc-files
pmuthuswamy
parents:
52487
diff
changeset
|
463 |
.setIndex(configuration.createindex, mainBodyScript) |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
464 |
.addContent(extraHeadContent); |
47848 | 465 |
|
47849 | 466 |
Content htmlTree = HtmlTree.HTML(configuration.getLocale().getLanguage(), head.toContent(), body); |
53562 | 467 |
HtmlDocument htmlDocument = new HtmlDocument(htmlComment, htmlTree); |
47848 | 468 |
htmlDocument.write(DocFile.createFileForOutput(configuration, path)); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
469 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
470 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
471 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
472 |
* Get the window title. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
473 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
474 |
* @param title the title string to construct the complete window title |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
475 |
* @return the window title string |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
476 |
*/ |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
477 |
public String getWindowTitle(String title) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
478 |
if (configuration.windowtitle.length() > 0) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
479 |
title += " (" + configuration.windowtitle + ")"; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
480 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
481 |
return title; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
482 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
483 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
484 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
485 |
* Get user specified header and the footer. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
486 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
487 |
* @param header if true print the user provided header else print the |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
488 |
* user provided footer. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
489 |
*/ |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
490 |
public Content getUserHeaderFooter(boolean header) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
491 |
String content; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
492 |
if (header) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
493 |
content = replaceDocRootDir(configuration.header); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
494 |
} else { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
495 |
if (configuration.footer.length() != 0) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
496 |
content = replaceDocRootDir(configuration.footer); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
497 |
} else { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
498 |
content = replaceDocRootDir(configuration.header); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
499 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
500 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
501 |
Content rawContent = new RawHtml(content); |
19254
0988183c8164
4749567: stddoclet: Add CSS style for setting header/footer to be italic
bpatel
parents:
19253
diff
changeset
|
502 |
return rawContent; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
503 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
504 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
505 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
506 |
* Adds the user specified top. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
507 |
* |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26900
diff
changeset
|
508 |
* @param htmlTree the content tree to which user specified top will be added |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
509 |
*/ |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26900
diff
changeset
|
510 |
public void addTop(Content htmlTree) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
511 |
Content top = new RawHtml(replaceDocRootDir(configuration.top)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
512 |
fixedNavDiv.add(top); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
513 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
514 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
515 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
516 |
* Adds the user specified bottom. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
517 |
* |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26900
diff
changeset
|
518 |
* @param htmlTree the content tree to which user specified bottom will be added |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
519 |
*/ |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26900
diff
changeset
|
520 |
public void addBottom(Content htmlTree) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
521 |
Content bottom = new RawHtml(replaceDocRootDir(configuration.bottom)); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
522 |
Content small = HtmlTree.SMALL(bottom); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
523 |
Content p = HtmlTree.P(HtmlStyle.legalCopy, small); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
524 |
htmlTree.add(p); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
525 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
526 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
527 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
528 |
* Get the overview tree link for the main tree. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
529 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
530 |
* @param label the label for the link |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
531 |
* @return a content tree for the link |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
532 |
*/ |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
533 |
protected Content getNavLinkMainTree(String label) { |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48295
diff
changeset
|
534 |
Content mainTreeContent = links.createLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE), |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
535 |
new StringContent(label)); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
536 |
Content li = HtmlTree.LI(mainTreeContent); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
537 |
return li; |
10 | 538 |
} |
539 |
||
540 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
541 |
* Get table caption. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
542 |
* |
47427 | 543 |
* @param title the content for the caption |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
544 |
* @return a content tree for the caption |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
545 |
*/ |
17570
78512b2899db
8012183: replace some uses of Configuration.getText with Configuration.getResource
jjg
parents:
17569
diff
changeset
|
546 |
public Content getTableCaption(Content title) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
547 |
Content captionSpan = HtmlTree.SPAN(title); |
54610 | 548 |
Content space = Entity.NO_BREAK_SPACE; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
549 |
Content tabSpan = HtmlTree.SPAN(HtmlStyle.tabEnd, space); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
550 |
Content caption = HtmlTree.CAPTION(captionSpan); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
551 |
caption.add(tabSpan); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
552 |
return caption; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
553 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
554 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
555 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
556 |
* Returns a packagename content. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
557 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
558 |
* @param packageElement the package to check |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
559 |
* @return package name content |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
560 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
561 |
public Content getPackageName(PackageElement packageElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
562 |
return packageElement == null || packageElement.isUnnamed() |
40303 | 563 |
? contents.defaultPackageLabel |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
564 |
: getPackageLabel(packageElement.getQualifiedName()); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
565 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
566 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
567 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
568 |
* Returns a package name label. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
569 |
* |
14259 | 570 |
* @param packageName the package name |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
571 |
* @return the package name content |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
572 |
*/ |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
573 |
public Content getPackageLabel(CharSequence packageName) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
574 |
return new StringContent(packageName); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
575 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
576 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
577 |
/** |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
578 |
* Return the path to the class page for a typeElement. |
10 | 579 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
580 |
* @param te TypeElement for which the path is requested. |
10 | 581 |
* @param name Name of the file(doesn't include path). |
582 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
583 |
protected DocPath pathString(TypeElement te, DocPath name) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
584 |
return pathString(utils.containingPackage(te), name); |
10 | 585 |
} |
586 |
||
587 |
/** |
|
588 |
* Return path to the given file name in the given package. So if the name |
|
589 |
* passed is "Object.html" and the name of the package is "java.lang", and |
|
590 |
* if the relative path is "../.." then returned string will be |
|
591 |
* "../../java/lang/Object.html" |
|
592 |
* |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
593 |
* @param packageElement Package in which the file name is assumed to be. |
10 | 594 |
* @param name File name, to which path string is. |
595 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
596 |
protected DocPath pathString(PackageElement packageElement, DocPath name) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
597 |
return pathToRoot.resolve(docPaths.forPackage(packageElement).resolve(name)); |
10 | 598 |
} |
599 |
||
600 |
/** |
|
26900
dccc7a72526d
8048351: tidy errors for attribute href, name for langtools javadoc tests needs investigation
bpatel
parents:
26665
diff
changeset
|
601 |
* Given a package, return the name to be used in HTML anchor tag. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
602 |
* @param packageElement the package. |
26900
dccc7a72526d
8048351: tidy errors for attribute href, name for langtools javadoc tests needs investigation
bpatel
parents:
26665
diff
changeset
|
603 |
* @return the name to be used in HTML anchor tag. |
dccc7a72526d
8048351: tidy errors for attribute href, name for langtools javadoc tests needs investigation
bpatel
parents:
26665
diff
changeset
|
604 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
605 |
public String getPackageAnchorName(PackageElement packageElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
606 |
return packageElement == null || packageElement.isUnnamed() |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
607 |
? SectionName.UNNAMED_PACKAGE_ANCHOR.getName() |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
608 |
: utils.getPackageName(packageElement); |
26900
dccc7a72526d
8048351: tidy errors for attribute href, name for langtools javadoc tests needs investigation
bpatel
parents:
26665
diff
changeset
|
609 |
} |
dccc7a72526d
8048351: tidy errors for attribute href, name for langtools javadoc tests needs investigation
bpatel
parents:
26665
diff
changeset
|
610 |
|
dccc7a72526d
8048351: tidy errors for attribute href, name for langtools javadoc tests needs investigation
bpatel
parents:
26665
diff
changeset
|
611 |
/** |
10 | 612 |
* Return the link to the given package. |
613 |
* |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
614 |
* @param packageElement the package to link to. |
10 | 615 |
* @param label the label for the link. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
616 |
* @return a content tree for the package link. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
617 |
*/ |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
618 |
public Content getPackageLink(PackageElement packageElement, CharSequence label) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
619 |
return getPackageLink(packageElement, new StringContent(label)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
620 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
621 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
622 |
public Content getPackageLink(PackageElement packageElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
623 |
StringContent content = packageElement.isUnnamed() |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
624 |
? new StringContent() |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
625 |
: new StringContent(utils.getPackageName(packageElement)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
626 |
return getPackageLink(packageElement, content); |
17563
e8ddeb9bd17c
8011668: Allow HTMLWriter.getResource to take Content args
jjg
parents:
17561
diff
changeset
|
627 |
} |
e8ddeb9bd17c
8011668: Allow HTMLWriter.getResource to take Content args
jjg
parents:
17561
diff
changeset
|
628 |
|
e8ddeb9bd17c
8011668: Allow HTMLWriter.getResource to take Content args
jjg
parents:
17561
diff
changeset
|
629 |
/** |
e8ddeb9bd17c
8011668: Allow HTMLWriter.getResource to take Content args
jjg
parents:
17561
diff
changeset
|
630 |
* Return the link to the given package. |
e8ddeb9bd17c
8011668: Allow HTMLWriter.getResource to take Content args
jjg
parents:
17561
diff
changeset
|
631 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
632 |
* @param packageElement the package to link to. |
17563
e8ddeb9bd17c
8011668: Allow HTMLWriter.getResource to take Content args
jjg
parents:
17561
diff
changeset
|
633 |
* @param label the label for the link. |
e8ddeb9bd17c
8011668: Allow HTMLWriter.getResource to take Content args
jjg
parents:
17561
diff
changeset
|
634 |
* @return a content tree for the package link. |
e8ddeb9bd17c
8011668: Allow HTMLWriter.getResource to take Content args
jjg
parents:
17561
diff
changeset
|
635 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
636 |
public Content getPackageLink(PackageElement packageElement, Content label) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
637 |
boolean included = packageElement != null && utils.isIncluded(packageElement); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
638 |
if (!included) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
639 |
for (PackageElement p : configuration.packages) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
640 |
if (p.equals(packageElement)) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
641 |
included = true; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
642 |
break; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
643 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
644 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
645 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
646 |
if (included || packageElement == null) { |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48295
diff
changeset
|
647 |
return links.createLink(pathString(packageElement, DocPaths.PACKAGE_SUMMARY), |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
648 |
label); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
649 |
} else { |
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
650 |
DocLink crossPkgLink = getCrossPackageLink(packageElement); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
651 |
if (crossPkgLink != null) { |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48295
diff
changeset
|
652 |
return links.createLink(crossPkgLink, label); |
10 | 653 |
} else { |
654 |
return label; |
|
655 |
} |
|
656 |
} |
|
657 |
} |
|
658 |
||
36526 | 659 |
/** |
660 |
* Get Module link. |
|
661 |
* |
|
662 |
* @param mdle the module being documented |
|
663 |
* @param label tag for the link |
|
664 |
* @return a content for the module link |
|
665 |
*/ |
|
666 |
public Content getModuleLink(ModuleElement mdle, Content label) { |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
667 |
boolean included = utils.isIncluded(mdle); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
668 |
return (included) |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
669 |
? links.createLink(pathToRoot.resolve(docPaths.moduleSummary(mdle)), label, "", "") |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
670 |
: label; |
36526 | 671 |
} |
672 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
673 |
public Content interfaceName(TypeElement typeElement, boolean qual) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
674 |
Content name = new StringContent((qual) |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
675 |
? typeElement.getQualifiedName() |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
676 |
: utils.getSimpleName(typeElement)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
677 |
return (utils.isInterface(typeElement)) ? HtmlTree.SPAN(HtmlStyle.interfaceName, name) : name; |
10 | 678 |
} |
679 |
||
680 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
681 |
* Add the link to the content tree. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
682 |
* |
50249
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
683 |
* @param element program element for which the link will be added |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
684 |
* @param label label for the link |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
685 |
* @param htmltree the content tree to which the link will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
686 |
*/ |
50249
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
687 |
public void addSrcLink(Element element, Content label, Content htmltree) { |
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
688 |
if (element == null) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
689 |
return; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
690 |
} |
50249
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
691 |
TypeElement te = utils.getEnclosingTypeElement(element); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
692 |
if (te == null) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
693 |
// must be a typeElement since in has no containing class. |
50249
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
694 |
te = (TypeElement) element; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
695 |
} |
50249
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
696 |
if (utils.isIncluded(te)) { |
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
697 |
DocPath href = pathToRoot |
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
698 |
.resolve(DocPaths.SOURCE_OUTPUT) |
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
699 |
.resolve(docPaths.forClass(te)); |
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
700 |
Content content = links.createLink(href |
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
701 |
.fragment(SourceToHTMLConverter.getAnchorName(utils, element)), label, "", ""); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
702 |
htmltree.add(content); |
50249
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
703 |
} else { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
704 |
htmltree.add(label); |
50249
5715962c8831
8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
pmuthuswamy
parents:
50240
diff
changeset
|
705 |
} |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
706 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
707 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
708 |
/** |
10 | 709 |
* Return the link to the given class. |
710 |
* |
|
711 |
* @param linkInfo the information about the link. |
|
712 |
* |
|
713 |
* @return the link for the given class. |
|
714 |
*/ |
|
17559
87c28ee29329
8011642: Remove LinkOutput in favor of direct use of Content
jjg
parents:
17558
diff
changeset
|
715 |
public Content getLink(LinkInfoImpl linkInfo) { |
10 | 716 |
LinkFactoryImpl factory = new LinkFactoryImpl(this); |
17564
c329fe11193d
8011288: Erratic/inconsistent indentation of signatures
jjg
parents:
17563
diff
changeset
|
717 |
return factory.getLink(linkInfo); |
10 | 718 |
} |
719 |
||
720 |
/** |
|
721 |
* Return the type parameters for the given class. |
|
722 |
* |
|
723 |
* @param linkInfo the information about the link. |
|
724 |
* @return the type for the given class. |
|
725 |
*/ |
|
17559
87c28ee29329
8011642: Remove LinkOutput in favor of direct use of Content
jjg
parents:
17558
diff
changeset
|
726 |
public Content getTypeParameterLinks(LinkInfoImpl linkInfo) { |
10 | 727 |
LinkFactoryImpl factory = new LinkFactoryImpl(this); |
17559
87c28ee29329
8011642: Remove LinkOutput in favor of direct use of Content
jjg
parents:
17558
diff
changeset
|
728 |
return factory.getTypeParameterLinks(linkInfo, false); |
10 | 729 |
} |
730 |
||
731 |
/************************************************************* |
|
732 |
* Return a class cross link to external class documentation. |
|
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
733 |
* The -link option does not allow users to |
10 | 734 |
* link to external classes in the "default" package. |
735 |
* |
|
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
736 |
* @param classElement the class element |
10 | 737 |
* @param refMemName the name of the member being referenced. This should |
738 |
* be null or empty string if no member is being referenced. |
|
739 |
* @param label the label for the external link. |
|
1787
1aa079321cd2
6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents:
1264
diff
changeset
|
740 |
* @param strong true if the link should be strong. |
10 | 741 |
* @param code true if the label should be code font. |
47851
6a9bb4f77d50
8190822: Remove dead code that could lead to invalid HTML
jjg
parents:
47850
diff
changeset
|
742 |
* @return the link |
10 | 743 |
*/ |
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
744 |
public Content getCrossClassLink(TypeElement classElement, String refMemName, |
47851
6a9bb4f77d50
8190822: Remove dead code that could lead to invalid HTML
jjg
parents:
47850
diff
changeset
|
745 |
Content label, boolean strong, boolean code) { |
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
746 |
if (classElement != null) { |
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
747 |
String className = utils.getSimpleName(classElement); |
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
748 |
PackageElement packageElement = utils.containingPackage(classElement); |
17560 | 749 |
Content defaultLabel = new StringContent(className); |
750 |
if (code) |
|
751 |
defaultLabel = HtmlTree.CODE(defaultLabel); |
|
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
752 |
if (getCrossPackageLink(packageElement) != null) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
753 |
/* |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
754 |
The package exists in external documentation, so link to the external |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
755 |
class (assuming that it exists). This is definitely a limitation of |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
756 |
the -link option. There are ways to determine if an external package |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
757 |
exists, but no way to determine if the external class exists. We just |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
758 |
have to assume that it does. |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
759 |
*/ |
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
760 |
DocLink link = configuration.extern.getExternalLink(packageElement, pathToRoot, |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
761 |
className + ".html", refMemName); |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48295
diff
changeset
|
762 |
return links.createLink(link, |
17560 | 763 |
(label == null) || label.isEmpty() ? defaultLabel : label, |
47851
6a9bb4f77d50
8190822: Remove dead code that could lead to invalid HTML
jjg
parents:
47850
diff
changeset
|
764 |
strong, |
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
765 |
resources.getText("doclet.Href_Class_Or_Interface_Title", |
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
766 |
utils.getPackageName(packageElement)), "", true); |
10 | 767 |
} |
768 |
} |
|
769 |
return null; |
|
770 |
} |
|
771 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
772 |
public boolean isClassLinkable(TypeElement typeElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
773 |
if (utils.isIncluded(typeElement)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
774 |
return configuration.isGeneratedDoc(typeElement); |
10 | 775 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
776 |
return configuration.extern.isExternal(typeElement); |
10 | 777 |
} |
778 |
||
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
779 |
public DocLink getCrossPackageLink(PackageElement element) { |
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
780 |
return configuration.extern.getExternalLink(element, pathToRoot, |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
781 |
DocPaths.PACKAGE_SUMMARY.getPath()); |
10 | 782 |
} |
783 |
||
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
784 |
public DocLink getCrossModuleLink(ModuleElement element) { |
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
785 |
return configuration.extern.getExternalLink(element, pathToRoot, |
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
786 |
docPaths.moduleSummary(utils.getModuleName(element)).getPath()); |
48295
c79d31ba84b9
8164407: Add module support for -link and -linkoffline javadoc option
bpatel
parents:
48029
diff
changeset
|
787 |
} |
c79d31ba84b9
8164407: Add module support for -link and -linkoffline javadoc option
bpatel
parents:
48029
diff
changeset
|
788 |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
789 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
790 |
* Get the class link. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
791 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
792 |
* @param context the id of the context where the link will be added |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
793 |
* @param element to link to |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
794 |
* @return a content tree for the link |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
795 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
796 |
public Content getQualifiedClassLink(LinkInfoImpl.Kind context, Element element) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
797 |
LinkInfoImpl linkInfoImpl = new LinkInfoImpl(configuration, context, (TypeElement)element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
798 |
return getLink(linkInfoImpl.label(utils.getFullyQualifiedName(element))); |
10 | 799 |
} |
800 |
||
801 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
802 |
* Add the class link. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
803 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
804 |
* @param context the id of the context where the link will be added |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
805 |
* @param typeElement to link to |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
806 |
* @param contentTree the content tree to which the link will be added |
10 | 807 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
808 |
public void addPreQualifiedClassLink(LinkInfoImpl.Kind context, TypeElement typeElement, Content contentTree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
809 |
addPreQualifiedClassLink(context, typeElement, false, contentTree); |
10 | 810 |
} |
811 |
||
812 |
/** |
|
813 |
* Retrieve the class link with the package portion of the label in |
|
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
814 |
* plain text. If the qualifier is excluded, it will not be included in the |
10 | 815 |
* link label. |
816 |
* |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
817 |
* @param typeElement the class to link to. |
1787
1aa079321cd2
6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents:
1264
diff
changeset
|
818 |
* @param isStrong true if the link should be strong. |
10 | 819 |
* @return the link with the package portion of the label in plain text. |
820 |
*/ |
|
17560 | 821 |
public Content getPreQualifiedClassLink(LinkInfoImpl.Kind context, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
822 |
TypeElement typeElement, boolean isStrong) { |
17560 | 823 |
ContentBuilder classlink = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
824 |
PackageElement pkg = utils.containingPackage(typeElement); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
825 |
if (pkg != null && ! configuration.shouldExcludeQualifier(pkg.getSimpleName().toString())) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
826 |
classlink.add(getEnclosingPackageName(typeElement)); |
10 | 827 |
} |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
828 |
classlink.add(getLink(new LinkInfoImpl(configuration, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
829 |
context, typeElement).label(utils.getSimpleName(typeElement)).strong(isStrong))); |
10 | 830 |
return classlink; |
831 |
} |
|
832 |
||
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
833 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
834 |
* Add the class link with the package portion of the label in |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
835 |
* plain text. If the qualifier is excluded, it will not be included in the |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
836 |
* link label. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
837 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
838 |
* @param context the id of the context where the link will be added |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
839 |
* @param typeElement the class to link to |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
840 |
* @param isStrong true if the link should be strong |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
841 |
* @param contentTree the content tree to which the link with be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
842 |
*/ |
17558
eee4ccf66cfd
8010440: Replace int constants in LinkInfoImpl with enum
jjg
parents:
17547
diff
changeset
|
843 |
public void addPreQualifiedClassLink(LinkInfoImpl.Kind context, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
844 |
TypeElement typeElement, boolean isStrong, Content contentTree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
845 |
PackageElement pkg = utils.containingPackage(typeElement); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
846 |
if(pkg != null && ! configuration.shouldExcludeQualifier(pkg.getSimpleName().toString())) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
847 |
contentTree.add(getEnclosingPackageName(typeElement)); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
848 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
849 |
LinkInfoImpl linkinfo = new LinkInfoImpl(configuration, context, typeElement) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
850 |
.label(utils.getSimpleName(typeElement)) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
851 |
.strong(isStrong); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
852 |
Content link = getLink(linkinfo); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
853 |
contentTree.add(link); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
854 |
} |
10 | 855 |
|
856 |
/** |
|
47852 | 857 |
* Get the enclosed name of the package |
858 |
* |
|
859 |
* @param te TypeElement |
|
860 |
* @return the name |
|
861 |
*/ |
|
862 |
public String getEnclosingPackageName(TypeElement te) { |
|
863 |
||
864 |
PackageElement encl = configuration.utils.containingPackage(te); |
|
865 |
return (encl.isUnnamed()) ? "" : (encl.getQualifiedName() + "."); |
|
866 |
} |
|
867 |
||
868 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
869 |
* Add the class link, with only class name as the strong link and prefixing |
10 | 870 |
* plain package name. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
871 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
872 |
* @param context the id of the context where the link will be added |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
873 |
* @param typeElement the class to link to |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
874 |
* @param contentTree the content tree to which the link with be added |
10 | 875 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
876 |
public void addPreQualifiedStrongClassLink(LinkInfoImpl.Kind context, TypeElement typeElement, Content contentTree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
877 |
addPreQualifiedClassLink(context, typeElement, true, contentTree); |
10 | 878 |
} |
879 |
||
880 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
881 |
* Get the link for the given member. |
10 | 882 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
883 |
* @param context the id of the context where the link will be added |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
884 |
* @param element the member being linked to |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
885 |
* @param label the label for the link |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
886 |
* @return a content tree for the element link |
10 | 887 |
*/ |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
888 |
public Content getDocLink(LinkInfoImpl.Kind context, Element element, CharSequence label) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
889 |
return getDocLink(context, utils.getEnclosingTypeElement(element), element, |
17560 | 890 |
new StringContent(label)); |
10 | 891 |
} |
892 |
||
893 |
/** |
|
894 |
* Return the link for the given member. |
|
895 |
* |
|
896 |
* @param context the id of the context where the link will be printed. |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
897 |
* @param element the member being linked to. |
10 | 898 |
* @param label the label for the link. |
1787
1aa079321cd2
6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents:
1264
diff
changeset
|
899 |
* @param strong true if the link should be strong. |
10 | 900 |
* @return the link for the given member. |
901 |
*/ |
|
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
902 |
public Content getDocLink(LinkInfoImpl.Kind context, Element element, CharSequence label, |
17559
87c28ee29329
8011642: Remove LinkOutput in favor of direct use of Content
jjg
parents:
17558
diff
changeset
|
903 |
boolean strong) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
904 |
return getDocLink(context, utils.getEnclosingTypeElement(element), element, label, strong); |
10 | 905 |
} |
906 |
||
907 |
/** |
|
908 |
* Return the link for the given member. |
|
909 |
* |
|
910 |
* @param context the id of the context where the link will be printed. |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
911 |
* @param typeElement the typeElement that we should link to. This is not |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
912 |
necessarily equal to element.containingClass(). We may be |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
913 |
inheriting comments. |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
914 |
* @param element the member being linked to. |
10 | 915 |
* @param label the label for the link. |
1787
1aa079321cd2
6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents:
1264
diff
changeset
|
916 |
* @param strong true if the link should be strong. |
10 | 917 |
* @return the link for the given member. |
918 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
919 |
public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element, |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
920 |
CharSequence label, boolean strong) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
921 |
return getDocLink(context, typeElement, element, label, strong, false); |
16319
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
922 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
923 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
924 |
public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element, |
17569 | 925 |
Content label, boolean strong) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
926 |
return getDocLink(context, typeElement, element, label, strong, false); |
17569 | 927 |
} |
16319
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
928 |
|
51190
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
929 |
/** |
16319
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
930 |
* Return the link for the given member. |
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
931 |
* |
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
932 |
* @param context the id of the context where the link will be printed. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
933 |
* @param typeElement the typeElement that we should link to. This is not |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
934 |
necessarily equal to element.containingClass(). We may be |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
935 |
inheriting comments. |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
936 |
* @param element the member being linked to. |
16319
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
937 |
* @param label the label for the link. |
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
938 |
* @param strong true if the link should be strong. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
939 |
* @param isProperty true if the element parameter is a JavaFX property. |
16319
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
940 |
* @return the link for the given member. |
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
941 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
942 |
public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element, |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
943 |
CharSequence label, boolean strong, boolean isProperty) { |
50612
e10812a82a3b
8204330: Javadoc IllegalArgumentException: HTML special chars in constant value
jjg
parents:
50249
diff
changeset
|
944 |
return getDocLink(context, typeElement, element, new StringContent(label), strong, isProperty); |
17560 | 945 |
} |
946 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
947 |
public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element, |
17560 | 948 |
Content label, boolean strong, boolean isProperty) { |
51190
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
949 |
if (!utils.isLinkable(typeElement, element)) { |
17560 | 950 |
return label; |
51190
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
951 |
} |
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
952 |
|
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
953 |
if (utils.isExecutableElement(element)) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
954 |
ExecutableElement ee = (ExecutableElement)element; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
955 |
return getLink(new LinkInfoImpl(configuration, context, typeElement) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
956 |
.label(label) |
47850 | 957 |
.where(links.getName(getAnchor(ee, isProperty))) |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
958 |
.strong(strong)); |
51190
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
959 |
} |
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
960 |
|
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
961 |
if (utils.isVariableElement(element) || utils.isTypeElement(element)) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
962 |
return getLink(new LinkInfoImpl(configuration, context, typeElement) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
963 |
.label(label) |
47850 | 964 |
.where(links.getName(element.getSimpleName().toString())) |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
965 |
.strong(strong)); |
10 | 966 |
} |
51190
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
967 |
|
fb4a7b894fac
8207214: Broken links in JDK API serialized-form page
jjg
parents:
50612
diff
changeset
|
968 |
return label; |
10 | 969 |
} |
970 |
||
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
971 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
972 |
* Return the link for the given member. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
973 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
974 |
* @param context the id of the context where the link will be added |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
975 |
* @param typeElement the typeElement that we should link to. This is not |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
976 |
necessarily equal to element.containingClass(). We may be |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
977 |
inheriting comments |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
978 |
* @param element the member being linked to |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
979 |
* @param label the label for the link |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
980 |
* @return the link for the given member |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
981 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
982 |
public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element, |
17560 | 983 |
Content label) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
984 |
if (! (utils.isIncluded(element) || utils.isLinkable(typeElement))) { |
17560 | 985 |
return label; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
986 |
} else if (utils.isExecutableElement(element)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
987 |
ExecutableElement emd = (ExecutableElement) element; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
988 |
return getLink(new LinkInfoImpl(configuration, context, typeElement) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
989 |
.label(label) |
47850 | 990 |
.where(links.getName(getAnchor(emd)))); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
991 |
} else if (utils.isVariableElement(element) || utils.isTypeElement(element)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
992 |
return getLink(new LinkInfoImpl(configuration, context, typeElement) |
47850 | 993 |
.label(label).where(links.getName(element.getSimpleName().toString()))); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
994 |
} else { |
17560 | 995 |
return label; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
996 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
997 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
998 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
999 |
public String getAnchor(ExecutableElement executableElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1000 |
return getAnchor(executableElement, false); |
16319
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
1001 |
} |
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
1002 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1003 |
public String getAnchor(ExecutableElement executableElement, boolean isProperty) { |
16319
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
1004 |
if (isProperty) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1005 |
return executableElement.getSimpleName().toString(); |
16319
e586bfeb39c5
7112427: The doclet needs to be able to generate JavaFX documentation.
jjg
parents:
15725
diff
changeset
|
1006 |
} |
47328
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1007 |
String member = anchorName(executableElement); |
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1008 |
String erasedSignature = utils.makeSignature(executableElement, true, true); |
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1009 |
return member + erasedSignature; |
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1010 |
} |
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1011 |
|
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1012 |
public String anchorName(Element member) { |
53562 | 1013 |
if (member.getKind() == ElementKind.CONSTRUCTOR) { |
47328
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1014 |
return "<init>"; |
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1015 |
} else { |
d18df41954ba
8187521: In some corner cases the javadoc tool can reuse id attribute
jjg
parents:
47300
diff
changeset
|
1016 |
return utils.getSimpleName(member); |
10 | 1017 |
} |
1018 |
} |
|
1019 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1020 |
public Content seeTagToContent(Element element, DocTree see) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1021 |
Kind kind = see.getKind(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1022 |
if (!(kind == LINK || kind == SEE || kind == LINK_PLAIN)) { |
17568
d9691936f5f9
8012177: HTMLDocletWriter methods should generate Content, not Strings
jjg
parents:
17567
diff
changeset
|
1023 |
return new ContentBuilder(); |
10 | 1024 |
} |
14266
69453558960d
8000673: remove dead code from HtmlWriter and subtypes
jjg
parents:
14265
diff
changeset
|
1025 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1026 |
CommentHelper ch = utils.getCommentHelper(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1027 |
String tagName = ch.getTagName(see); |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
1028 |
String seetext = replaceDocRootDir(utils.normalizeNewlines(ch.getText(see)).toString()); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1029 |
// Check if @see is an href or "string" |
10 | 1030 |
if (seetext.startsWith("<") || seetext.startsWith("\"")) { |
17568
d9691936f5f9
8012177: HTMLDocletWriter methods should generate Content, not Strings
jjg
parents:
17567
diff
changeset
|
1031 |
return new RawHtml(seetext); |
10 | 1032 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1033 |
boolean isLinkPlain = kind == LINK_PLAIN; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1034 |
Content label = plainOrCode(isLinkPlain, new RawHtml(ch.getLabel(configuration, see))); |
14266
69453558960d
8000673: remove dead code from HtmlWriter and subtypes
jjg
parents:
14265
diff
changeset
|
1035 |
|
10 | 1036 |
//The text from the @see tag. We will output this text when a label is not specified. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1037 |
Content text = plainOrCode(kind == LINK_PLAIN, new RawHtml(seetext)); |
10 | 1038 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1039 |
TypeElement refClass = ch.getReferencedClass(configuration, see); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1040 |
String refClassName = ch.getReferencedClassName(configuration, see); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1041 |
Element refMem = ch.getReferencedMember(configuration, see); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1042 |
String refMemName = ch.getReferencedMemberName(see); |
14266
69453558960d
8000673: remove dead code from HtmlWriter and subtypes
jjg
parents:
14265
diff
changeset
|
1043 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1044 |
if (refMemName == null && refMem != null) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1045 |
refMemName = refMem.toString(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1046 |
} |
10 | 1047 |
if (refClass == null) { |
1048 |
//@see is not referencing an included class |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1049 |
PackageElement refPackage = ch.getReferencedPackage(configuration, see); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1050 |
if (refPackage != null && utils.isIncluded(refPackage)) { |
10 | 1051 |
//@see is referencing an included package |
14266
69453558960d
8000673: remove dead code from HtmlWriter and subtypes
jjg
parents:
14265
diff
changeset
|
1052 |
if (label.isEmpty()) |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1053 |
label = plainOrCode(isLinkPlain, |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
1054 |
new StringContent(refPackage.getQualifiedName())); |
17568
d9691936f5f9
8012177: HTMLDocletWriter methods should generate Content, not Strings
jjg
parents:
17567
diff
changeset
|
1055 |
return getPackageLink(refPackage, label); |
10 | 1056 |
} else { |
48295
c79d31ba84b9
8164407: Add module support for -link and -linkoffline javadoc option
bpatel
parents:
48029
diff
changeset
|
1057 |
// @see is not referencing an included class, module or package. Check for cross links. |
c79d31ba84b9
8164407: Add module support for -link and -linkoffline javadoc option
bpatel
parents:
48029
diff
changeset
|
1058 |
DocLink elementCrossLink = (configuration.extern.isModule(refClassName)) |
51861
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
1059 |
? getCrossModuleLink(utils.elementUtils.getModuleElement(refClassName)) : |
f7d40158eb2f
8205593: Javadoc -link makes broken links if module name matches package name
pmuthuswamy
parents:
51797
diff
changeset
|
1060 |
(refPackage != null) ? getCrossPackageLink(refPackage) : null; |
48295
c79d31ba84b9
8164407: Add module support for -link and -linkoffline javadoc option
bpatel
parents:
48029
diff
changeset
|
1061 |
if (elementCrossLink != null) { |
c79d31ba84b9
8164407: Add module support for -link and -linkoffline javadoc option
bpatel
parents:
48029
diff
changeset
|
1062 |
// Element cross link found |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48295
diff
changeset
|
1063 |
return links.createLink(elementCrossLink, |
48295
c79d31ba84b9
8164407: Add module support for -link and -linkoffline javadoc option
bpatel
parents:
48029
diff
changeset
|
1064 |
(label.isEmpty() ? text : label), true); |
10 | 1065 |
} else { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1066 |
// No cross link found so print warning |
40303 | 1067 |
messages.warning(ch.getDocTreePath(see), |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1068 |
"doclet.see.class_or_package_not_found", |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1069 |
"@" + tagName, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1070 |
seetext); |
17568
d9691936f5f9
8012177: HTMLDocletWriter methods should generate Content, not Strings
jjg
parents:
17567
diff
changeset
|
1071 |
return (label.isEmpty() ? text: label); |
10 | 1072 |
} |
1073 |
} |
|
1074 |
} else if (refMemName == null) { |
|
1075 |
// Must be a class reference since refClass is not null and refMemName is null. |
|
14266
69453558960d
8000673: remove dead code from HtmlWriter and subtypes
jjg
parents:
14265
diff
changeset
|
1076 |
if (label.isEmpty()) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1077 |
/* |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1078 |
* it seems to me this is the right thing to do, but it causes comparator failures. |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1079 |
*/ |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1080 |
if (!configuration.backwardCompatibility) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1081 |
StringContent content = utils.isEnclosingPackageIncluded(refClass) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1082 |
? new StringContent(utils.getSimpleName(refClass)) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1083 |
: new StringContent(utils.getFullyQualifiedName(refClass)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1084 |
label = plainOrCode(isLinkPlain, content); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1085 |
} else { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1086 |
label = plainOrCode(isLinkPlain, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1087 |
new StringContent(utils.getSimpleName(refClass))); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1088 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1089 |
|
10 | 1090 |
} |
17561 | 1091 |
return getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.DEFAULT, refClass) |
17568
d9691936f5f9
8012177: HTMLDocletWriter methods should generate Content, not Strings
jjg
parents:
17567
diff
changeset
|
1092 |
.label(label)); |
10 | 1093 |
} else if (refMem == null) { |
1094 |
// Must be a member reference since refClass is not null and refMemName is not null. |
|
1095 |
// However, refMem is null, so this referenced member does not exist. |
|
17568
d9691936f5f9
8012177: HTMLDocletWriter methods should generate Content, not Strings
jjg
parents:
17567
diff
changeset
|
1096 |
return (label.isEmpty() ? text: label); |
10 | 1097 |
} else { |
1098 |
// Must be a member reference since refClass is not null and refMemName is not null. |
|
1099 |
// refMem is not null, so this @see tag must be referencing a valid member. |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1100 |
TypeElement containing = utils.getEnclosingTypeElement(refMem); |
47395
2ea4edfdef8e
8157000: Do not generate javadoc for overridden method with no spec change
ksrini
parents:
47328
diff
changeset
|
1101 |
|
2ea4edfdef8e
8157000: Do not generate javadoc for overridden method with no spec change
ksrini
parents:
47328
diff
changeset
|
1102 |
// Find the enclosing type where the method is actually visible |
2ea4edfdef8e
8157000: Do not generate javadoc for overridden method with no spec change
ksrini
parents:
47328
diff
changeset
|
1103 |
// in the inheritance hierarchy. |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1104 |
ExecutableElement overriddenMethod = null; |
47395
2ea4edfdef8e
8157000: Do not generate javadoc for overridden method with no spec change
ksrini
parents:
47328
diff
changeset
|
1105 |
if (refMem.getKind() == ElementKind.METHOD) { |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1106 |
VisibleMemberTable vmt = configuration.getVisibleMemberTable(containing); |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1107 |
overriddenMethod = vmt.getOverriddenMethod((ExecutableElement)refMem); |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1108 |
|
47395
2ea4edfdef8e
8157000: Do not generate javadoc for overridden method with no spec change
ksrini
parents:
47328
diff
changeset
|
1109 |
if (overriddenMethod != null) |
2ea4edfdef8e
8157000: Do not generate javadoc for overridden method with no spec change
ksrini
parents:
47328
diff
changeset
|
1110 |
containing = utils.getEnclosingTypeElement(overriddenMethod); |
2ea4edfdef8e
8157000: Do not generate javadoc for overridden method with no spec change
ksrini
parents:
47328
diff
changeset
|
1111 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1112 |
if (ch.getText(see).trim().startsWith("#") && |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1113 |
! (utils.isPublic(containing) || utils.isLinkable(containing))) { |
10 | 1114 |
// Since the link is relative and the holder is not even being |
1115 |
// documented, this must be an inherited link. Redirect it. |
|
1116 |
// The current class either overrides the referenced member or |
|
1117 |
// inherits it automatically. |
|
3891
69ac41cb327b
5093723: REGRESSION: ClassCastException in SingleIndexWriter
jjg
parents:
2321
diff
changeset
|
1118 |
if (this instanceof ClassWriterImpl) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1119 |
containing = ((ClassWriterImpl) this).getTypeElement(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1120 |
} else if (!utils.isPublic(containing)) { |
40303 | 1121 |
messages.warning( |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1122 |
ch.getDocTreePath(see), "doclet.see.class_or_package_not_accessible", |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1123 |
tagName, utils.getFullyQualifiedName(containing)); |
3891
69ac41cb327b
5093723: REGRESSION: ClassCastException in SingleIndexWriter
jjg
parents:
2321
diff
changeset
|
1124 |
} else { |
40303 | 1125 |
messages.warning( |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1126 |
ch.getDocTreePath(see), "doclet.see.class_or_package_not_found", |
3891
69ac41cb327b
5093723: REGRESSION: ClassCastException in SingleIndexWriter
jjg
parents:
2321
diff
changeset
|
1127 |
tagName, seetext); |
69ac41cb327b
5093723: REGRESSION: ClassCastException in SingleIndexWriter
jjg
parents:
2321
diff
changeset
|
1128 |
} |
10 | 1129 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1130 |
if (configuration.currentTypeElement != containing) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1131 |
refMemName = (utils.isConstructor(refMem)) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1132 |
? refMemName |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1133 |
: utils.getSimpleName(containing) + "." + refMemName; |
10 | 1134 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1135 |
if (utils.isExecutableElement(refMem)) { |
10 | 1136 |
if (refMemName.indexOf('(') < 0) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1137 |
refMemName += utils.makeSignature((ExecutableElement)refMem, true); |
10 | 1138 |
} |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1139 |
if (overriddenMethod != null) { |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1140 |
// The method to actually link. |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1141 |
refMem = overriddenMethod; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1142 |
} |
10 | 1143 |
} |
14266
69453558960d
8000673: remove dead code from HtmlWriter and subtypes
jjg
parents:
14265
diff
changeset
|
1144 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1145 |
text = plainOrCode(kind == LINK_PLAIN, new StringContent(refMemName)); |
10 | 1146 |
|
17558
eee4ccf66cfd
8010440: Replace int constants in LinkInfoImpl with enum
jjg
parents:
17547
diff
changeset
|
1147 |
return getDocLink(LinkInfoImpl.Kind.SEE_TAG, containing, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1148 |
refMem, (label.isEmpty() ? text: label), false); |
10 | 1149 |
} |
1150 |
} |
|
1151 |
||
17560 | 1152 |
private Content plainOrCode(boolean plain, Content body) { |
1153 |
return (plain || body.isEmpty()) ? body : HtmlTree.CODE(body); |
|
1154 |
} |
|
1155 |
||
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1156 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1157 |
* Add the inline comment. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1158 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1159 |
* @param element the Element for which the inline comment will be added |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1160 |
* @param tag the inline tag to be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1161 |
* @param htmltree the content tree to which the comment will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1162 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1163 |
public void addInlineComment(Element element, DocTree tag, Content htmltree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1164 |
CommentHelper ch = utils.getCommentHelper(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1165 |
List<? extends DocTree> description = ch.getDescription(configuration, tag); |
51862 | 1166 |
addCommentTags(element, tag, description, false, false, false, htmltree); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1167 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1168 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1169 |
/** |
42816
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1170 |
* Get the deprecated phrase as content. |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1171 |
* |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1172 |
* @param e the Element for which the inline deprecated comment will be added |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1173 |
* @return a content tree for the deprecated phrase. |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1174 |
*/ |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1175 |
public Content getDeprecatedPhrase(Element e) { |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1176 |
return (utils.isDeprecatedForRemoval(e)) |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1177 |
? contents.deprecatedForRemovalPhrase |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1178 |
: contents.deprecatedPhrase; |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1179 |
} |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1180 |
|
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42408
diff
changeset
|
1181 |
/** |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1182 |
* Add the inline deprecated comment. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1183 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1184 |
* @param e the Element for which the inline deprecated comment will be added |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1185 |
* @param tag the inline tag to be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1186 |
* @param htmltree the content tree to which the comment will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1187 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1188 |
public void addInlineDeprecatedComment(Element e, DocTree tag, Content htmltree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1189 |
CommentHelper ch = utils.getCommentHelper(e); |
51862 | 1190 |
addCommentTags(e, ch.getBody(configuration, tag), true, false, false, htmltree); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1191 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1192 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1193 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1194 |
* Adds the summary content. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1195 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1196 |
* @param element the Element for which the summary will be generated |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1197 |
* @param htmltree the documentation tree to which the summary will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1198 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1199 |
public void addSummaryComment(Element element, Content htmltree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1200 |
addSummaryComment(element, utils.getFirstSentenceTrees(element), htmltree); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1201 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1202 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1203 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1204 |
* Adds the summary content. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1205 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1206 |
* @param element the Element for which the summary will be generated |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1207 |
* @param firstSentenceTags the first sentence tags for the doc |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1208 |
* @param htmltree the documentation tree to which the summary will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1209 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1210 |
public void addSummaryComment(Element element, List<? extends DocTree> firstSentenceTags, Content htmltree) { |
51862 | 1211 |
addCommentTags(element, firstSentenceTags, false, true, true, htmltree); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1212 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1213 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1214 |
public void addSummaryDeprecatedComment(Element element, DocTree tag, Content htmltree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1215 |
CommentHelper ch = utils.getCommentHelper(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1216 |
List<? extends DocTree> body = ch.getBody(configuration, tag); |
51862 | 1217 |
addCommentTags(element, ch.getFirstSentenceTrees(configuration, body), true, true, true, htmltree); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1218 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1219 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1220 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1221 |
* Adds the inline comment. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1222 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1223 |
* @param element the Element for which the inline comments will be generated |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1224 |
* @param htmltree the documentation tree to which the inline comments will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1225 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1226 |
public void addInlineComment(Element element, Content htmltree) { |
51862 | 1227 |
addCommentTags(element, utils.getFullBody(element), false, false, false, htmltree); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1228 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1229 |
|
10 | 1230 |
/** |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1231 |
* Adds the comment tags. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1232 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1233 |
* @param element the Element for which the comment tags will be generated |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1234 |
* @param tags the first sentence tags for the doc |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1235 |
* @param depr true if it is deprecated |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
1236 |
* @param first true if the first sentence tags should be added |
51862 | 1237 |
* @param inSummary true if the comment tags are added into the summary section |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1238 |
* @param htmltree the documentation tree to which the comment tags will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1239 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1240 |
private void addCommentTags(Element element, List<? extends DocTree> tags, boolean depr, |
51862 | 1241 |
boolean first, boolean inSummary, Content htmltree) { |
1242 |
addCommentTags(element, null, tags, depr, first, inSummary, htmltree); |
|
17547
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1243 |
} |
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1244 |
|
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1245 |
/** |
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1246 |
* Adds the comment tags. |
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1247 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1248 |
* @param element for which the comment tags will be generated |
17547
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1249 |
* @param holderTag the block tag context for the inline tags |
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1250 |
* @param tags the first sentence tags for the doc |
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1251 |
* @param depr true if it is deprecated |
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1252 |
* @param first true if the first sentence tags should be added |
51862 | 1253 |
* @param inSummary true if the comment tags are added into the summary section |
17547
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1254 |
* @param htmltree the documentation tree to which the comment tags will be added |
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
16964
diff
changeset
|
1255 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1256 |
private void addCommentTags(Element element, DocTree holderTag, List<? extends DocTree> tags, boolean depr, |
51862 | 1257 |
boolean first, boolean inSummary, Content htmltree) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1258 |
if(configuration.nocomment){ |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1259 |
return; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1260 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1261 |
Content div; |
51862 | 1262 |
Content result = commentTagsToContent(null, element, tags, first, inSummary); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1263 |
if (depr) { |
47300
a905ce398074
8074407: javadoc: using <pre> after @deprecated tag causes warnings
bpatel
parents:
47216
diff
changeset
|
1264 |
div = HtmlTree.DIV(HtmlStyle.deprecationComment, result); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1265 |
htmltree.add(div); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1266 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1267 |
else { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1268 |
div = HtmlTree.DIV(HtmlStyle.block, result); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1269 |
htmltree.add(div); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1270 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1271 |
if (tags.isEmpty()) { |
54610 | 1272 |
htmltree.add(Entity.NO_BREAK_SPACE); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1273 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1274 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1275 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1276 |
boolean ignoreNonInlineTag(DocTree dtree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1277 |
Name name = null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1278 |
if (dtree.getKind() == Kind.START_ELEMENT) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1279 |
StartElementTree setree = (StartElementTree)dtree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1280 |
name = setree.getName(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1281 |
} else if (dtree.getKind() == Kind.END_ELEMENT) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1282 |
EndElementTree eetree = (EndElementTree)dtree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1283 |
name = eetree.getName(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1284 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1285 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1286 |
if (name != null) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1287 |
com.sun.tools.doclint.HtmlTag htmlTag = com.sun.tools.doclint.HtmlTag.get(name); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1288 |
if (htmlTag != null && |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1289 |
htmlTag.blockType != com.sun.tools.doclint.HtmlTag.BlockType.INLINE) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1290 |
return true; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1291 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1292 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1293 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1294 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1295 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1296 |
boolean isAllWhiteSpace(String body) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1297 |
for (int i = 0 ; i < body.length(); i++) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1298 |
if (!Character.isWhitespace(body.charAt(i))) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1299 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1300 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1301 |
return true; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1302 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1303 |
|
45860
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1304 |
// Notify the next DocTree handler to take necessary action |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1305 |
private boolean commentRemoved = false; |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1306 |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1307 |
/** |
51862 | 1308 |
* Converts inline tags and text to Content, expanding the |
10 | 1309 |
* inline tags along the way. Called wherever text can contain |
1310 |
* an inline tag, such as in comments or in free-form text arguments |
|
51862 | 1311 |
* to block tags. |
10 | 1312 |
* |
1313 |
* @param holderTag specific tag where comment resides |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1314 |
* @param element specific element where comment resides |
10 | 1315 |
* @param tags array of text tags and inline tags (often alternating) |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1316 |
present in the text of interest for this element |
10 | 1317 |
* @param isFirstSentence true if text is first sentence |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1318 |
* @return a Content object |
10 | 1319 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1320 |
public Content commentTagsToContent(DocTree holderTag, Element element, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1321 |
List<? extends DocTree> tags, boolean isFirstSentence) { |
51862 | 1322 |
return commentTagsToContent(holderTag, element, tags, isFirstSentence, false); |
1323 |
} |
|
1324 |
||
1325 |
/** |
|
1326 |
* Converts inline tags and text to text strings, expanding the |
|
1327 |
* inline tags along the way. Called wherever text can contain |
|
1328 |
* an inline tag, such as in comments or in free-form text arguments |
|
1329 |
* to block tags. |
|
1330 |
* |
|
1331 |
* @param holderTag specific tag where comment resides |
|
1332 |
* @param element specific element where comment resides |
|
1333 |
* @param tags array of text tags and inline tags (often alternating) |
|
1334 |
present in the text of interest for this element |
|
1335 |
* @param isFirstSentence true if text is first sentence |
|
1336 |
* @param inSummary if the comment tags are added into the summary section |
|
1337 |
* @return a Content object |
|
1338 |
*/ |
|
1339 |
public Content commentTagsToContent(DocTree holderTag, Element element, |
|
1340 |
List<? extends DocTree> tags, boolean isFirstSentence, boolean inSummary) { |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1341 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1342 |
final Content result = new ContentBuilder() { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1343 |
@Override |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1344 |
public void add(CharSequence text) { |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1345 |
super.add(utils.normalizeNewlines(text)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1346 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1347 |
}; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1348 |
CommentHelper ch = utils.getCommentHelper(element); |
10 | 1349 |
// Array of all possible inline tags for this javadoc run |
50240 | 1350 |
configuration.tagletManager.checkTags(element, tags, true); |
45860
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1351 |
commentRemoved = false; |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1352 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1353 |
for (ListIterator<? extends DocTree> iterator = tags.listIterator(); iterator.hasNext();) { |
45860
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1354 |
boolean isFirstNode = !iterator.hasPrevious(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1355 |
DocTree tag = iterator.next(); |
45860
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1356 |
boolean isLastNode = !iterator.hasNext(); |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1357 |
|
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1358 |
if (isFirstSentence) { |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1359 |
// Ignore block tags |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1360 |
if (ignoreNonInlineTag(tag)) |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1361 |
continue; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1362 |
|
45860
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1363 |
// Ignore any trailing whitespace OR whitespace after removed html comment |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1364 |
if ((isLastNode || commentRemoved) |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1365 |
&& tag.getKind() == TEXT |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1366 |
&& isAllWhiteSpace(ch.getText(tag))) |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1367 |
continue; |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1368 |
|
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1369 |
// Ignore any leading html comments |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1370 |
if ((isFirstNode || commentRemoved) && tag.getKind() == COMMENT) { |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1371 |
commentRemoved = true; |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1372 |
continue; |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1373 |
} |
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1374 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1375 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1376 |
boolean allDone = new SimpleDocTreeVisitor<Boolean, Content>() { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1377 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1378 |
private boolean inAnAtag() { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1379 |
if (utils.isStartElement(tag)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1380 |
StartElementTree st = (StartElementTree)tag; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1381 |
Name name = st.getName(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1382 |
if (name != null) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1383 |
com.sun.tools.doclint.HtmlTag htag = |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1384 |
com.sun.tools.doclint.HtmlTag.get(name); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1385 |
return htag != null && htag.equals(com.sun.tools.doclint.HtmlTag.A); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1386 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1387 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1388 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1389 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1390 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1391 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1392 |
public Boolean visitAttribute(AttributeTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1393 |
StringBuilder sb = new StringBuilder(SPACER).append(node.getName()); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1394 |
if (node.getValueKind() == ValueKind.EMPTY) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1395 |
result.add(sb); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1396 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1397 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1398 |
sb.append("="); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1399 |
String quote; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1400 |
switch (node.getValueKind()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1401 |
case DOUBLE: |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1402 |
quote = "\""; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1403 |
break; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1404 |
case SINGLE: |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1405 |
quote = "\'"; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1406 |
break; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1407 |
default: |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1408 |
quote = ""; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1409 |
break; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1410 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1411 |
sb.append(quote); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1412 |
result.add(sb); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1413 |
Content docRootContent = new ContentBuilder(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1414 |
|
48655
e1876e6b57b6
8195805: Doclet incorrectly updates all attributes in <a> tags when relocating links
jjg
parents:
48654
diff
changeset
|
1415 |
boolean isHRef = inAnAtag() && node.getName().toString().equalsIgnoreCase("href"); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1416 |
for (DocTree dt : node.getValue()) { |
48655
e1876e6b57b6
8195805: Doclet incorrectly updates all attributes in <a> tags when relocating links
jjg
parents:
48654
diff
changeset
|
1417 |
if (utils.isText(dt) && isHRef) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1418 |
String text = ((TextTree) dt).getBody(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1419 |
if (text.startsWith("/..") && !configuration.docrootparent.isEmpty()) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1420 |
result.add(configuration.docrootparent); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1421 |
docRootContent = new ContentBuilder(); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1422 |
result.add(textCleanup(text.substring(3), isLastNode)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1423 |
} else { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1424 |
if (!docRootContent.isEmpty()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1425 |
docRootContent = copyDocRootContent(docRootContent); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1426 |
} else { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1427 |
text = redirectRelativeLinks(element, (TextTree) dt); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1428 |
} |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1429 |
result.add(textCleanup(text, isLastNode)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1430 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1431 |
} else { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1432 |
docRootContent = copyDocRootContent(docRootContent); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1433 |
dt.accept(this, docRootContent); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1434 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1435 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1436 |
copyDocRootContent(docRootContent); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1437 |
result.add(quote); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1438 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1439 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1440 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1441 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1442 |
public Boolean visitComment(CommentTree node, Content c) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1443 |
result.add(new RawHtml(node.getBody())); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1444 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1445 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1446 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1447 |
private Content copyDocRootContent(Content content) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1448 |
if (!content.isEmpty()) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1449 |
result.add(content); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1450 |
return new ContentBuilder(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1451 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1452 |
return content; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1453 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1454 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1455 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1456 |
public Boolean visitDocRoot(DocRootTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1457 |
Content docRootContent = TagletWriter.getInlineTagOutput(element, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1458 |
configuration.tagletManager, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1459 |
holderTag, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1460 |
node, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1461 |
getTagletWriterInstance(isFirstSentence)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1462 |
if (c != null) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1463 |
c.add(docRootContent); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1464 |
} else { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1465 |
result.add(docRootContent); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1466 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1467 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1468 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1469 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1470 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1471 |
public Boolean visitEndElement(EndElementTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1472 |
RawHtml rawHtml = new RawHtml("</" + node.getName() + ">"); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1473 |
result.add(rawHtml); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1474 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1475 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1476 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1477 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1478 |
public Boolean visitEntity(EntityTree node, Content c) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1479 |
result.add(new RawHtml(node.toString())); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1480 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1481 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1482 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1483 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1484 |
public Boolean visitErroneous(ErroneousTree node, Content c) { |
40303 | 1485 |
messages.warning(ch.getDocTreePath(node), |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1486 |
"doclet.tag.invalid_usage", node); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1487 |
result.add(new RawHtml(node.toString())); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1488 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1489 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1490 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1491 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1492 |
public Boolean visitInheritDoc(InheritDocTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1493 |
Content output = TagletWriter.getInlineTagOutput(element, |
22005
4270ada5dcd1
8025416: doclet not substituting {@docRoot} in some cases
bpatel
parents:
21494
diff
changeset
|
1494 |
configuration.tagletManager, holderTag, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1495 |
tag, getTagletWriterInstance(isFirstSentence)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1496 |
result.add(output); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1497 |
// if we obtained the first sentence successfully, nothing more to do |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1498 |
return (isFirstSentence && !output.isEmpty()); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1499 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1500 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1501 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1502 |
public Boolean visitIndex(IndexTree node, Content p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1503 |
Content output = TagletWriter.getInlineTagOutput(element, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1504 |
configuration.tagletManager, holderTag, tag, |
51862 | 1505 |
getTagletWriterInstance(isFirstSentence, inSummary)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1506 |
if (output != null) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1507 |
result.add(output); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1508 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1509 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1510 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1511 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1512 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1513 |
public Boolean visitLink(LinkTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1514 |
// we need to pass the DocTreeImpl here, so ignore node |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1515 |
result.add(seeTagToContent(element, tag)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1516 |
return false; |
10 | 1517 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1518 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1519 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1520 |
public Boolean visitLiteral(LiteralTree node, Content c) { |
50116
cebd0673feeb
8203176: javadoc handles non-ASCII characters incorrectly.
jjg
parents:
49879
diff
changeset
|
1521 |
String s = node.getBody().getBody(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1522 |
Content content = new StringContent(utils.normalizeNewlines(s)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1523 |
if (node.getKind() == CODE) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1524 |
content = HtmlTree.CODE(content); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1525 |
result.add(content); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1526 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1527 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1528 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1529 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1530 |
public Boolean visitSee(SeeTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1531 |
// we need to pass the DocTreeImpl here, so ignore node |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1532 |
result.add(seeTagToContent(element, tag)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1533 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1534 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1535 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1536 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1537 |
public Boolean visitStartElement(StartElementTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1538 |
String text = "<" + node.getName(); |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
1539 |
RawHtml rawHtml = new RawHtml(utils.normalizeNewlines(text)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1540 |
result.add(rawHtml); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1541 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1542 |
for (DocTree dt : node.getAttributes()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1543 |
dt.accept(this, null); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1544 |
} |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1545 |
result.add(new RawHtml(node.isSelfClosing() ? "/>" : ">")); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1546 |
return false; |
9608 | 1547 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1548 |
|
46184
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
1549 |
@Override |
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
1550 |
public Boolean visitSummary(SummaryTree node, Content c) { |
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
1551 |
Content output = TagletWriter.getInlineTagOutput(element, |
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
1552 |
configuration.tagletManager, holderTag, tag, |
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
1553 |
getTagletWriterInstance(isFirstSentence)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1554 |
result.add(output); |
46184
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
1555 |
return false; |
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
1556 |
} |
f1325703ea85
8173425: Javadoc needs a new tag to specify the summary.
ksrini
parents:
46080
diff
changeset
|
1557 |
|
52487
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1558 |
@Override |
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1559 |
public Boolean visitSystemProperty(SystemPropertyTree node, Content p) { |
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1560 |
Content output = TagletWriter.getInlineTagOutput(element, |
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1561 |
configuration.tagletManager, holderTag, tag, |
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1562 |
getTagletWriterInstance(isFirstSentence, inSummary)); |
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1563 |
if (output != null) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1564 |
result.add(output); |
52487
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1565 |
} |
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1566 |
return false; |
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1567 |
} |
5d1d07b72f15
5076751: System properties documentation needed in javadocs
pmuthuswamy
parents:
51862
diff
changeset
|
1568 |
|
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
1569 |
private CharSequence textCleanup(String text, boolean isLast) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1570 |
return textCleanup(text, isLast, false); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1571 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1572 |
|
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
1573 |
private CharSequence textCleanup(String text, boolean isLast, boolean trimLeader) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1574 |
if (trimLeader) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1575 |
text = removeLeadingWhitespace(text); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1576 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1577 |
if (isFirstSentence && isLast) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1578 |
text = removeTrailingWhitespace(text); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1579 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1580 |
text = utils.replaceTabs(text); |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
1581 |
return utils.normalizeNewlines(text); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1582 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1583 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1584 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1585 |
public Boolean visitText(TextTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1586 |
String text = node.getBody(); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1587 |
result.add(new RawHtml(textCleanup(text, isLastNode, commentRemoved))); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1588 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1589 |
} |
10 | 1590 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1591 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1592 |
protected Boolean defaultAction(DocTree node, Content c) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1593 |
Content output = TagletWriter.getInlineTagOutput(element, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1594 |
configuration.tagletManager, holderTag, tag, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1595 |
getTagletWriterInstance(isFirstSentence)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1596 |
if (output != null) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1597 |
result.add(output); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1598 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1599 |
return false; |
10 | 1600 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1601 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1602 |
}.visit(tag, null); |
45860
0952e2c6545a
8179704: doclet crashes with an empty package.html
ksrini
parents:
45417
diff
changeset
|
1603 |
commentRemoved = false; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1604 |
if (allDone) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1605 |
break; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1606 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1607 |
return result; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1608 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1609 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1610 |
private String removeTrailingWhitespace(String text) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1611 |
char[] buf = text.toCharArray(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1612 |
for (int i = buf.length - 1; i > 0 ; i--) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1613 |
if (!Character.isWhitespace(buf[i])) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1614 |
return text.substring(0, i + 1); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1615 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1616 |
return text; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1617 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1618 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1619 |
private String removeLeadingWhitespace(String text) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1620 |
char[] buf = text.toCharArray(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1621 |
for (int i = 0; i < buf.length; i++) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1622 |
if (!Character.isWhitespace(buf[i])) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1623 |
return text.substring(i); |
10 | 1624 |
} |
1625 |
} |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1626 |
return text; |
10 | 1627 |
} |
1628 |
||
1629 |
/** |
|
1630 |
* Return true if relative links should not be redirected. |
|
1631 |
* |
|
1632 |
* @return Return true if a relative link should not be redirected. |
|
1633 |
*/ |
|
1634 |
private boolean shouldNotRedirectRelativeLinks() { |
|
1635 |
return this instanceof AnnotationTypeWriter || |
|
1636 |
this instanceof ClassWriter || |
|
1637 |
this instanceof PackageSummaryWriter; |
|
1638 |
} |
|
1639 |
||
1640 |
/** |
|
1641 |
* Suppose a piece of documentation has a relative link. When you copy |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14266
diff
changeset
|
1642 |
* that documentation to another place such as the index or class-use page, |
10 | 1643 |
* that relative link will no longer work. We should redirect those links |
1644 |
* so that they will work again. |
|
1645 |
* <p> |
|
1646 |
* Here is the algorithm used to fix the link: |
|
1647 |
* <p> |
|
13844 | 1648 |
* {@literal <relative link> => docRoot + <relative path to file> + <relative link> } |
10 | 1649 |
* <p> |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1650 |
* For example, suppose DocletEnvironment has this link: |
13844 | 1651 |
* {@literal <a href="package-summary.html">The package Page</a> } |
10 | 1652 |
* <p> |
1653 |
* If this link appeared in the index, we would redirect |
|
1654 |
* the link like this: |
|
1655 |
* |
|
53885
e03bbe023e50
8215584: Remove support for the "old" doclet API in com/sun/javadoc
pmuthuswamy
parents:
53880
diff
changeset
|
1656 |
* {@literal <a href="./jdk/javadoc/doclet/package-summary.html">The package Page</a>} |
10 | 1657 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1658 |
* @param element the Element object whose documentation is being written. |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1659 |
* @param tt the text being written. |
10 | 1660 |
* |
1661 |
* @return the text, with all the relative links redirected to work. |
|
1662 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1663 |
private String redirectRelativeLinks(Element element, TextTree tt) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1664 |
String text = tt.getBody(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1665 |
if (element == null || utils.isOverviewElement(element) || shouldNotRedirectRelativeLinks()) { |
10 | 1666 |
return text; |
1667 |
} |
|
1668 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1669 |
DocPath redirectPathFromRoot = new SimpleElementVisitor9<DocPath, Void>() { |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1670 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1671 |
public DocPath visitType(TypeElement e, Void p) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
1672 |
return docPaths.forPackage(utils.containingPackage(e)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1673 |
} |
10 | 1674 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1675 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1676 |
public DocPath visitPackage(PackageElement e, Void p) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
1677 |
return docPaths.forPackage(e); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1678 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1679 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1680 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1681 |
public DocPath visitVariable(VariableElement e, Void p) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
1682 |
return docPaths.forPackage(utils.containingPackage(e)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1683 |
} |
10 | 1684 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1685 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1686 |
public DocPath visitExecutable(ExecutableElement e, Void p) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
1687 |
return docPaths.forPackage(utils.containingPackage(e)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1688 |
} |
23123
fd8ad69ac7fe
6457406: javadoc doesn't handle <a href='http://...'> properly in producing index pages
yan
parents:
22163
diff
changeset
|
1689 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1690 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1691 |
protected DocPath defaultAction(Element e, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1692 |
return null; |
10 | 1693 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1694 |
}.visit(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1695 |
if (redirectPathFromRoot == null) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1696 |
return text; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1697 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1698 |
String lower = Utils.toLowerCase(text); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1699 |
if (!(lower.startsWith("mailto:") |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1700 |
|| lower.startsWith("http:") |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1701 |
|| lower.startsWith("https:") |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1702 |
|| lower.startsWith("file:"))) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1703 |
text = "{@" + (new DocRootTaglet()).getName() + "}/" |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1704 |
+ redirectPathFromRoot.resolve(text).getPath(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1705 |
text = replaceDocRootDir(text); |
10 | 1706 |
} |
1707 |
return text; |
|
1708 |
} |
|
1709 |
||
14549
0599d73bf1da
8002304: Group methods by types in methods summary section
bpatel
parents:
14542
diff
changeset
|
1710 |
/** |
9303
eae35c201e19
7032975: API files in javax.annotation.processing need to be updated for references to JLS
jjh
parents:
8631
diff
changeset
|
1711 |
* According to |
eae35c201e19
7032975: API files in javax.annotation.processing need to be updated for references to JLS
jjh
parents:
8631
diff
changeset
|
1712 |
* <cite>The Java™ Language Specification</cite>, |
eae35c201e19
7032975: API files in javax.annotation.processing need to be updated for references to JLS
jjh
parents:
8631
diff
changeset
|
1713 |
* all the outer classes and static nested classes are core classes. |
10 | 1714 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1715 |
public boolean isCoreClass(TypeElement typeElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1716 |
return utils.getEnclosingTypeElement(typeElement) == null || utils.isStatic(typeElement); |
10 | 1717 |
} |
1718 |
||
1719 |
/** |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1720 |
* Adds the annotation types for the given packageElement. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1721 |
* |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1722 |
* @param packageElement the package to write annotations for. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1723 |
* @param htmltree the documentation tree to which the annotation info will be |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1724 |
* added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1725 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1726 |
public void addAnnotationInfo(PackageElement packageElement, Content htmltree) { |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1727 |
addAnnotationInfo(packageElement.getAnnotationMirrors(), htmltree); |
15385 | 1728 |
} |
1729 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1730 |
/* |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1731 |
* this is a hack to delay dealing with Annotations in the writers, the assumption |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1732 |
* is that all necessary checks have been made to get here. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1733 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1734 |
public void addReceiverAnnotationInfo(ExecutableElement method, TypeMirror rcvrTypeMirror, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1735 |
List<? extends AnnotationMirror> annotationMirrors, Content htmltree) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1736 |
TypeMirror rcvrType = method.getReceiverType(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1737 |
List<? extends AnnotationMirror> annotationMirrors1 = rcvrType.getAnnotationMirrors(); |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1738 |
htmltree.add(getAnnotationInfo(annotationMirrors1, false)); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1739 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1740 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1741 |
/** |
47849 | 1742 |
* Adds the annotation types for the given element. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1743 |
* |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1744 |
* @param element the package to write annotations for |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1745 |
* @param htmltree the content tree to which the annotation types will be added |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1746 |
*/ |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1747 |
public void addAnnotationInfo(Element element, Content htmltree) { |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1748 |
addAnnotationInfo(element.getAnnotationMirrors(), htmltree); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1749 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1750 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1751 |
/** |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1752 |
* Add the annotatation types for the given element and parameter. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1753 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1754 |
* @param param the parameter to write annotations for. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1755 |
* @param tree the content tree to which the annotation types will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1756 |
*/ |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1757 |
public boolean addAnnotationInfo(VariableElement param, Content tree) { |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1758 |
Content annotaionInfo = getAnnotationInfo(param.getAnnotationMirrors(), false); |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1759 |
if (annotaionInfo.isEmpty()) { |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1760 |
return false; |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1761 |
} |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1762 |
tree.add(annotaionInfo); |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1763 |
return true; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1764 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1765 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1766 |
/** |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1767 |
* Adds the annotatation types for the given Element. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1768 |
* |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1769 |
* @param descList a list of annotation mirrors. |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1770 |
* @param htmltree the documentation tree to which the annotation info will be |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1771 |
* added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1772 |
*/ |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1773 |
private void addAnnotationInfo(List<? extends AnnotationMirror> descList, Content htmltree) { |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1774 |
htmltree.add(getAnnotationInfo(descList, true)); |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1775 |
} |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1776 |
|
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1777 |
/** |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1778 |
* Return a content tree containing the annotation types for the given element. |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1779 |
* |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1780 |
* @param descList a list of annotation mirrors. |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1781 |
* @return the documentation tree containing the annotation info. |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1782 |
*/ |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1783 |
Content getAnnotationInfo(List<? extends AnnotationMirror> descList, boolean lineBreak) { |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1784 |
List<Content> annotations = getAnnotations(descList, lineBreak); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1785 |
String sep = ""; |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1786 |
ContentBuilder builder = new ContentBuilder(); |
17570
78512b2899db
8012183: replace some uses of Configuration.getText with Configuration.getResource
jjg
parents:
17569
diff
changeset
|
1787 |
for (Content annotation: annotations) { |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1788 |
builder.add(sep); |
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1789 |
builder.add(annotation); |
31943
72b69ab429c9
8062647: Wrong indentation of arguments of annotated methods
igerasim
parents:
31297
diff
changeset
|
1790 |
if (!lineBreak) { |
72b69ab429c9
8062647: Wrong indentation of arguments of annotated methods
igerasim
parents:
31297
diff
changeset
|
1791 |
sep = " "; |
72b69ab429c9
8062647: Wrong indentation of arguments of annotated methods
igerasim
parents:
31297
diff
changeset
|
1792 |
} |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
1793 |
} |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1794 |
return builder; |
15385 | 1795 |
} |
1796 |
||
1797 |
/** |
|
1798 |
* Return the string representations of the annotation types for |
|
1799 |
* the given doc. |
|
1800 |
* |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1801 |
* @param descList a list of annotation mirrors. |
15385 | 1802 |
* @param linkBreak if true, add new line between each member value. |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
1803 |
* @return a list of strings representing the annotations being |
15385 | 1804 |
* documented. |
1805 |
*/ |
|
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1806 |
public List<Content> getAnnotations(List<? extends AnnotationMirror> descList, boolean linkBreak) { |
22163 | 1807 |
List<Content> results = new ArrayList<>(); |
17570
78512b2899db
8012183: replace some uses of Configuration.getText with Configuration.getResource
jjg
parents:
17569
diff
changeset
|
1808 |
ContentBuilder annotation; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1809 |
for (AnnotationMirror aDesc : descList) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1810 |
TypeElement annotationElement = (TypeElement)aDesc.getAnnotationType().asElement(); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1811 |
// If an annotation is not documented, do not add it to the list. If |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1812 |
// the annotation is of a repeatable type, and if it is not documented |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1813 |
// and also if its container annotation is not documented, do not add it |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1814 |
// to the list. If an annotation of a repeatable type is not documented |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1815 |
// but its container is documented, it will be added to the list. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1816 |
if (!utils.isDocumentedAnnotation(annotationElement) && |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
22153
diff
changeset
|
1817 |
(!isAnnotationDocumented && !isContainerDocumented)) { |
10 | 1818 |
continue; |
1819 |
} |
|
17570
78512b2899db
8012183: replace some uses of Configuration.getText with Configuration.getResource
jjg
parents:
17569
diff
changeset
|
1820 |
annotation = new ContentBuilder(); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1821 |
isAnnotationDocumented = false; |
14542 | 1822 |
LinkInfoImpl linkInfo = new LinkInfoImpl(configuration, |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1823 |
LinkInfoImpl.Kind.ANNOTATION, annotationElement); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1824 |
Map<? extends ExecutableElement, ? extends AnnotationValue> pairs = aDesc.getElementValues(); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1825 |
// If the annotation is synthesized, do not print the container. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1826 |
if (utils.configuration.workArounds.isSynthesized(aDesc)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1827 |
for (ExecutableElement ee : pairs.keySet()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1828 |
AnnotationValue annotationValue = pairs.get(ee); |
22163 | 1829 |
List<AnnotationValue> annotationTypeValues = new ArrayList<>(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1830 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1831 |
new SimpleAnnotationValueVisitor9<Void, List<AnnotationValue>>() { |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1832 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1833 |
public Void visitArray(List<? extends AnnotationValue> vals, List<AnnotationValue> p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1834 |
p.addAll(vals); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1835 |
return null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1836 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1837 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1838 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1839 |
protected Void defaultAction(Object o, List<AnnotationValue> p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1840 |
p.add(annotationValue); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1841 |
return null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1842 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1843 |
}.visit(annotationValue, annotationTypeValues); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1844 |
|
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1845 |
String sep = ""; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1846 |
for (AnnotationValue av : annotationTypeValues) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1847 |
annotation.add(sep); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1848 |
annotation.add(annotationValueToContent(av)); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1849 |
sep = " "; |
10 | 1850 |
} |
1851 |
} |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1852 |
} else if (isAnnotationArray(pairs)) { |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1853 |
// If the container has 1 or more value defined and if the |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1854 |
// repeatable type annotation is not documented, do not print |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1855 |
// the container. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1856 |
if (pairs.size() == 1 && isAnnotationDocumented) { |
22163 | 1857 |
List<AnnotationValue> annotationTypeValues = new ArrayList<>(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1858 |
for (AnnotationValue a : pairs.values()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1859 |
new SimpleAnnotationValueVisitor9<Void, List<AnnotationValue>>() { |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1860 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1861 |
public Void visitArray(List<? extends AnnotationValue> vals, List<AnnotationValue> annotationTypeValues) { |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1862 |
annotationTypeValues.addAll(vals); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1863 |
return null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1864 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1865 |
}.visit(a, annotationTypeValues); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1866 |
} |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1867 |
String sep = ""; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1868 |
for (AnnotationValue av : annotationTypeValues) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1869 |
annotation.add(sep); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1870 |
annotation.add(annotationValueToContent(av)); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1871 |
sep = " "; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1872 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1873 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1874 |
// If the container has 1 or more value defined and if the |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1875 |
// repeatable type annotation is not documented, print the container. |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1876 |
else { |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1877 |
addAnnotations(annotationElement, linkInfo, annotation, pairs, false); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1878 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1879 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1880 |
else { |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1881 |
addAnnotations(annotationElement, linkInfo, annotation, pairs, linkBreak); |
10 | 1882 |
} |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1883 |
annotation.add(linkBreak ? DocletConstants.NL : ""); |
17570
78512b2899db
8012183: replace some uses of Configuration.getText with Configuration.getResource
jjg
parents:
17569
diff
changeset
|
1884 |
results.add(annotation); |
10 | 1885 |
} |
1886 |
return results; |
|
1887 |
} |
|
1888 |
||
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1889 |
/** |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1890 |
* Add annotation to the annotation string. |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1891 |
* |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1892 |
* @param annotationDoc the annotation being documented |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1893 |
* @param linkInfo the information about the link |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1894 |
* @param annotation the annotation string to which the annotation will be added |
48029
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47852
diff
changeset
|
1895 |
* @param map annotation type element to annotation value pairs |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1896 |
* @param linkBreak if true, add new line between each member value |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1897 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1898 |
private void addAnnotations(TypeElement annotationDoc, LinkInfoImpl linkInfo, |
48029
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47852
diff
changeset
|
1899 |
ContentBuilder annotation, |
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47852
diff
changeset
|
1900 |
Map<? extends ExecutableElement, ? extends AnnotationValue> map, |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1901 |
boolean linkBreak) { |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
1902 |
linkInfo.label = new StringContent("@"); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1903 |
linkInfo.label.add(annotationDoc.getSimpleName()); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1904 |
annotation.add(getLink(linkInfo)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1905 |
if (!map.isEmpty()) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1906 |
annotation.add("("); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1907 |
boolean isFirst = true; |
36038
39c5445924b9
6469561: javadoc for annotation types should not display "public abstract" modifiers on methods
darcy
parents:
35426
diff
changeset
|
1908 |
Set<? extends ExecutableElement> keys = map.keySet(); |
39c5445924b9
6469561: javadoc for annotation types should not display "public abstract" modifiers on methods
darcy
parents:
35426
diff
changeset
|
1909 |
boolean multipleValues = keys.size() > 1; |
39c5445924b9
6469561: javadoc for annotation types should not display "public abstract" modifiers on methods
darcy
parents:
35426
diff
changeset
|
1910 |
for (ExecutableElement element : keys) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1911 |
if (isFirst) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1912 |
isFirst = false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1913 |
} else { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1914 |
annotation.add(","); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1915 |
if (linkBreak) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1916 |
annotation.add(DocletConstants.NL); |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
1917 |
int spaces = annotationDoc.getSimpleName().length() + 2; |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
1918 |
for (int k = 0; k < (spaces); k++) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1919 |
annotation.add(" "); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1920 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1921 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1922 |
} |
36038
39c5445924b9
6469561: javadoc for annotation types should not display "public abstract" modifiers on methods
darcy
parents:
35426
diff
changeset
|
1923 |
String simpleName = element.getSimpleName().toString(); |
39c5445924b9
6469561: javadoc for annotation types should not display "public abstract" modifiers on methods
darcy
parents:
35426
diff
changeset
|
1924 |
if (multipleValues || !"value".equals(simpleName)) { // Omit "value=" where unnecessary |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1925 |
annotation.add(getDocLink(LinkInfoImpl.Kind.ANNOTATION, |
36038
39c5445924b9
6469561: javadoc for annotation types should not display "public abstract" modifiers on methods
darcy
parents:
35426
diff
changeset
|
1926 |
element, simpleName, false)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1927 |
annotation.add("="); |
36038
39c5445924b9
6469561: javadoc for annotation types should not display "public abstract" modifiers on methods
darcy
parents:
35426
diff
changeset
|
1928 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1929 |
AnnotationValue annotationValue = map.get(element); |
22163 | 1930 |
List<AnnotationValue> annotationTypeValues = new ArrayList<>(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1931 |
new SimpleAnnotationValueVisitor9<Void, AnnotationValue>() { |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1932 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1933 |
public Void visitArray(List<? extends AnnotationValue> vals, AnnotationValue p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1934 |
annotationTypeValues.addAll(vals); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1935 |
return null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1936 |
} |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1937 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1938 |
protected Void defaultAction(Object o, AnnotationValue p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1939 |
annotationTypeValues.add(p); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1940 |
return null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1941 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1942 |
}.visit(annotationValue, annotationValue); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1943 |
annotation.add(annotationTypeValues.size() == 1 ? "" : "{"); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1944 |
String sep = ""; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1945 |
for (AnnotationValue av : annotationTypeValues) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1946 |
annotation.add(sep); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1947 |
annotation.add(annotationValueToContent(av)); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1948 |
sep = ","; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1949 |
} |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1950 |
annotation.add(annotationTypeValues.size() == 1 ? "" : "}"); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1951 |
isContainerDocumented = false; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1952 |
} |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
1953 |
annotation.add(")"); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1954 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1955 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1956 |
|
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1957 |
/** |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1958 |
* Check if the annotation contains an array of annotation as a value. This |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1959 |
* check is to verify if a repeatable type annotation is present or not. |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1960 |
* |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1961 |
* @param pairs annotation type element and value pairs |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1962 |
* |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1963 |
* @return true if the annotation contains an array of annotation as a value. |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1964 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1965 |
private boolean isAnnotationArray(Map<? extends ExecutableElement, ? extends AnnotationValue> pairs) { |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1966 |
AnnotationValue annotationValue; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1967 |
for (ExecutableElement ee : pairs.keySet()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1968 |
annotationValue = pairs.get(ee); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1969 |
boolean rvalue = new SimpleAnnotationValueVisitor9<Boolean, Void>() { |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1970 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1971 |
public Boolean visitArray(List<? extends AnnotationValue> vals, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1972 |
if (vals.size() > 1) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1973 |
if (vals.get(0) instanceof AnnotationMirror) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1974 |
isContainerDocumented = true; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1975 |
return new SimpleAnnotationValueVisitor9<Boolean, Void>() { |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1976 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1977 |
public Boolean visitAnnotation(AnnotationMirror a, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1978 |
isContainerDocumented = true; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1979 |
Element asElement = a.getAnnotationType().asElement(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1980 |
if (utils.isDocumentedAnnotation((TypeElement)asElement)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1981 |
isAnnotationDocumented = true; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1982 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1983 |
return true; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1984 |
} |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1985 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1986 |
protected Boolean defaultAction(Object o, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1987 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1988 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1989 |
}.visit(vals.get(0)); |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1990 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1991 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1992 |
return false; |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
1993 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1994 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
1995 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1996 |
protected Boolean defaultAction(Object o, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1997 |
return false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1998 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
1999 |
}.visit(annotationValue); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2000 |
if (rvalue) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2001 |
return true; |
15035
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
2002 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
2003 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
2004 |
return false; |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
2005 |
} |
d03c311f44e6
8005092: javadoc should check for synthesized bit on an annotation
bpatel
parents:
14549
diff
changeset
|
2006 |
|
17570
78512b2899db
8012183: replace some uses of Configuration.getText with Configuration.getResource
jjg
parents:
17569
diff
changeset
|
2007 |
private Content annotationValueToContent(AnnotationValue annotationValue) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2008 |
return new SimpleAnnotationValueVisitor9<Content, Void>() { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2009 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
2010 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2011 |
public Content visitType(TypeMirror t, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2012 |
return new SimpleTypeVisitor9<Content, Void>() { |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
2013 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2014 |
public Content visitDeclared(DeclaredType t, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2015 |
LinkInfoImpl linkInfo = new LinkInfoImpl(configuration, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2016 |
LinkInfoImpl.Kind.ANNOTATION, t); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2017 |
String name = utils.isIncluded(t.asElement()) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2018 |
? t.asElement().getSimpleName().toString() |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2019 |
: utils.getFullyQualifiedName(t.asElement()); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2020 |
linkInfo.label = new StringContent(name + utils.getDimension(t) + ".class"); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2021 |
return getLink(linkInfo); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2022 |
} |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
2023 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2024 |
protected Content defaultAction(TypeMirror e, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2025 |
return new StringContent(t + utils.getDimension(t) + ".class"); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2026 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2027 |
}.visit(t); |
10 | 2028 |
} |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
2029 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2030 |
public Content visitAnnotation(AnnotationMirror a, Void p) { |
55197
0ca8e495bbba
8214126: Method signatures not formatted correctly in browser
hannesw
parents:
54936
diff
changeset
|
2031 |
List<Content> list = getAnnotations(List.of(a), false); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2032 |
ContentBuilder buf = new ContentBuilder(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2033 |
for (Content c : list) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
2034 |
buf.add(c); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2035 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2036 |
return buf; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2037 |
} |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
2038 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2039 |
public Content visitEnumConstant(VariableElement c, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2040 |
return getDocLink(LinkInfoImpl.Kind.ANNOTATION, |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
36038
diff
changeset
|
2041 |
c, c.getSimpleName(), false); |
10 | 2042 |
} |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
2043 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2044 |
public Content visitArray(List<? extends AnnotationValue> vals, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2045 |
ContentBuilder buf = new ContentBuilder(); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2046 |
String sep = ""; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2047 |
for (AnnotationValue av : vals) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
2048 |
buf.add(sep); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
2049 |
buf.add(visit(av)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2050 |
sep = " "; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2051 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2052 |
return buf; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2053 |
} |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40587
diff
changeset
|
2054 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2055 |
protected Content defaultAction(Object o, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2056 |
return new StringContent(annotationValue.toString()); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2057 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
2058 |
}.visit(annotationValue); |
10 | 2059 |
} |
2060 |
||
47427 | 2061 |
protected TableHeader getPackageTableHeader() { |
2062 |
return new TableHeader(contents.packageLabel, contents.descriptionLabel); |
|
10 | 2063 |
} |
47846 | 2064 |
|
47847 | 2065 |
/** |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2066 |
* Generates a string for use in a description meta element, |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2067 |
* based on an element and its enclosing elements |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2068 |
* @param prefix a prefix for the string |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2069 |
* @param elem the element |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2070 |
* @return the description |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2071 |
*/ |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2072 |
static String getDescription(String prefix, Element elem) { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2073 |
LinkedList<Element> chain = new LinkedList<>(); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2074 |
for (Element e = elem; e != null; e = e.getEnclosingElement()) { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2075 |
// ignore unnamed enclosing elements |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2076 |
if (e.getSimpleName().length() == 0 && e != elem) { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2077 |
break; |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2078 |
} |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2079 |
chain.addFirst(e); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2080 |
} |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2081 |
StringBuilder sb = new StringBuilder(); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2082 |
for (Element e: chain) { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2083 |
CharSequence name; |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2084 |
switch (e.getKind()) { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2085 |
case MODULE: |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2086 |
case PACKAGE: |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2087 |
name = ((QualifiedNameable) e).getQualifiedName(); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2088 |
if (name.length() == 0) { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2089 |
name = "<unnamed>"; |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2090 |
} |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2091 |
break; |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2092 |
|
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2093 |
default: |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2094 |
name = e.getSimpleName(); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2095 |
break; |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2096 |
} |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2097 |
|
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2098 |
if (sb.length() == 0) { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2099 |
sb.append(prefix).append(": "); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2100 |
} else { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2101 |
sb.append(", "); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2102 |
} |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2103 |
sb.append(e.getKind().toString().toLowerCase(Locale.US).replace("_", " ")) |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2104 |
.append(": ") |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2105 |
.append(name); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2106 |
} |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2107 |
return sb.toString(); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2108 |
} |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2109 |
|
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2110 |
static String getGenerator(Class<?> clazz) { |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2111 |
return "javadoc/" + clazz.getSimpleName(); |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2112 |
} |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2113 |
|
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2114 |
/** |
47847 | 2115 |
* Returns an HtmlTree for the SCRIPT tag. |
2116 |
* |
|
2117 |
* @return an HtmlTree for the SCRIPT tag |
|
2118 |
*/ |
|
2119 |
protected Script getWinTitleScript() { |
|
2120 |
Script script = new Script(); |
|
2121 |
if (winTitle != null && winTitle.length() > 0) { |
|
2122 |
script.append("<!--\n" + |
|
2123 |
" try {\n" + |
|
2124 |
" if (location.href.indexOf('is-external=true') == -1) {\n" + |
|
2125 |
" parent.document.title=") |
|
2126 |
.appendStringLiteral(winTitle) |
|
2127 |
.append(";\n" + |
|
2128 |
" }\n" + |
|
2129 |
" }\n" + |
|
2130 |
" catch(err) {\n" + |
|
2131 |
" }\n" + |
|
2132 |
"//-->\n"); |
|
2133 |
} |
|
47846 | 2134 |
return script; |
2135 |
} |
|
47847 | 2136 |
|
2137 |
/** |
|
2138 |
* Returns an HtmlTree for the BODY tag. |
|
2139 |
* |
|
2140 |
* @param title title for the window |
|
2141 |
* @return an HtmlTree for the BODY tag |
|
2142 |
*/ |
|
54350
4f9772f4403d
8215599: Remove support for javadoc "frames" mode
pmuthuswamy
parents:
54060
diff
changeset
|
2143 |
public HtmlTree getBody(String title) { |
47847 | 2144 |
HtmlTree body = new HtmlTree(HtmlTag.BODY); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
54002
diff
changeset
|
2145 |
body.put(HtmlAttr.CLASS, getBodyClass()); |
54002 | 2146 |
|
47847 | 2147 |
this.winTitle = title; |
2148 |
// Don't print windowtitle script for overview-frame, allclasses-frame |
|
2149 |
// and package-frame |
|
54350
4f9772f4403d
8215599: Remove support for javadoc "frames" mode
pmuthuswamy
parents:
54060
diff
changeset
|
2150 |
body.add(mainBodyScript.asContent()); |
4f9772f4403d
8215599: Remove support for javadoc "frames" mode
pmuthuswamy
parents:
54060
diff
changeset
|
2151 |
Content noScript = HtmlTree.NOSCRIPT(HtmlTree.DIV(contents.noScriptMessage)); |
4f9772f4403d
8215599: Remove support for javadoc "frames" mode
pmuthuswamy
parents:
54060
diff
changeset
|
2152 |
body.add(noScript); |
47847 | 2153 |
return body; |
2154 |
} |
|
2155 |
||
54002 | 2156 |
public String getBodyClass() { |
2157 |
return getClass().getSimpleName() |
|
2158 |
.replaceAll("(Writer)?(Impl)?$", "") |
|
2159 |
.replaceAll("AnnotationType", "Class") |
|
2160 |
.replaceAll("(.)([A-Z])", "$1-$2") |
|
2161 |
.replaceAll("(?i)^(module|package|class)$", "$1-declaration") |
|
2162 |
.toLowerCase(Locale.US); |
|
2163 |
} |
|
2164 |
||
47847 | 2165 |
Script getMainBodyScript() { |
2166 |
return mainBodyScript; |
|
2167 |
} |
|
53866
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2168 |
|
54936 | 2169 |
/** |
2170 |
* Returns the path of module/package specific stylesheets for the element. |
|
2171 |
* @param element module/Package element |
|
2172 |
* @return list of path of module/package specific stylesheets |
|
2173 |
* @throws DocFileIOException |
|
2174 |
*/ |
|
2175 |
List<DocPath> getLocalStylesheets(Element element) throws DocFileIOException { |
|
2176 |
List<DocPath> stylesheets = new ArrayList<>(); |
|
2177 |
DocPath basePath = null; |
|
2178 |
if (element instanceof PackageElement) { |
|
2179 |
stylesheets.addAll(getModuleStylesheets((PackageElement)element)); |
|
2180 |
basePath = docPaths.forPackage((PackageElement)element); |
|
2181 |
} else if (element instanceof ModuleElement) { |
|
2182 |
basePath = DocPaths.forModule((ModuleElement)element); |
|
2183 |
} |
|
2184 |
for (DocPath stylesheet : getStylesheets(element)) { |
|
2185 |
stylesheets.add(basePath.resolve(stylesheet.getPath())); |
|
2186 |
} |
|
2187 |
return stylesheets; |
|
2188 |
} |
|
2189 |
||
2190 |
private List<DocPath> getModuleStylesheets(PackageElement pkgElement) throws |
|
2191 |
DocFileIOException { |
|
2192 |
List<DocPath> moduleStylesheets = new ArrayList<>(); |
|
2193 |
ModuleElement moduleElement = utils.containingModule(pkgElement); |
|
2194 |
if (moduleElement != null && !moduleElement.isUnnamed()) { |
|
2195 |
List<DocPath> localStylesheets = getStylesheets(moduleElement); |
|
2196 |
DocPath basePath = DocPaths.forModule(moduleElement); |
|
2197 |
for (DocPath stylesheet : localStylesheets) { |
|
2198 |
moduleStylesheets.add(basePath.resolve(stylesheet)); |
|
2199 |
} |
|
2200 |
} |
|
2201 |
return moduleStylesheets; |
|
2202 |
} |
|
2203 |
||
2204 |
private List<DocPath> getStylesheets(Element element) throws DocFileIOException { |
|
53866
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2205 |
List<DocPath> localStylesheets = configuration.localStylesheetMap.get(element); |
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2206 |
if (localStylesheets == null) { |
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2207 |
DocFilesHandlerImpl docFilesHandler = (DocFilesHandlerImpl)configuration |
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2208 |
.getWriterFactory().getDocFilesHandler(element); |
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2209 |
localStylesheets = docFilesHandler.getStylesheets(); |
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2210 |
configuration.localStylesheetMap.put(element, localStylesheets); |
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2211 |
} |
54936 | 2212 |
return localStylesheets; |
53866
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2213 |
} |
880baf6db17b
8213354: Support package-specific stylesheets
pmuthuswamy
parents:
53863
diff
changeset
|
2214 |
|
10 | 2215 |
} |