stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8222091: Javadoc does not handle package annotations correctly on package-info.java

Browse Source 
Reviewed-by: jjg
This commit is contained in:
Hannes Wallnöfer 2019-06-04 16:20:42 +02:00
parent 60f385e737
commit 4d08dd703e
9 changed files with 246 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java
View File

@ -3032,11 +3032,11 @@ public class Utils {
*/
public TreePath getTreePath(Element e) {
DocCommentDuo duo = dcTreeCache.get(e);
if (isValidDuo(duo) && duo.treePath != null) {
if (duo != null && duo.treePath != null) {
return duo.treePath;
}
duo = configuration.cmtUtils.getSyntheticCommentDuo(e);
if (isValidDuo(duo) && duo.treePath != null) {
if (duo != null && duo.treePath != null) {
return duo.treePath;
}
Map<Element, TreePath> elementToTreePath = configuration.workArounds.getElementToTreePath();
@ -3062,20 +3062,20 @@ public class Utils {
ElementKind kind = element.getKind();
if (kind == ElementKind.PACKAGE || kind == ElementKind.OTHER) {
duo = dcTreeCache.get(element); // local cache
if (!isValidDuo(duo) && kind == ElementKind.PACKAGE) {
if (duo == null && kind == ElementKind.PACKAGE) {
// package-info.java
duo = getDocCommentTuple(element);
}
if (!isValidDuo(duo)) {
if (duo == null) {
// package.html or overview.html
duo = configuration.cmtUtils.getHtmlCommentDuo(element); // html source
}
} else {
duo = configuration.cmtUtils.getSyntheticCommentDuo(element);
if (!isValidDuo(duo)) {
if (duo == null) {
duo = dcTreeCache.get(element); // local cache
}
if (!isValidDuo(duo)) {
if (duo == null) {
duo = getDocCommentTuple(element); // get the real mccoy
}
}

88
test/langtools/jdk/javadoc/doclet/testPackageAnnotation/TestPackageAnnotation.java Normal file
View File

@ -0,0 +1,88 @@
/*
* Copyright (c) 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 8222091
* @summary Javadoc does not handle package annotations correctly on package-info.java
* @library ../../lib/
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestPackageAnnotation
*/
import javadoc.tester.JavadocTester;
public class TestPackageAnnotation extends JavadocTester {
public static void main(String... args) throws Exception {
TestPackageAnnotation tester = new TestPackageAnnotation();
tester.runTests();
}
@Test
public void testPackageInfoAnnotationNoComment() {
javadoc("-d", "out-annotation",
"-sourcepath", testSrc,
"-use",
"pkg1");
checkExit(Exit.OK);
checkOutput("pkg1/package-summary.html", true,
"<main role=\"main\">\n<div class=\"header\">\n"
+ "<p>@Deprecated(since=\"1&lt;2&gt;3\")\n"
+ "</p>\n"
+ "<h1 title=\"Package\" class=\"title\">Package&nbsp;pkg1</h1>\n"
+ "</div>\n");
}
@Test
public void testPackageHtmlTag() {
javadoc("-d", "out-annotation-2",
"-sourcepath", testSrc,
"-use",
"pkg2");
checkExit(Exit.OK);
checkOutput("pkg2/package-summary.html", true,
"<div class=\"deprecationBlock\"><span class=\"deprecatedLabel\">Deprecated.</span>\n"
+ "<div class=\"deprecationComment\">This package is deprecated.</div>\n"
+ "</div>\n"
+ "<div class=\"block\">This is the description of package pkg2.</div>\n"
+ "</section>");
}
@Test
public void testPackageInfoAndHtml() {
javadoc("-d", "out-annotation-3",
"-sourcepath", testSrc,
"-use",
"pkg3");
checkExit(Exit.OK);
checkOutput("pkg3/package-summary.html", true,
"<main role=\"main\">\n"
+ "<div class=\"header\">\n"
+ "<p>@Deprecated(since=\"1&lt;2&gt;3\")\n"
+ "</p>\n"
+ "<h1 title=\"Package\" class=\"title\">Package&nbsp;pkg3</h1>\n"
+ "</div>\n");
}
}

27
test/langtools/jdk/javadoc/doclet/testPackageAnnotation/pkg1/A.java Normal file
View File

@ -0,0 +1,27 @@
/*
* Copyright (c) 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.
*/
package pkg1;
public class A {
}

27
test/langtools/jdk/javadoc/doclet/testPackageAnnotation/pkg1/package-info.java Normal file
View File

@ -0,0 +1,27 @@
/*
* Copyright (c) 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.
*/
// Contains no javadoc comment, but should still be honored by javadoc.
@Deprecated(since="1<2>3")
package pkg1;

27
test/langtools/jdk/javadoc/doclet/testPackageAnnotation/pkg2/A.java Normal file
View File

@ -0,0 +1,27 @@
/*
* Copyright (c) 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.
*/
package pkg2;
public class A {
}

9
test/langtools/jdk/javadoc/doclet/testPackageAnnotation/pkg2/package.html Normal file
View File

@ -0,0 +1,9 @@
<html lang="en">
<head>
<title>Package Summary</title>
</head>
<body>
This is the description of package pkg2.
@deprecated This package is deprecated.
</body>
</html>

27
test/langtools/jdk/javadoc/doclet/testPackageAnnotation/pkg3/A.java Normal file
View File

@ -0,0 +1,27 @@
/*
* Copyright (c) 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.
*/
package pkg3;
public class A {
}

27
test/langtools/jdk/javadoc/doclet/testPackageAnnotation/pkg3/package-info.java Normal file
View File

@ -0,0 +1,27 @@
/*
* Copyright (c) 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.
*/
// Contains no javadoc comment, but should still be honored by javadoc.
@Deprecated(since="1<2>3")
package pkg3;

8
test/langtools/jdk/javadoc/doclet/testPackageAnnotation/pkg3/package.html Normal file
View File

@ -0,0 +1,8 @@
<html lang="en">
<head>
<title>Package Summary</title>
</head>
<body>
This file is ignored by javadoc as the package contains a package-info.java file.
</body>
</html>