From e35abe3235ab38985a19545e76c58260ec97c718 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Hannes=20Walln=C3=B6fer?= <hannesw@openjdk.org>
Date: Tue, 9 Nov 2021 15:05:07 +0000
Subject: [PATCH] 8256208: Javadoc's generated overview does not show classes
of unnamed package
Reviewed-by: jjg
---
.../formats/html/HtmlConfiguration.java | 6 ----
.../formats/html/PackageIndexWriter.java | 12 ++++----
.../TestUnnamedPackage.java | 28 ++++++++++++++++++
.../doclet/testUnnamedPackage/src1/pkg/D.java | 29 +++++++++++++++++++
.../testUnnamedPackage/src1/pkg/package.html | 5 ++++
5 files changed, 67 insertions(+), 13 deletions(-)
create mode 100644 test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/D.java
create mode 100644 test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/package.html
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlConfiguration.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlConfiguration.java
index a4596536bc9..9d26192d5a4 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlConfiguration.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlConfiguration.java
@@ -296,12 +296,6 @@ public class HtmlConfiguration extends BaseConfiguration {
} else {
if (showModules) {
topFile = DocPath.empty.resolve(docPaths.moduleSummary(modules.first()));
- } else if (packages.size() == 1 && packages.first().isUnnamed()) {
- List<TypeElement> classes = new ArrayList<>(getIncludedTypeElements());
- if (!classes.isEmpty()) {
- TypeElement te = getValidClass(classes);
- topFile = docPaths.forClass(te);
- }
} else if (!packages.isEmpty()) {
topFile = docPaths.forPackage(packages.first()).resolve(DocPaths.PACKAGE_SUMMARY);
}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexWriter.java
index 61ee3c7507f..11bb4d6def5 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexWriter.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexWriter.java
@@ -105,13 +105,11 @@ public class PackageIndexWriter extends AbstractOverviewIndexWriter {
}
for (PackageElement pkg : configuration.packages) {
- if (!pkg.isUnnamed()) {
- if (!(options.noDeprecated() && utils.isDeprecated(pkg))) {
- Content packageLinkContent = getPackageLink(pkg, getLocalizedPackageName(pkg));
- Content summaryContent = new ContentBuilder();
- addSummaryComment(pkg, summaryContent);
- table.addRow(pkg, packageLinkContent, summaryContent);
- }
+ if (!(options.noDeprecated() && utils.isDeprecated(pkg))) {
+ Content packageLinkContent = getPackageLink(pkg, getLocalizedPackageName(pkg));
+ Content summaryContent = new ContentBuilder();
+ addSummaryComment(pkg, summaryContent);
+ table.addRow(pkg, packageLinkContent, summaryContent);
}
}
diff --git a/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/TestUnnamedPackage.java b/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/TestUnnamedPackage.java
index a88260f3d56..9f9dce38a64 100644
--- a/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/TestUnnamedPackage.java
+++ b/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/TestUnnamedPackage.java
@@ -24,6 +24,7 @@
/*
* @test
* @bug 4904075 4774450 5015144 8043698 8196201 8203791 8184205 8260223
+ * 8256208
* @summary Reference unnamed package as "Unnamed", not empty string.
* Generate a package summary for the unnamed package.
* @library ../../lib
@@ -48,6 +49,12 @@ public class TestUnnamedPackage extends JavadocTester {
testSrc("src1/C.java"));
checkExit(Exit.OK);
+ checkOutput("index.html", true,
+ """
+ <script type="text/javascript">window.location.replace('package-summary.html')</script>
+ <noscript>
+ <meta http-equiv="Refresh" content="0;package-summary.html">
+ </noscript>""");
checkOutput("package-summary.html", true,
"""
<h1 title="Unnamed Package" class="title">Unnamed Package</h1>""",
@@ -156,4 +163,25 @@ public class TestUnnamedPackage extends JavadocTester {
eters of type <a href="../A.html" title="class in Unnamed Package">A</a>""");
}
+
+ @Test
+ public void testMixed() {
+ javadoc("-d", "out-mixed",
+ "-sourcepath", testSrc("src1"),
+ testSrc("src1/C.java"),
+ "pkg");
+ checkExit(Exit.OK);
+
+ checkOutput("index.html", true,
+ """
+ <div class="col-first even-row-color all-packages-table all-packages-table-tab1"\
+ ><a href="package-summary.html">Unnamed Package</a></div>
+ <div class="col-last even-row-color all-packages-table all-packages-table-tab1">
+ <div class="block">This is a package comment for the unnamed package.</div>
+ </div>
+ <div class="col-first odd-row-color all-packages-table all-packages-table-tab1">\
+ <a href="pkg/package-summary.html">pkg</a></div>
+ <div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
+ <div class="block">This is a package comment for package pkg.</div>""");
+ }
}
diff --git a/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/D.java b/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/D.java
new file mode 100644
index 00000000000..9d2e399758d
--- /dev/null
+++ b/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/D.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2021, 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.
+ */
+
+package pkg;
+
+/**
+ * This is class D in the package pkg.
+ */
+public class D {}
diff --git a/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/package.html b/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/package.html
new file mode 100644
index 00000000000..100df50ca6c
--- /dev/null
+++ b/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/package.html
@@ -0,0 +1,5 @@
+<html>
+ <body>
+ This is a package comment for package pkg.
+ </body>
+</html>