8199892: Missing landmarks when generating docs using html sources
Reviewed-by: jjg
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DocFilesHandlerImpl.java Mon Jan 14 09:48:30 2019 +0100
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DocFilesHandlerImpl.java Mon Jan 14 15:09:15 2019 +0530
@@ -25,16 +25,13 @@
package jdk.javadoc.internal.doclets.formats.html;
-import com.sun.source.doctree.AttributeTree;
-import com.sun.source.doctree.AttributeTree.ValueKind;
import com.sun.source.doctree.DocTree;
import com.sun.source.doctree.EndElementTree;
import com.sun.source.doctree.StartElementTree;
import com.sun.source.doctree.TextTree;
import com.sun.source.util.DocTreeFactory;
-import com.sun.source.util.SimpleDocTreeVisitor;
import com.sun.tools.doclint.HtmlTag;
-import com.sun.tools.doclint.HtmlTag.Attr;
+import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.Navigation;
import jdk.javadoc.internal.doclets.toolkit.Content;
@@ -184,16 +181,28 @@
Content pkgLinkContent = docletWriter.getPackageLink(pkg, docletWriter.contents.packageLabel);
navBar.setNavLinkPackage(pkgLinkContent);
navBar.setUserHeader(docletWriter.getUserHeaderFooter(true));
- htmlContent.addContent(navBar.getContent(true));
+ Content header = docletWriter.createTagIfAllowed(
+ jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag.HEADER, HtmlTree::HEADER,
+ ContentBuilder::new);
+ header.addContent(navBar.getContent(true));
+ htmlContent.addContent(header);
+
List<? extends DocTree> fullBody = utils.getFullBody(dfElement);
Content bodyContent = docletWriter.commentTagsToContent(null, dfElement, fullBody, false);
-
docletWriter.addTagsInfo(dfElement, bodyContent);
- htmlContent.addContent(bodyContent);
+ Content main = docletWriter.createTagIfAllowed(
+ jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag.MAIN, HtmlTree::MAIN,
+ ContentBuilder::new);
+ main.addContent(bodyContent);
+ htmlContent.addContent(main);
navBar.setUserFooter(docletWriter.getUserHeaderFooter(false));
- htmlContent.addContent(navBar.getContent(false));
- docletWriter.addBottom(htmlContent);
+ Content footer = docletWriter.createTagIfAllowed(
+ jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag.FOOTER, HtmlTree::FOOTER,
+ ContentBuilder::new);
+ footer.addContent(navBar.getContent(false));
+ docletWriter.addBottom(footer);
+ htmlContent.addContent(footer);
docletWriter.printHtmlDocument(Collections.emptyList(), false, localTagsContent, htmlContent);
}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/test/langtools/jdk/javadoc/doclet/testHtmlLandmarkRegions/TestHtmlLandmarkRegions.java Mon Jan 14 15:09:15 2019 +0530
@@ -0,0 +1,256 @@
+/*
+ * Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8210047 8199892
+ * @summary some pages contains content outside of landmark region
+ * @library /tools/lib ../../lib
+ * @modules
+ * jdk.javadoc/jdk.javadoc.internal.tool
+ * jdk.compiler/com.sun.tools.javac.api
+ * jdk.compiler/com.sun.tools.javac.main
+ * @build javadoc.tester.*
+ * @run main TestHtmlLandmarkRegions
+ */
+
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+
+import builder.ClassBuilder;
+import toolbox.ModuleBuilder;
+import toolbox.ToolBox;
+
+import javadoc.tester.JavadocTester;
+
+public class TestHtmlLandmarkRegions extends JavadocTester {
+
+ final ToolBox tb;
+
+ public static void main(String... args) throws Exception {
+ TestHtmlLandmarkRegions tester = new TestHtmlLandmarkRegions();
+ tester.runTests(m -> new Object[]{Paths.get(m.getName())});
+ }
+
+ TestHtmlLandmarkRegions() {
+ tb = new ToolBox();
+ }
+
+ @Test
+ public void testModules(Path base) throws Exception {
+ Path srcDir = base.resolve("src");
+ createModules(srcDir);
+
+ Path outDir = base.resolve("out");
+ javadoc("-d", outDir.toString(),
+ "-doctitle", "Document Title",
+ "-header", "Test Header",
+ "--frames",
+ "--module-source-path", srcDir.toString(),
+ "--module", "m1,m2");
+
+ checkExit(Exit.OK);
+
+ checkOrder("module-overview-frame.html",
+ "<header role=\"banner\">\n"
+ + "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
+ + "<nav role=\"navigation\" class=\"indexNav\">",
+ "<main role=\"main\">\n"
+ + "<div class=\"indexContainer\">\n"
+ + "<h2 title=\"Modules\">Modules</h2>\n"
+ + "<ul title=\"Modules\">",
+ "<footer role=\"contentinfo\">");
+
+ checkOrder("m1/module-frame.html",
+ "<header role=\"banner\">\n"
+ + "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
+ + "<nav role=\"navigation\" class=\"indexNav\">",
+ "<main role=\"main\">\n"
+ + "<div class=\"indexContainer\">\n"
+ + "<h2 title=\"m1\"><a href=\"module-summary.html\" target=\"classFrame\">m1</a> Packages</h2>",
+ "<footer role=\"contentinfo\">");
+
+ checkOrder("overview-summary.html",
+ "<header role=\"banner\">\n"
+ + "<nav role=\"navigation\">",
+ "<main role=\"main\">\n"
+ + "<div class=\"header\">\n"
+ + "<h1 class=\"title\">Document Title</h1>",
+ "<footer role=\"contentinfo\">\n"
+ + "<nav role=\"navigation\">");
+ }
+
+ @Test
+ public void testModulesHtml4(Path base) throws Exception {
+ Path srcDir = base.resolve("src");
+ createModules(srcDir);
+
+ Path outDir = base.resolve("out2");
+ javadoc("-d", outDir.toString(),
+ "-doctitle", "Document Title",
+ "-header", "Test Header",
+ "--frames",
+ "--module-source-path", srcDir.toString(),
+ "--module", "m1,m2",
+ "-html4");
+
+ checkExit(Exit.OK);
+
+ checkOrder("module-overview-frame.html",
+ "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
+ + "<div class=\"indexNav\">",
+ "<div class=\"indexContainer\">\n"
+ + "<h2 title=\"Modules\">Modules</h2>\n"
+ + "<ul title=\"Modules\">");
+
+ checkOrder("m1/module-frame.html",
+ "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
+ + "<div class=\"indexNav\">",
+ "<div class=\"indexContainer\">\n"
+ + "<h2 title=\"m1\"><a href=\"module-summary.html\" target=\"classFrame\">m1</a> Packages</h2>");
+
+ checkOrder("overview-summary.html",
+ "<div class=\"fixedNav\">",
+ "<div class=\"header\">\n"
+ + "<h1 class=\"title\">Document Title</h1>",
+ "<div class=\"bottomNav\"><a name=\"navbar.bottom\">");
+ }
+
+ @Test
+ public void testPackages(Path base) throws Exception {
+ Path srcDir = base.resolve("src");
+ createPackages(srcDir);
+
+ Path outDir = base.resolve("out3");
+ javadoc("-d", outDir.toString(),
+ "-doctitle", "Document Title",
+ "-header", "Test Header",
+ "--frames",
+ "-sourcepath", srcDir.toString(),
+ "pkg1", "pkg2");
+
+ checkExit(Exit.OK);
+
+ checkOrder("overview-summary.html",
+ "<header role=\"banner\">\n"
+ + "<nav role=\"navigation\">",
+ "<main role=\"main\">\n"
+ + "<div class=\"header\">\n"
+ + "<h1 class=\"title\">Document Title</h1>",
+ "<footer role=\"contentinfo\">\n" +
+ "<nav role=\"navigation\">");
+
+ checkOrder("overview-frame.html",
+ "<header role=\"banner\">\n"
+ + "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
+ + "<nav role=\"navigation\" class=\"indexNav\">",
+ "<main role=\"main\">\n"
+ + "<div class=\"indexContainer\">\n"
+ + "<h2 title=\"Packages\">Packages</h2>",
+ "<footer role=\"contentinfo\">");
+ }
+
+ @Test
+ public void testPackagesHtml4(Path base) throws Exception {
+ Path srcDir = base.resolve("src");
+ createPackages(srcDir);
+
+ Path outDir = base.resolve("out4");
+ javadoc("-d", outDir.toString(),
+ "-doctitle", "Document Title",
+ "-header", "Test Header",
+ "--frames",
+ "-sourcepath", srcDir.toString(),
+ "pkg1", "pkg2",
+ "-html4");
+
+ checkExit(Exit.OK);
+
+ checkOrder("overview-summary.html",
+ "<div class=\"fixedNav\">",
+ "<div class=\"header\">\n"
+ + "<h1 class=\"title\">Document Title</h1>",
+ "<div class=\"bottomNav\"><a name=\"navbar.bottom\">");
+
+ checkOrder("overview-frame.html",
+ "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
+ + "<div class=\"indexNav\">",
+ "<div class=\"indexContainer\">\n"
+ + "<h2 title=\"Packages\">Packages</h2>"
+ );
+ }
+
+ @Test
+ public void testDocFiles(Path base) throws Exception {
+ Path srcDir = base.resolve("src");
+ createPackages(srcDir);
+ Path docFiles = Files.createDirectory(srcDir.resolve("pkg1").resolve("doc-files"));
+ Files.write(docFiles.resolve("s.html"), List.of(
+ "<html>\n"
+ + " <head>\n"
+ + " <title>\"Hello World\"</title>\n"
+ + " </head>\n"
+ + " <body>\n"
+ + " A sample doc file.\n"
+ + " </body>\n"
+ + "</html>"));
+
+ Path outDir = base.resolve("out5");
+ javadoc("-d", outDir.toString(),
+ "-sourcepath", srcDir.toString(),
+ "pkg1", "pkg2");
+
+ checkExit(Exit.OK);
+
+ checkOrder("pkg1/doc-files/s.html",
+ "<header role=\"banner\">\n"
+ + "<nav role=\"navigation\">\n",
+ "<main role=\"main\">A sample doc file",
+ "<footer role=\"contentinfo\">\n"
+ + "<nav role=\"navigation\">"
+ );
+ }
+
+ void createModules(Path srcDir) throws Exception {
+ new ModuleBuilder(tb, "m1")
+ .classes("package p1; public class a{}")
+ .classes("package p2; public class b{}")
+ .write(srcDir);
+ new ModuleBuilder(tb, "m2")
+ .classes("package p3; public class c{}")
+ .classes("package p4; public class d{}")
+ .write(srcDir);
+ }
+
+ void createPackages(Path srcDir) throws Exception {
+ new ClassBuilder(tb, "pkg1.A")
+ .setModifiers("public", "class")
+ .write(srcDir);
+ new ClassBuilder(tb, "pkg2.B")
+ .setModifiers("public", "class")
+ .write(srcDir);
+ }
+}
--- a/test/langtools/jdk/javadoc/doclet/testHtmlLandmarkRegions/TestHtmlLankmarkRegions.java Mon Jan 14 09:48:30 2019 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,223 +0,0 @@
-/*
- * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-
-/*
- * @test
- * @bug 8210047
- * @summary some pages contains content outside of landmark region
- * @library /tools/lib ../../lib
- * @modules
- * jdk.javadoc/jdk.javadoc.internal.tool
- * jdk.compiler/com.sun.tools.javac.api
- * jdk.compiler/com.sun.tools.javac.main
- * @build javadoc.tester.*
- * @run main TestHtmlLankmarkRegions
- */
-
-
-import java.nio.file.Path;
-import java.nio.file.Paths;
-
-import builder.ClassBuilder;
-import toolbox.ModuleBuilder;
-import toolbox.ToolBox;
-
-import javadoc.tester.JavadocTester;
-
-public class TestHtmlLankmarkRegions extends JavadocTester {
-
- final ToolBox tb;
-
- public static void main(String... args) throws Exception {
- TestHtmlLankmarkRegions tester = new TestHtmlLankmarkRegions();
- tester.runTests(m -> new Object[]{Paths.get(m.getName())});
- }
-
- TestHtmlLankmarkRegions() {
- tb = new ToolBox();
- }
-
- @Test
- public void testModules(Path base) throws Exception {
- Path srcDir = base.resolve("src");
- createModules(srcDir);
-
- Path outDir = base.resolve("out");
- javadoc("-d", outDir.toString(),
- "-doctitle", "Document Title",
- "-header", "Test Header",
- "--frames",
- "--module-source-path", srcDir.toString(),
- "--module", "m1,m2");
-
- checkExit(Exit.OK);
-
- checkOrder("module-overview-frame.html",
- "<header role=\"banner\">\n"
- + "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
- + "<nav role=\"navigation\" class=\"indexNav\">",
- "<main role=\"main\">\n"
- + "<div class=\"indexContainer\">\n"
- + "<h2 title=\"Modules\">Modules</h2>\n"
- + "<ul title=\"Modules\">",
- "<footer role=\"contentinfo\">");
-
- checkOrder("m1/module-frame.html",
- "<header role=\"banner\">\n"
- + "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
- + "<nav role=\"navigation\" class=\"indexNav\">",
- "<main role=\"main\">\n"
- + "<div class=\"indexContainer\">\n"
- + "<h2 title=\"m1\"><a href=\"module-summary.html\" target=\"classFrame\">m1</a> Packages</h2>",
- "<footer role=\"contentinfo\">");
-
- checkOrder("overview-summary.html",
- "<header role=\"banner\">\n"
- + "<nav role=\"navigation\">",
- "<main role=\"main\">\n"
- + "<div class=\"header\">\n"
- + "<h1 class=\"title\">Document Title</h1>",
- "<footer role=\"contentinfo\">\n"
- + "<nav role=\"navigation\">");
- }
-
- @Test
- public void testModulesHtml4(Path base) throws Exception {
- Path srcDir = base.resolve("src");
- createModules(srcDir);
-
- Path outDir = base.resolve("out2");
- javadoc("-d", outDir.toString(),
- "-doctitle", "Document Title",
- "-header", "Test Header",
- "--frames",
- "--module-source-path", srcDir.toString(),
- "--module", "m1,m2",
- "-html4");
-
- checkExit(Exit.OK);
-
- checkOrder("module-overview-frame.html",
- "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
- + "<div class=\"indexNav\">",
- "<div class=\"indexContainer\">\n"
- + "<h2 title=\"Modules\">Modules</h2>\n"
- + "<ul title=\"Modules\">");
-
- checkOrder("m1/module-frame.html",
- "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
- + "<div class=\"indexNav\">",
- "<div class=\"indexContainer\">\n"
- + "<h2 title=\"m1\"><a href=\"module-summary.html\" target=\"classFrame\">m1</a> Packages</h2>");
-
- checkOrder("overview-summary.html",
- "<div class=\"fixedNav\">",
- "<div class=\"header\">\n"
- + "<h1 class=\"title\">Document Title</h1>",
- "<div class=\"bottomNav\"><a name=\"navbar.bottom\">");
- }
-
- @Test
- public void testPackages(Path base) throws Exception {
- Path srcDir = base.resolve("src");
- createPackages(srcDir);
-
- Path outDir = base.resolve("out3");
- javadoc("-d", outDir.toString(),
- "-doctitle", "Document Title",
- "-header", "Test Header",
- "--frames",
- "-sourcepath", srcDir.toString(),
- "pkg1", "pkg2");
-
- checkExit(Exit.OK);
-
- checkOrder("overview-summary.html",
- "<header role=\"banner\">\n"
- + "<nav role=\"navigation\">",
- "<main role=\"main\">\n"
- + "<div class=\"header\">\n"
- + "<h1 class=\"title\">Document Title</h1>",
- "<footer role=\"contentinfo\">\n" +
- "<nav role=\"navigation\">");
-
- checkOrder("overview-frame.html",
- "<header role=\"banner\">\n"
- + "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
- + "<nav role=\"navigation\" class=\"indexNav\">",
- "<main role=\"main\">\n"
- + "<div class=\"indexContainer\">\n"
- + "<h2 title=\"Packages\">Packages</h2>",
- "<footer role=\"contentinfo\">");
- }
-
- @Test
- public void testPackagesHtml4(Path base) throws Exception {
- Path srcDir = base.resolve("src");
- createPackages(srcDir);
-
- Path outDir = base.resolve("out4");
- javadoc("-d", outDir.toString(),
- "-doctitle", "Document Title",
- "-header", "Test Header",
- "--frames",
- "-sourcepath", srcDir.toString(),
- "pkg1", "pkg2",
- "-html4");
-
- checkExit(Exit.OK);
-
- checkOrder("overview-summary.html",
- "<div class=\"fixedNav\">",
- "<div class=\"header\">\n"
- + "<h1 class=\"title\">Document Title</h1>",
- "<div class=\"bottomNav\"><a name=\"navbar.bottom\">");
-
- checkOrder("overview-frame.html",
- "<h1 title=\"Test Header\" class=\"bar\">Test Header</h1>\n"
- + "<div class=\"indexNav\">",
- "<div class=\"indexContainer\">\n"
- + "<h2 title=\"Packages\">Packages</h2>"
- );
- }
-
- void createModules(Path srcDir) throws Exception {
- new ModuleBuilder(tb, "m1")
- .classes("package p1; public class a{}")
- .classes("package p2; public class b{}")
- .write(srcDir);
- new ModuleBuilder(tb, "m2")
- .classes("package p3; public class c{}")
- .classes("package p4; public class d{}")
- .write(srcDir);
- }
-
- void createPackages(Path srcDir) throws Exception {
- new ClassBuilder(tb, "pkg1.A")
- .setModifiers("public", "class")
- .write(srcDir);
- new ClassBuilder(tb, "pkg2.B")
- .setModifiers("public", "class")
- .write(srcDir);
- }
-}