author | jjg |
Mon, 18 Jun 2018 13:52:30 -0700 | |
changeset 50612 | e10812a82a3b |
parent 48759 | ffa68af7da87 |
child 51190 | fb4a7b894fac |
permissions | -rw-r--r-- |
10 | 1 |
/* |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
47850
diff
changeset
|
2 |
* Copyright (c) 2003, 2018, 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; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
27 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
28 |
import java.util.List; |
40303 | 29 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
30 |
import javax.lang.model.element.Element; |
40511 | 31 |
import javax.lang.model.element.ModuleElement; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
32 |
import javax.lang.model.element.PackageElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
33 |
import javax.lang.model.element.TypeElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
34 |
import javax.lang.model.element.VariableElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
35 |
import javax.lang.model.type.TypeMirror; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
36 |
import javax.lang.model.util.SimpleElementVisitor9; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
37 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
38 |
import com.sun.source.doctree.DocTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
39 |
import com.sun.source.doctree.IndexTree; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
40 |
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
41 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
42 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; |
47850 | 43 |
import jdk.javadoc.internal.doclets.formats.html.markup.Links; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
44 |
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
45 |
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; |
45417 | 46 |
import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
47 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
48 |
import jdk.javadoc.internal.doclets.toolkit.builders.SerializedFormBuilder; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
49 |
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletWriter; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
50 |
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
51 |
import jdk.javadoc.internal.doclets.toolkit.util.DocLink; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
52 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
53 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
54 |
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
55 |
import jdk.javadoc.internal.doclets.toolkit.util.Utils; |
10 | 56 |
|
57 |
/** |
|
58 |
* The taglet writer that writes HTML. |
|
59 |
* |
|
14260 | 60 |
* <p><b>This is NOT part of any supported API. |
61 |
* If you write code that depends on this, you do so at your own risk. |
|
62 |
* This code and its internal interfaces are subject to change or |
|
63 |
* deletion without notice.</b> |
|
64 |
* |
|
10 | 65 |
* @author Jamie Ho |
2216
b124d5c924eb
6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents:
1787
diff
changeset
|
66 |
* @author Bhavesh Patel (Modified) |
10 | 67 |
*/ |
68 |
||
69 |
public class TagletWriterImpl extends TagletWriter { |
|
70 |
||
14542 | 71 |
private final HtmlDocletWriter htmlWriter; |
45417 | 72 |
private final HtmlConfiguration configuration; |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
22159
diff
changeset
|
73 |
private final Utils utils; |
10 | 74 |
|
75 |
public TagletWriterImpl(HtmlDocletWriter htmlWriter, boolean isFirstSentence) { |
|
14542 | 76 |
super(isFirstSentence); |
10 | 77 |
this.htmlWriter = htmlWriter; |
14542 | 78 |
configuration = htmlWriter.configuration; |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
22159
diff
changeset
|
79 |
this.utils = configuration.utils; |
10 | 80 |
} |
81 |
||
82 |
/** |
|
83 |
* {@inheritDoc} |
|
84 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
85 |
public Content getOutputInstance() { |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
86 |
return new ContentBuilder(); |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
87 |
} |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
88 |
|
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
89 |
/** |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
90 |
* {@inheritDoc} |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
91 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
92 |
protected Content codeTagOutput(Element element, DocTree tag) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
93 |
CommentHelper ch = utils.getCommentHelper(element); |
36500
d31e4986dc8b
8149139: [javadoc] Modify Content to accept CharSequence
ksrini
parents:
35426
diff
changeset
|
94 |
StringContent content = new StringContent(utils.normalizeNewlines(ch.getText(tag))); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
95 |
Content result = HtmlTree.CODE(content); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
96 |
return result; |
10 | 97 |
} |
98 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
99 |
protected Content indexTagOutput(Element element, DocTree tag) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
100 |
CommentHelper ch = utils.getCommentHelper(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
101 |
IndexTree itt = (IndexTree)tag; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
102 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
103 |
String tagText = ch.getText(itt.getSearchTerm()); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
104 |
if (tagText.charAt(0) == '"' && tagText.charAt(tagText.length() - 1) == '"') { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
105 |
tagText = tagText.substring(1, tagText.length() - 1); |
33920 | 106 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
107 |
String desc = ch.getText(itt.getDescription()); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
108 |
|
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
47850
diff
changeset
|
109 |
String anchorName = htmlWriter.links.getName(tagText); |
44567
126285be00b9
8175218: The fix for JDK-8141492 broke formatting of some javadoc documentation.
bpatel
parents:
42816
diff
changeset
|
110 |
Content result = HtmlTree.A_ID(HtmlStyle.searchTagResult, anchorName, new StringContent(tagText)); |
33920 | 111 |
if (configuration.createindex && !tagText.isEmpty()) { |
112 |
SearchIndexItem si = new SearchIndexItem(); |
|
113 |
si.setLabel(tagText); |
|
114 |
si.setDescription(desc); |
|
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48654
diff
changeset
|
115 |
DocPaths docPaths = configuration.docPaths; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
116 |
new SimpleElementVisitor9<Void, Void>() { |
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40511
diff
changeset
|
117 |
@Override |
40511 | 118 |
public Void visitModule(ModuleElement e, Void p) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48654
diff
changeset
|
119 |
si.setUrl(docPaths.moduleSummary(e).getPath() + "#" + anchorName); |
45771
e447c20c3ff9
8182736: javadoc generates bad names and broken module graph links
jjg
parents:
44567
diff
changeset
|
120 |
si.setHolder(utils.getFullyQualifiedName(element)); |
40511 | 121 |
return null; |
122 |
} |
|
123 |
||
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40511
diff
changeset
|
124 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
125 |
public Void visitPackage(PackageElement e, Void p) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48654
diff
changeset
|
126 |
si.setUrl(docPaths.forPackage(e).getPath() |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
127 |
+ "/" + DocPaths.PACKAGE_SUMMARY.getPath() + "#" + anchorName); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
128 |
si.setHolder(utils.getSimpleName(element)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
129 |
return null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
130 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
131 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40511
diff
changeset
|
132 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
133 |
public Void visitType(TypeElement e, Void p) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48654
diff
changeset
|
134 |
si.setUrl(docPaths.forClass(e).getPath() + "#" + anchorName); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
135 |
si.setHolder(utils.getFullyQualifiedName(e)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
136 |
return null; |
33920 | 137 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
138 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40511
diff
changeset
|
139 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
140 |
public Void visitVariable(VariableElement e, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
141 |
TypeElement te = utils.getEnclosingTypeElement(e); |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48654
diff
changeset
|
142 |
si.setUrl(docPaths.forClass(te).getPath() + "#" + anchorName); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
143 |
si.setHolder(utils.getFullyQualifiedName(e) + "." + utils.getSimpleName(e)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
144 |
return null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
145 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
146 |
|
40606
eb2c81860c86
8164836: TEST_BUG: adjust scope of the DefinedByAnalyzer in tools/all/RunCodingRules.java
jlahoda
parents:
40511
diff
changeset
|
147 |
@Override |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
148 |
protected Void defaultAction(Element e, Void p) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
149 |
TypeElement te = utils.getEnclosingTypeElement(e); |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48654
diff
changeset
|
150 |
si.setUrl(docPaths.forClass(te).getPath() + "#" + anchorName); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
151 |
si.setHolder(utils.getFullyQualifiedName(e)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
152 |
return null; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
153 |
} |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
154 |
}.visit(element); |
40303 | 155 |
si.setCategory(configuration.getContent("doclet.SearchTags").toString()); |
33920 | 156 |
configuration.tagSearchIndex.add(si); |
157 |
} |
|
158 |
return result; |
|
159 |
} |
|
160 |
||
10 | 161 |
/** |
162 |
* {@inheritDoc} |
|
163 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
164 |
public Content getDocRootOutput() { |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
165 |
String path; |
22005
4270ada5dcd1
8025416: doclet not substituting {@docRoot} in some cases
bpatel
parents:
21478
diff
changeset
|
166 |
if (htmlWriter.pathToRoot.isEmpty()) |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
167 |
path = "."; |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
168 |
else |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
169 |
path = htmlWriter.pathToRoot.getPath(); |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
170 |
return new StringContent(path); |
17565
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
171 |
} |
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
172 |
|
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
173 |
/** |
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
174 |
* {@inheritDoc} |
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
175 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
176 |
public Content deprecatedTagOutput(Element element) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
177 |
ContentBuilder result = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
178 |
CommentHelper ch = utils.getCommentHelper(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
179 |
List<? extends DocTree> deprs = utils.getBlockTags(element, DocTree.Kind.DEPRECATED); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
180 |
if (utils.isTypeElement(element)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
181 |
if (utils.isDeprecated(element)) { |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
182 |
result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel, |
42816
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
40606
diff
changeset
|
183 |
htmlWriter.getDeprecatedPhrase(element))); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
184 |
if (!deprs.isEmpty()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
185 |
List<? extends DocTree> commentTags = ch.getDescription(configuration, deprs.get(0)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
186 |
if (!commentTags.isEmpty()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
187 |
result.addContent(commentTagsToOutput(null, element, commentTags, false)); |
10 | 188 |
} |
189 |
} |
|
190 |
} |
|
191 |
} else { |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
192 |
if (utils.isDeprecated(element)) { |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
193 |
result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel, |
42816
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
40606
diff
changeset
|
194 |
htmlWriter.getDeprecatedPhrase(element))); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
195 |
if (!deprs.isEmpty()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
196 |
List<? extends DocTree> bodyTags = ch.getBody(configuration, deprs.get(0)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
197 |
Content body = commentTagsToOutput(null, element, bodyTags, false); |
21023
1192bdc59d82
8026370: javadoc creates empty <span class="italic"></span>
bpatel
parents:
19253
diff
changeset
|
198 |
if (!body.isEmpty()) |
47300
a905ce398074
8074407: javadoc: using <pre> after @deprecated tag causes warnings
bpatel
parents:
47216
diff
changeset
|
199 |
result.addContent(HtmlTree.DIV(HtmlStyle.deprecationComment, body)); |
10 | 200 |
} |
201 |
} else { |
|
42816
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
40606
diff
changeset
|
202 |
Element ee = utils.getEnclosingTypeElement(element); |
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
40606
diff
changeset
|
203 |
if (utils.isDeprecated(ee)) { |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
204 |
result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel, |
42816
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
40606
diff
changeset
|
205 |
htmlWriter.getDeprecatedPhrase(ee))); |
10 | 206 |
} |
207 |
} |
|
208 |
} |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
209 |
return result; |
10 | 210 |
} |
211 |
||
212 |
/** |
|
213 |
* {@inheritDoc} |
|
214 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
215 |
protected Content literalTagOutput(Element element, DocTree tag) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
216 |
CommentHelper ch = utils.getCommentHelper(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
217 |
Content result = new StringContent(utils.normalizeNewlines(ch.getText(tag))); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
218 |
return result; |
17565
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
219 |
} |
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
220 |
|
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
221 |
/** |
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
222 |
* {@inheritDoc} |
a705fe5e539f
8012174: {@literal} and {@code} should use \"new\" Taglet, not old.
jjg
parents:
17560
diff
changeset
|
223 |
*/ |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
224 |
public Content getParamHeader(String header) { |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
225 |
HtmlTree result = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.paramLabel, |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
226 |
new StringContent(header))); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
227 |
return result; |
10 | 228 |
} |
229 |
||
230 |
/** |
|
231 |
* {@inheritDoc} |
|
232 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
233 |
public Content paramTagOutput(Element element, DocTree paramTag, String paramName) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
234 |
ContentBuilder body = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
235 |
CommentHelper ch = utils.getCommentHelper(element); |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
236 |
body.addContent(HtmlTree.CODE(new RawHtml(paramName))); |
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
237 |
body.addContent(" - "); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
238 |
List<? extends DocTree> description = ch.getDescription(configuration, paramTag); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
239 |
body.addContent(htmlWriter.commentTagsToContent(paramTag, element, description, false)); |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
240 |
HtmlTree result = HtmlTree.DD(body); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
241 |
return result; |
10 | 242 |
} |
243 |
||
244 |
/** |
|
245 |
* {@inheritDoc} |
|
246 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
247 |
public Content propertyTagOutput(Element element, DocTree tag, String prefix) { |
17572 | 248 |
Content body = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
249 |
CommentHelper ch = utils.getCommentHelper(element); |
17572 | 250 |
body.addContent(new RawHtml(prefix)); |
251 |
body.addContent(" "); |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
252 |
body.addContent(HtmlTree.CODE(new RawHtml(ch.getText(tag)))); |
17572 | 253 |
body.addContent("."); |
254 |
Content result = HtmlTree.P(body); |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
255 |
return result; |
17572 | 256 |
} |
257 |
||
258 |
/** |
|
259 |
* {@inheritDoc} |
|
260 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
261 |
public Content returnTagOutput(Element element, DocTree returnTag) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
262 |
ContentBuilder result = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
263 |
CommentHelper ch = utils.getCommentHelper(element); |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
264 |
result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.returnLabel, |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
265 |
new StringContent(configuration.getText("doclet.Returns"))))); |
17568
d9691936f5f9
8012177: HTMLDocletWriter methods should generate Content, not Strings
jjg
parents:
17567
diff
changeset
|
266 |
result.addContent(HtmlTree.DD(htmlWriter.commentTagsToContent( |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
267 |
returnTag, element, ch.getDescription(configuration, returnTag), false))); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
268 |
return result; |
10 | 269 |
} |
270 |
||
271 |
/** |
|
272 |
* {@inheritDoc} |
|
273 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
274 |
public Content seeTagOutput(Element holder, List<? extends DocTree> seeTags) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
275 |
ContentBuilder body = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
276 |
if (!seeTags.isEmpty()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
277 |
for (DocTree dt : seeTags) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
278 |
appendSeparatorIfNotEmpty(body); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
279 |
body.addContent(htmlWriter.seeTagToContent(holder, dt)); |
10 | 280 |
} |
281 |
} |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
282 |
if (utils.isVariableElement(holder) && ((VariableElement)holder).getConstantValue() != null && |
10 | 283 |
htmlWriter instanceof ClassWriterImpl) { |
284 |
//Automatically add link to constant values page for constant fields. |
|
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
285 |
appendSeparatorIfNotEmpty(body); |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
286 |
DocPath constantsPath = |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
287 |
htmlWriter.pathToRoot.resolve(DocPaths.CONSTANT_VALUES); |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
288 |
String whichConstant = |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
289 |
((ClassWriterImpl) htmlWriter).getTypeElement().getQualifiedName() + "." + |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
290 |
utils.getSimpleName(holder); |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
291 |
DocLink link = constantsPath.fragment(whichConstant); |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
47850
diff
changeset
|
292 |
body.addContent(htmlWriter.links.createLink(link, |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
293 |
new StringContent(configuration.getText("doclet.Constants_Summary")))); |
10 | 294 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
295 |
if (utils.isClass(holder) && utils.isSerializable((TypeElement)holder)) { |
10 | 296 |
//Automatically add link to serialized form page for serializable classes. |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
297 |
if (SerializedFormBuilder.serialInclude(utils, holder) && |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
298 |
SerializedFormBuilder.serialInclude(utils, utils.containingPackage(holder))) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
299 |
appendSeparatorIfNotEmpty(body); |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
300 |
DocPath serialPath = htmlWriter.pathToRoot.resolve(DocPaths.SERIALIZED_FORM); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
301 |
DocLink link = serialPath.fragment(utils.getFullyQualifiedName(holder)); |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
47850
diff
changeset
|
302 |
body.addContent(htmlWriter.links.createLink(link, |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
303 |
new StringContent(configuration.getText("doclet.Serialized_Form")))); |
10 | 304 |
} |
305 |
} |
|
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
306 |
if (body.isEmpty()) |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
307 |
return body; |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
308 |
|
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
309 |
ContentBuilder result = new ContentBuilder(); |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
310 |
result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.seeLabel, |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
311 |
new StringContent(configuration.getText("doclet.See_Also"))))); |
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
312 |
result.addContent(HtmlTree.DD(body)); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
313 |
return result; |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
314 |
|
10 | 315 |
} |
316 |
||
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
317 |
private void appendSeparatorIfNotEmpty(ContentBuilder body) { |
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
318 |
if (!body.isEmpty()) { |
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
319 |
body.addContent(", "); |
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
320 |
body.addContent(DocletConstants.NL); |
10 | 321 |
} |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
322 |
} |
10 | 323 |
|
324 |
/** |
|
325 |
* {@inheritDoc} |
|
326 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
327 |
public Content simpleTagOutput(Element element, List<? extends DocTree> simpleTags, String header) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
328 |
CommentHelper ch = utils.getCommentHelper(element); |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
329 |
ContentBuilder result = new ContentBuilder(); |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
330 |
result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.simpleTagLabel, new RawHtml(header)))); |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
331 |
ContentBuilder body = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
332 |
boolean many = false; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
333 |
for (DocTree simpleTag : simpleTags) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
334 |
if (many) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
335 |
body.addContent(", "); |
10 | 336 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
337 |
List<? extends DocTree> bodyTags = ch.getBody(configuration, simpleTag); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
338 |
body.addContent(htmlWriter.commentTagsToContent(simpleTag, element, bodyTags, false)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
339 |
many = true; |
10 | 340 |
} |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
341 |
result.addContent(HtmlTree.DD(body)); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
342 |
return result; |
10 | 343 |
} |
344 |
||
345 |
/** |
|
346 |
* {@inheritDoc} |
|
347 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
348 |
public Content simpleTagOutput(Element element, DocTree simpleTag, String header) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
349 |
ContentBuilder result = new ContentBuilder(); |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
350 |
result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.simpleTagLabel, new RawHtml(header)))); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
351 |
CommentHelper ch = utils.getCommentHelper(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
352 |
List<? extends DocTree> description = ch.getDescription(configuration, simpleTag); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
353 |
Content body = htmlWriter.commentTagsToContent(simpleTag, element, description, false); |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
354 |
result.addContent(HtmlTree.DD(body)); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
355 |
return result; |
10 | 356 |
} |
357 |
||
358 |
/** |
|
359 |
* {@inheritDoc} |
|
360 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
361 |
public Content getThrowsHeader() { |
21478
fa4c7cda1b41
8026567: Use meaningful style names for strong and italic styles.
bpatel
parents:
21023
diff
changeset
|
362 |
HtmlTree result = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.throwsLabel, |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
363 |
new StringContent(configuration.getText("doclet.Throws")))); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
364 |
return result; |
10 | 365 |
} |
366 |
||
367 |
/** |
|
368 |
* {@inheritDoc} |
|
369 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
370 |
public Content throwsTagOutput(Element element, DocTree throwsTag) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
371 |
ContentBuilder body = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
372 |
CommentHelper ch = utils.getCommentHelper(element); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
373 |
Element exception = ch.getException(configuration, throwsTag); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
374 |
Content excName; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
375 |
if (exception == null) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
376 |
excName = new RawHtml(ch.getExceptionName(throwsTag).toString()); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
377 |
} else if (exception.asType() == null) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
378 |
excName = new RawHtml(utils.getFullyQualifiedName(exception)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
379 |
} else { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
380 |
LinkInfoImpl link = new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
381 |
exception.asType()); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
382 |
link.excludeTypeBounds = true; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
383 |
excName = htmlWriter.getLink(link); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
384 |
} |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
385 |
body.addContent(HtmlTree.CODE(excName)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
386 |
List<? extends DocTree> description = ch.getDescription(configuration, throwsTag); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
387 |
Content desc = htmlWriter.commentTagsToContent(throwsTag, element, description, false); |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
388 |
if (desc != null && !desc.isEmpty()) { |
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
389 |
body.addContent(" - "); |
17568
d9691936f5f9
8012177: HTMLDocletWriter methods should generate Content, not Strings
jjg
parents:
17567
diff
changeset
|
390 |
body.addContent(desc); |
10 | 391 |
} |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
392 |
HtmlTree result = HtmlTree.DD(body); |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
393 |
return result; |
10 | 394 |
} |
395 |
||
396 |
/** |
|
397 |
* {@inheritDoc} |
|
398 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
399 |
public Content throwsTagOutput(TypeMirror throwsType) { |
17566
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
400 |
HtmlTree result = HtmlTree.DD(HtmlTree.CODE(htmlWriter.getLink( |
7e1a338e1085
8012175: Convert TagletOutputImpl to use ContentBuilder instead of StringBuilder
jjg
parents:
17565
diff
changeset
|
401 |
new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER, throwsType)))); |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17572
diff
changeset
|
402 |
return result; |
10 | 403 |
} |
404 |
||
405 |
/** |
|
406 |
* {@inheritDoc} |
|
407 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
408 |
public Content valueTagOutput(VariableElement field, String constantVal, boolean includeLink) { |
50612
e10812a82a3b
8204330: Javadoc IllegalArgumentException: HTML special chars in constant value
jjg
parents:
48759
diff
changeset
|
409 |
return includeLink |
e10812a82a3b
8204330: Javadoc IllegalArgumentException: HTML special chars in constant value
jjg
parents:
48759
diff
changeset
|
410 |
? htmlWriter.getDocLink(LinkInfoImpl.Kind.VALUE_TAG, field, constantVal, false) |
e10812a82a3b
8204330: Javadoc IllegalArgumentException: HTML special chars in constant value
jjg
parents:
48759
diff
changeset
|
411 |
: new StringContent(constantVal); |
10 | 412 |
} |
413 |
||
414 |
/** |
|
415 |
* {@inheritDoc} |
|
416 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
417 |
public Content commentTagsToOutput(DocTree holderTag, List<? extends DocTree> tags) { |
10 | 418 |
return commentTagsToOutput(holderTag, null, tags, false); |
419 |
} |
|
420 |
||
421 |
/** |
|
422 |
* {@inheritDoc} |
|
423 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
424 |
public Content commentTagsToOutput(Element holder, List<? extends DocTree> tags) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
425 |
return commentTagsToOutput(null, holder, tags, false); |
10 | 426 |
} |
427 |
||
428 |
/** |
|
429 |
* {@inheritDoc} |
|
430 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
431 |
public Content commentTagsToOutput(DocTree holderTag, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
432 |
Element holder, List<? extends DocTree> tags, boolean isFirstSentence) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
433 |
return htmlWriter.commentTagsToContent(holderTag, holder, |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
434 |
tags, isFirstSentence); |
10 | 435 |
} |
436 |
||
437 |
/** |
|
438 |
* {@inheritDoc} |
|
439 |
*/ |
|
45417 | 440 |
public BaseConfiguration configuration() { |
14542 | 441 |
return configuration; |
10 | 442 |
} |
443 |
} |