Skip to content

Commit

Permalink
8309595: Allow javadoc to process unnamed classes
Browse files Browse the repository at this point in the history
Reviewed-by: hannesw
  • Loading branch information
JimLaskey committed Jun 8, 2023
1 parent b2a5271 commit 0be3905
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -987,7 +987,7 @@ private boolean isTypeElementSelected(TypeElement te) {
* @return true if the element is visible
*/
public boolean isSelected(Element e) {
if (toolEnv.isSynthetic((Symbol) e)) {
if (toolEnv.isSynthetic((Symbol) e) && !toolEnv.isUnnamed((Symbol) e)) {
return false;
}
if (visibleElementVisitor == null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,10 @@ boolean isSynthetic(Symbol sym) {
return (sym.flags() & Flags.SYNTHETIC) != 0;
}

boolean isUnnamed(Symbol sym) {
return (sym.flags() & Flags.UNNAMED_CLASS) != 0;
}

void setElementToTreePath(Element e, TreePath tree) {
if (e == null || tree == null)
return;
Expand Down
82 changes: 82 additions & 0 deletions test/langtools/jdk/javadoc/doclet/unnamed/Unnamed.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
/*
* Copyright (c) 2017, 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 8309595
* @summary Allow javadoc to process unnamed classes
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main Unnamed
*/

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;

import javadoc.tester.JavadocTester;
import toolbox.ToolBox;

public class Unnamed extends JavadocTester {

private static final String thisVersion = System.getProperty("java.specification.version");

private static final ToolBox tb = new ToolBox();

public static void main(String... args) throws Exception {
new Unnamed().runTests();
}

@Test
public void testUnnamed(Path base) throws IOException {
String className = "Sample";
Files.createDirectories(base);
Path out = base.resolve("out");
Path src = base.resolve("src");
Path sample = src.resolve(className + ".java");

Files.createDirectories(out);
Files.createDirectories(src);
Files.writeString(sample, """
/**
* This is a comment for the main method.
*/
void main() {
System.out.println("Done");
}
""");

javadoc(
"--enable-preview",
"--source", thisVersion,
"-private",
"-d", out.toString(),
sample.toString()
);

checkOutput(className + ".html", true, "This is a comment for the main method.");
}

}

1 comment on commit 0be3905

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.