author | pmuthuswamy |
Mon, 20 May 2019 14:42:32 +0530 | |
changeset 54936 | 8c63164bd540 |
parent 54610 | a9ab154b1384 |
child 59294 | 48b88b9c11eb |
permissions | -rw-r--r-- |
10 | 1 |
/* |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2 |
* Copyright (c) 1997, 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:
29957
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.formats.html; |
10 | 27 |
|
54610 | 28 |
import java.util.List; |
29 |
import java.util.SortedSet; |
|
14258 | 30 |
|
36526 | 31 |
import javax.lang.model.element.ModuleElement; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
32 |
import javax.lang.model.element.PackageElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
33 |
import javax.lang.model.element.TypeElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
34 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
35 |
import com.sun.source.doctree.DocTree; |
47846 | 36 |
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder; |
54610 | 37 |
import jdk.javadoc.internal.doclets.formats.html.markup.Entity; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
38 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
39 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
40 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; |
49551
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
41 |
import jdk.javadoc.internal.doclets.formats.html.markup.Navigation; |
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
42 |
import jdk.javadoc.internal.doclets.formats.html.markup.Navigation.PageMode; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
43 |
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; |
54610 | 44 |
import jdk.javadoc.internal.doclets.formats.html.markup.Table; |
45 |
import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader; |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
46 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
47 |
import jdk.javadoc.internal.doclets.toolkit.PackageSummaryWriter; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
48 |
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper; |
40587 | 49 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
54936 | 50 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
51 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
10 | 52 |
|
53 |
/** |
|
54 |
* Class to generate file for each package contents in the right-hand |
|
55 |
* frame. This will list all the Class Kinds in the package. A click on any |
|
56 |
* class-kind will update the frame with the clicked class-kind page. |
|
57 |
* |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
58 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
59 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
60 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
61 |
* deletion without notice.</b> |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
62 |
* |
10 | 63 |
* @author Atul M Dambalkar |
2320
5b8c377175f4
6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers
bpatel
parents:
1787
diff
changeset
|
64 |
* @author Bhavesh Patel (Modified) |
10 | 65 |
*/ |
66 |
public class PackageWriterImpl extends HtmlDocletWriter |
|
67 |
implements PackageSummaryWriter { |
|
68 |
||
69 |
/** |
|
70 |
* The package being documented. |
|
71 |
*/ |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
72 |
protected PackageElement packageElement; |
10 | 73 |
|
74 |
/** |
|
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
75 |
* The HTML tree for main tag. |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
76 |
*/ |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
77 |
protected HtmlTree mainTree = HtmlTree.MAIN(); |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
78 |
|
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
79 |
/** |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
80 |
* The HTML tree for section tag. |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
81 |
*/ |
54596
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
82 |
protected HtmlTree sectionTree = HtmlTree.SECTION(HtmlStyle.packageDescription, new ContentBuilder()); |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
83 |
|
49551
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
84 |
private final Navigation navBar; |
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
85 |
|
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
86 |
/** |
10 | 87 |
* Constructor to construct PackageWriter object and to generate |
88 |
* "package-summary.html" file in the respective package directory. |
|
89 |
* For example for package "java.lang" this will generate file |
|
90 |
* "package-summary.html" file in the "java/lang" directory. It will also |
|
91 |
* create "java/lang" directory in the current or the destination directory |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14265
diff
changeset
|
92 |
* if it doesn't exist. |
10 | 93 |
* |
94 |
* @param configuration the configuration of the doclet. |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
95 |
* @param packageElement PackageElement under consideration. |
10 | 96 |
*/ |
48756
ce608a09a666
8196027: Remove "Prev" and "Next" links from the javadoc navigation
bpatel
parents:
48654
diff
changeset
|
97 |
public PackageWriterImpl(HtmlConfiguration configuration, PackageElement packageElement) { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
98 |
super(configuration, |
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48756
diff
changeset
|
99 |
configuration.docPaths.forPackage(packageElement) |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
100 |
.resolve(DocPaths.PACKAGE_SUMMARY)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
101 |
this.packageElement = packageElement; |
49551
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
102 |
this.navBar = new Navigation(packageElement, configuration, fixedNavDiv, PageMode.PACKAGE, path); |
10 | 103 |
} |
104 |
||
105 |
/** |
|
106 |
* {@inheritDoc} |
|
107 |
*/ |
|
40587 | 108 |
@Override |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
109 |
public Content getPackageHeader(String heading) { |
54350
4f9772f4403d
8215599: Remove support for javadoc "frames" mode
pmuthuswamy
parents:
54060
diff
changeset
|
110 |
HtmlTree bodyTree = getBody(getWindowTitle(utils.getPackageName(packageElement))); |
53562 | 111 |
HtmlTree htmlTree = HtmlTree.HEADER(); |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
112 |
addTop(htmlTree); |
49551
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
113 |
Content linkContent = getModuleLink(utils.elementUtils.getModuleOf(packageElement), |
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
114 |
contents.moduleLabel); |
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
115 |
navBar.setNavLinkModule(linkContent); |
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
116 |
navBar.setUserHeader(getUserHeaderFooter(true)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
117 |
htmlTree.add(navBar.getContent(true)); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
118 |
bodyTree.add(htmlTree); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
119 |
HtmlTree div = new HtmlTree(HtmlTag.DIV); |
47846 | 120 |
div.setStyle(HtmlStyle.header); |
40503
cb34fd6e8071
8135291: [javadoc] broken link in Package com.sun.tools.jconsole
bpatel
parents:
40303
diff
changeset
|
121 |
if (configuration.showModules) { |
42824 | 122 |
ModuleElement mdle = configuration.docEnv.getElementUtils().getModuleOf(packageElement); |
44196
f88c0e9cb102
8174974: Annotation type pages generated by javadoc is missing module information
bpatel
parents:
42824
diff
changeset
|
123 |
Content classModuleLabel = HtmlTree.SPAN(HtmlStyle.moduleLabelInPackage, contents.moduleLabel); |
36526 | 124 |
Content moduleNameDiv = HtmlTree.DIV(HtmlStyle.subTitle, classModuleLabel); |
54610 | 125 |
moduleNameDiv.add(Entity.NO_BREAK_SPACE); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
126 |
moduleNameDiv.add(getModuleLink(mdle, |
36526 | 127 |
new StringContent(mdle.getQualifiedName().toString()))); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
128 |
div.add(moduleNameDiv); |
36526 | 129 |
} |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
130 |
Content annotationContent = new HtmlTree(HtmlTag.P); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
131 |
addAnnotationInfo(packageElement, annotationContent); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
132 |
div.add(annotationContent); |
53991 | 133 |
Content tHeading = HtmlTree.HEADING(Headings.PAGE_TITLE_HEADING, true, |
40303 | 134 |
HtmlStyle.title, contents.packageLabel); |
54610 | 135 |
tHeading.add(Entity.NO_BREAK_SPACE); |
17569 | 136 |
Content packageHead = new StringContent(heading); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
137 |
tHeading.add(packageHead); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
138 |
div.add(tHeading); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
139 |
mainTree.add(div); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
140 |
return bodyTree; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
141 |
} |
10 | 142 |
|
143 |
/** |
|
144 |
* {@inheritDoc} |
|
145 |
*/ |
|
40587 | 146 |
@Override |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
147 |
public Content getContentHeader() { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
148 |
HtmlTree div = new HtmlTree(HtmlTag.DIV); |
47846 | 149 |
div.setStyle(HtmlStyle.contentContainer); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
150 |
return div; |
10 | 151 |
} |
152 |
||
153 |
/** |
|
9606
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
154 |
* Add the package deprecation information to the documentation tree. |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
155 |
* |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
156 |
* @param div the content tree to which the deprecation information will be added |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
157 |
*/ |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
158 |
public void addDeprecationInfo(Content div) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
159 |
List<? extends DocTree> deprs = utils.getBlockTags(packageElement, DocTree.Kind.DEPRECATED); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
160 |
if (utils.isDeprecated(packageElement)) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
161 |
CommentHelper ch = utils.getCommentHelper(packageElement); |
9606
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
162 |
HtmlTree deprDiv = new HtmlTree(HtmlTag.DIV); |
47846 | 163 |
deprDiv.setStyle(HtmlStyle.deprecationBlock); |
42816
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
41453
diff
changeset
|
164 |
Content deprPhrase = HtmlTree.SPAN(HtmlStyle.deprecatedLabel, getDeprecatedPhrase(packageElement)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
165 |
deprDiv.add(deprPhrase); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
166 |
if (!deprs.isEmpty()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
167 |
List<? extends DocTree> commentTags = ch.getDescription(configuration, deprs.get(0)); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
168 |
if (!commentTags.isEmpty()) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
169 |
addInlineDeprecatedComment(packageElement, deprs.get(0), deprDiv); |
9606
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
170 |
} |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
171 |
} |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
172 |
div.add(deprDiv); |
9606
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
173 |
} |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
174 |
} |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
175 |
|
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
9068
diff
changeset
|
176 |
/** |
10 | 177 |
* {@inheritDoc} |
178 |
*/ |
|
40587 | 179 |
@Override |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
180 |
public Content getSummaryHeader() { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
181 |
HtmlTree ul = new HtmlTree(HtmlTag.UL); |
47846 | 182 |
ul.setStyle(HtmlStyle.blockList); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
183 |
return ul; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
184 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
185 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
186 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
187 |
* {@inheritDoc} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
188 |
*/ |
40587 | 189 |
@Override |
47427 | 190 |
public void addInterfaceSummary(SortedSet<TypeElement> interfaces, Content summaryContentTree) { |
191 |
TableHeader tableHeader= new TableHeader(contents.interfaceLabel, contents.descriptionLabel); |
|
53562 | 192 |
addClassesSummary(interfaces, resources.interfaceSummary, tableHeader, summaryContentTree); |
47427 | 193 |
} |
194 |
||
195 |
/** |
|
196 |
* {@inheritDoc} |
|
197 |
*/ |
|
198 |
@Override |
|
199 |
public void addClassSummary(SortedSet<TypeElement> classes, Content summaryContentTree) { |
|
200 |
TableHeader tableHeader= new TableHeader(contents.classLabel, contents.descriptionLabel); |
|
53562 | 201 |
addClassesSummary(classes, resources.classSummary, tableHeader, summaryContentTree); |
47427 | 202 |
} |
203 |
||
204 |
/** |
|
205 |
* {@inheritDoc} |
|
206 |
*/ |
|
207 |
@Override |
|
208 |
public void addEnumSummary(SortedSet<TypeElement> enums, Content summaryContentTree) { |
|
209 |
TableHeader tableHeader= new TableHeader(contents.enum_, contents.descriptionLabel); |
|
53562 | 210 |
addClassesSummary(enums, resources.enumSummary, tableHeader, summaryContentTree); |
47427 | 211 |
} |
212 |
||
213 |
/** |
|
214 |
* {@inheritDoc} |
|
215 |
*/ |
|
216 |
@Override |
|
217 |
public void addExceptionSummary(SortedSet<TypeElement> exceptions, Content summaryContentTree) { |
|
218 |
TableHeader tableHeader= new TableHeader(contents.exception, contents.descriptionLabel); |
|
53562 | 219 |
addClassesSummary(exceptions, resources.exceptionSummary, tableHeader, summaryContentTree); |
47427 | 220 |
} |
221 |
||
222 |
/** |
|
223 |
* {@inheritDoc} |
|
224 |
*/ |
|
225 |
@Override |
|
226 |
public void addErrorSummary(SortedSet<TypeElement> errors, Content summaryContentTree) { |
|
227 |
TableHeader tableHeader= new TableHeader(contents.error, contents.descriptionLabel); |
|
53562 | 228 |
addClassesSummary(errors, resources.errorSummary, tableHeader, summaryContentTree); |
47427 | 229 |
} |
230 |
||
231 |
/** |
|
232 |
* {@inheritDoc} |
|
233 |
*/ |
|
234 |
@Override |
|
235 |
public void addAnnotationTypeSummary(SortedSet<TypeElement> annoTypes, Content summaryContentTree) { |
|
236 |
TableHeader tableHeader= new TableHeader(contents.annotationType, contents.descriptionLabel); |
|
53562 | 237 |
addClassesSummary(annoTypes, resources.annotationTypeSummary, tableHeader, summaryContentTree); |
47427 | 238 |
} |
239 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
240 |
public void addClassesSummary(SortedSet<TypeElement> classes, String label, |
53562 | 241 |
TableHeader tableHeader, Content summaryContentTree) { |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
242 |
if(!classes.isEmpty()) { |
53562 | 243 |
Table table = new Table(HtmlStyle.typeSummary) |
47846 | 244 |
.setCaption(getTableCaption(new StringContent(label))) |
245 |
.setHeader(tableHeader) |
|
246 |
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast); |
|
247 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
248 |
for (TypeElement klass : classes) { |
47846 | 249 |
if (!utils.isCoreClass(klass) || !configuration.isGeneratedDoc(klass)) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
250 |
continue; |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
251 |
} |
47846 | 252 |
Content classLink = getLink(new LinkInfoImpl( |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
253 |
configuration, LinkInfoImpl.Kind.PACKAGE, klass)); |
47846 | 254 |
ContentBuilder description = new ContentBuilder(); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
255 |
if (utils.isDeprecated(klass)) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
256 |
description.add(getDeprecatedPhrase(klass)); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
257 |
List<? extends DocTree> tags = utils.getDeprecatedTrees(klass); |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
258 |
if (!tags.isEmpty()) { |
47846 | 259 |
addSummaryDeprecatedComment(klass, tags.get(0), description); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
260 |
} |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
261 |
} else { |
47846 | 262 |
addSummaryComment(klass, description); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
263 |
} |
47846 | 264 |
table.addRow(classLink, description); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
265 |
} |
47846 | 266 |
Content li = HtmlTree.LI(HtmlStyle.blockList, table.toContent()); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
267 |
summaryContentTree.add(li); |
10 | 268 |
} |
269 |
} |
|
270 |
||
271 |
/** |
|
272 |
* {@inheritDoc} |
|
273 |
*/ |
|
40587 | 274 |
@Override |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
275 |
public void addPackageDescription(Content packageContentTree) { |
41453
5429549751ad
4649116: Add option to include full package description at top, before interface table
bpatel
parents:
41452
diff
changeset
|
276 |
if (!utils.getBody(packageElement).isEmpty()) { |
53562 | 277 |
Content tree = sectionTree; |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
278 |
tree.add(links.createAnchor(SectionName.PACKAGE_DESCRIPTION)); |
41453
5429549751ad
4649116: Add option to include full package description at top, before interface table
bpatel
parents:
41452
diff
changeset
|
279 |
addDeprecationInfo(tree); |
5429549751ad
4649116: Add option to include full package description at top, before interface table
bpatel
parents:
41452
diff
changeset
|
280 |
addInlineComment(packageElement, tree); |
10 | 281 |
} |
282 |
} |
|
283 |
||
284 |
/** |
|
285 |
* {@inheritDoc} |
|
286 |
*/ |
|
40587 | 287 |
@Override |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
288 |
public void addPackageTags(Content packageContentTree) { |
53562 | 289 |
Content htmlTree = sectionTree; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
290 |
addTagsInfo(packageElement, htmlTree); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
291 |
packageContentTree.add(sectionTree); |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
292 |
} |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
293 |
|
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
294 |
/** |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
295 |
* {@inheritDoc} |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
296 |
*/ |
40587 | 297 |
@Override |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
298 |
public void addPackageContent(Content contentTree, Content packageContentTree) { |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
299 |
mainTree.add(packageContentTree); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
300 |
contentTree.add(mainTree); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
301 |
} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
302 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
303 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
304 |
* {@inheritDoc} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
305 |
*/ |
40587 | 306 |
@Override |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
307 |
public void addPackageFooter(Content contentTree) { |
53562 | 308 |
Content htmlTree = HtmlTree.FOOTER(); |
49551
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
48759
diff
changeset
|
309 |
navBar.setUserFooter(getUserHeaderFooter(false)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
310 |
htmlTree.add(navBar.getContent(false)); |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
26664
diff
changeset
|
311 |
addBottom(htmlTree); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
312 |
contentTree.add(htmlTree); |
7614
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 |
|
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 |
* {@inheritDoc} |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
317 |
*/ |
40587 | 318 |
@Override |
319 |
public void printDocument(Content contentTree) throws DocFileIOException { |
|
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
320 |
String description = getDescription("declaration", packageElement); |
54936 | 321 |
List<DocPath> localStylesheets = getLocalStylesheets(packageElement); |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
322 |
printHtmlDocument(configuration.metakeywords.getMetaKeywords(packageElement), |
54936 | 323 |
description, localStylesheets, contentTree); |
10 | 324 |
} |
54596
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
325 |
|
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
326 |
/** |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
327 |
* {@inheritDoc} |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
328 |
*/ |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
329 |
@Override |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
330 |
public Content getPackageSummary(Content summaryContentTree) { |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
331 |
return HtmlTree.SECTION(HtmlStyle.summary, summaryContentTree); |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
54350
diff
changeset
|
332 |
} |
10 | 333 |
} |