author | pmuthuswamy |
Wed, 19 Sep 2018 12:14:53 +0530 | |
changeset 51797 | 3efead10e303 |
parent 50167 | cc705c956798 |
child 52644 | 43efb4ca6d6c |
permissions | -rw-r--r-- |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
1 |
/* |
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
49551
diff
changeset
|
2 |
* Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
4 |
* |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
10 |
* |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
15 |
* accompanied this code). |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
16 |
* |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
20 |
* |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
23 |
* questions. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
24 |
*/ |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
25 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.formats.html; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
27 |
|
47846 | 28 |
import jdk.javadoc.internal.doclets.formats.html.markup.Table; |
29 |
import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader; |
|
30 |
||
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
31 |
import java.util.*; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
32 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
33 |
import javax.lang.model.element.ModuleElement; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
34 |
import javax.lang.model.element.PackageElement; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
35 |
|
47846 | 36 |
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder; |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
37 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
38 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
39 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
40 |
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
41 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
40587 | 42 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
43 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
44 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
45 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
46 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
47 |
* Generate the module index page "overview-summary.html" for the right-hand |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
48 |
* frame. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
49 |
* |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
50 |
* <p><b>This is NOT part of any supported API. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
51 |
* If you write code that depends on this, you do so at your own risk. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
52 |
* This code and its internal interfaces are subject to change or |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
53 |
* deletion without notice.</b> |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
54 |
* |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
55 |
* @author Bhavesh Patel |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
56 |
*/ |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
57 |
public class ModuleIndexWriter extends AbstractModuleIndexWriter { |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
58 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
59 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
60 |
* Construct the ModuleIndexWriter. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
61 |
* @param configuration the configuration object |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
62 |
* @param filename the name of the generated file |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
63 |
*/ |
45417 | 64 |
public ModuleIndexWriter(HtmlConfiguration configuration, DocPath filename) { |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
65 |
super(configuration, filename); |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
66 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
67 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
68 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
69 |
* Generate the module index page for the right-hand frame. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
70 |
* |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
71 |
* @param configuration the current configuration of the doclet. |
40587 | 72 |
* @throws DocFileIOException if there is a problem generating the module index page |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
73 |
*/ |
45417 | 74 |
public static void generate(HtmlConfiguration configuration) throws DocFileIOException { |
40500
f293dbb81a53
8162353: javadoc should provide a way to disable use of frames
jjg
parents:
40303
diff
changeset
|
75 |
DocPath filename = DocPaths.overviewSummary(configuration.frames); |
40587 | 76 |
ModuleIndexWriter mdlgen = new ModuleIndexWriter(configuration, filename); |
77 |
mdlgen.buildModuleIndexFile("doclet.Window_Overview_Summary", true); |
|
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
78 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
79 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
80 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
81 |
* Add the module index. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
82 |
* |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
83 |
* @param header the documentation tree to which the navigational links will be added |
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
84 |
* @param main the documentation tree to which the modules list will be added |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
85 |
*/ |
40587 | 86 |
@Override |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
87 |
protected void addIndex(Content header, Content main) { |
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
88 |
addIndexContents(header, main); |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
89 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
90 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
91 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
92 |
* Adds module index contents. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
93 |
* |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
94 |
* @param header the document tree to which the navigational links will be added |
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
95 |
* @param main the document tree to which the modules list will be added |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
96 |
*/ |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
97 |
protected void addIndexContents(Content header, Content main) { |
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
98 |
HtmlTree htmltree = (HtmlTree)createTagIfAllowed(HtmlTag.NAV, HtmlTree::NAV, () -> new HtmlTree(HtmlTag.DIV)); |
47846 | 99 |
htmltree.setStyle(HtmlStyle.indexNav); |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
100 |
HtmlTree ul = new HtmlTree(HtmlTag.UL); |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
101 |
addAllClassesLink(ul); |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
102 |
if (configuration.showModules) { |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
103 |
addAllModulesLink(ul); |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
104 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
105 |
htmltree.addContent(ul); |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
106 |
header.addContent(htmltree); |
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
107 |
addModulesList(main); |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
108 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
109 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
110 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
111 |
* Add the list of modules. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
112 |
* |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
113 |
* @param main the content tree to which the module list will be added |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
114 |
*/ |
47846 | 115 |
@Override |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
116 |
protected void addModulesList(Content main) { |
47846 | 117 |
Map<String, SortedSet<ModuleElement>> groupModuleMap |
118 |
= configuration.group.groupModules(configuration.modules); |
|
119 |
||
120 |
if (!groupModuleMap.keySet().isEmpty()) { |
|
47447
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47427
diff
changeset
|
121 |
String tableSummary = configuration.getText("doclet.Member_Table_Summary", |
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47427
diff
changeset
|
122 |
configuration.getText("doclet.Module_Summary"), configuration.getText("doclet.modules")); |
47846 | 123 |
TableHeader header = new TableHeader(contents.moduleLabel, contents.descriptionLabel); |
124 |
Table table = new Table(configuration.htmlVersion, HtmlStyle.overviewSummary) |
|
125 |
.setSummary(tableSummary) |
|
126 |
.setHeader(header) |
|
127 |
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast) |
|
128 |
.setDefaultTab(resources.getText("doclet.All_Modules")) |
|
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
49551
diff
changeset
|
129 |
.setTabScript(i -> "show(" + i + ");") |
47846 | 130 |
.setTabId(i -> (i == 0) ? "t0" : ("t" + (1 << (i - 1)))); |
131 |
||
132 |
// add the tabs in command-line order |
|
133 |
for (String groupName : configuration.group.getGroupList()) { |
|
134 |
Set<ModuleElement> groupModules = groupModuleMap.get(groupName); |
|
135 |
if (groupModules != null) { |
|
136 |
table.addTab(groupName, groupModules::contains); |
|
47447
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47427
diff
changeset
|
137 |
} |
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47427
diff
changeset
|
138 |
} |
47846 | 139 |
|
140 |
for (ModuleElement mdle : configuration.modules) { |
|
141 |
if (!mdle.isUnnamed()) { |
|
142 |
if (!(configuration.nodeprecated && utils.isDeprecated(mdle))) { |
|
143 |
Content moduleLinkContent = getModuleLink(mdle, new StringContent(mdle.getQualifiedName().toString())); |
|
144 |
Content summaryContent = new ContentBuilder(); |
|
145 |
addSummaryComment(mdle, summaryContent); |
|
146 |
table.addRow(mdle, moduleLinkContent, summaryContent); |
|
147 |
} |
|
148 |
} |
|
47447
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47427
diff
changeset
|
149 |
} |
47846 | 150 |
|
151 |
Content div = HtmlTree.DIV(HtmlStyle.contentContainer, table.toContent()); |
|
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
152 |
main.addContent(div); |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
153 |
|
47846 | 154 |
if (table.needsScript()) { |
47847 | 155 |
mainBodyScript.append(table.getScript()); |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
156 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
157 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
158 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
159 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
160 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
161 |
* Adds the overview summary comment for this documentation. Add one line |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
162 |
* summary at the top of the page and generate a link to the description, |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
163 |
* which is added at the end of this page. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
164 |
* |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
165 |
* @param main the documentation tree to which the overview header will be added |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
166 |
*/ |
40587 | 167 |
@Override |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
168 |
protected void addOverviewHeader(Content main) { |
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
169 |
addConfigurationTitle(main); |
41452 | 170 |
if (!utils.getFullBody(configuration.overviewElement).isEmpty()) { |
43755
ae42964e27e3
8173302: Move the Description up on module and package index page
ksrini
parents:
41452
diff
changeset
|
171 |
HtmlTree div = new HtmlTree(HtmlTag.DIV); |
47846 | 172 |
div.setStyle(HtmlStyle.contentContainer); |
43755
ae42964e27e3
8173302: Move the Description up on module and package index page
ksrini
parents:
41452
diff
changeset
|
173 |
addOverviewComment(div); |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
174 |
main.addContent(div); |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
175 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
176 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
177 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
178 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
179 |
* Adds the overview comment as provided in the file specified by the |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
180 |
* "-overview" option on the command line. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
181 |
* |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
182 |
* @param htmltree the documentation tree to which the overview comment will |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
183 |
* be added |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
184 |
*/ |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
185 |
protected void addOverviewComment(Content htmltree) { |
41452 | 186 |
if (!utils.getFullBody(configuration.overviewElement).isEmpty()) { |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
187 |
addInlineComment(configuration.overviewElement, htmltree); |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
188 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
189 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
190 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
191 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
192 |
* Adds the top text (from the -top option), the upper |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
193 |
* navigation bar, and then the title (from the"-title" |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
194 |
* option), at the top of page. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
195 |
* |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
196 |
* @param header the documentation tree to which the navigation bar header will be added |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
197 |
*/ |
40587 | 198 |
@Override |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
199 |
protected void addNavigationBarHeader(Content header) { |
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
200 |
addTop(header); |
49551
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
47847
diff
changeset
|
201 |
navBar.setUserHeader(getUserHeaderFooter(true)); |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
202 |
header.addContent(navBar.getContent(true)); |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
203 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
204 |
|
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
205 |
/** |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
206 |
* Adds the lower navigation bar and the bottom text |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
207 |
* (from the -bottom option) at the bottom of page. |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
208 |
* |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
209 |
* @param footer the documentation tree to which the navigation bar footer will be added |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
210 |
*/ |
40587 | 211 |
@Override |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
212 |
protected void addNavigationBarFooter(Content footer) { |
49551
0d4786e42471
8196200: Implement a navigation builder in javadoc
bpatel
parents:
47847
diff
changeset
|
213 |
navBar.setUserFooter(getUserHeaderFooter(false)); |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
214 |
footer.addContent(navBar.getContent(false)); |
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
215 |
addBottom(footer); |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
216 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
217 |
|
40587 | 218 |
@Override |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
219 |
protected void addModulePackagesList(Map<ModuleElement, Set<PackageElement>> modules, String text, |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
50167
diff
changeset
|
220 |
String tableSummary, Content main, ModuleElement mdle) { |
39586
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
221 |
} |
e35b6ab55e00
8157987: overview-summary.html generated by javadoc should include module information
bpatel
parents:
diff
changeset
|
222 |
} |