archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-20 02:54:35 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8035473: [javadoc] Revamp the existing Doclet APIs

Browse source 
8146529: Update the new Doclet API
8146427: "-nohelp" option issue
8146475: "-helpfile" option issue

Reviewed-by: alanb, bpatel, ihse, jjg, jlahoda, mchung, ogb, vromero
This commit is contained in:
Kumar Srinivasan 2015-11-28 18:52:17 -08:00
parent e2ab4ff25d
commit cf406debb4
996 changed files with 128974 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

114
langtools/test/tools/javadoc/api/basic/JavadocTaskImplTest.java
View file

@ -1,114 +0,0 @@
/*
* Copyright (c) 2012, 2015, 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 6493690
* @summary javadoc should have a javax.tools.Tool service provider
* @modules jdk.compiler/com.sun.tools.javac.file
* jdk.compiler/com.sun.tools.javac.util
* jdk.javadoc/com.sun.tools.javadoc.api
* @build APITest
* @run main JavadocTaskImplTest
*/
import java.io.File;
import java.util.Arrays;
import java.util.concurrent.Callable;
import javax.tools.DocumentationTool;
import javax.tools.DocumentationTool.DocumentationTask;
import javax.tools.JavaFileObject;
import javax.tools.StandardJavaFileManager;
import javax.tools.ToolProvider;
import com.sun.tools.javac.file.JavacFileManager;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javadoc.Messager;
import com.sun.tools.javadoc.api.JavadocTaskImpl;
/**
* Misc tests for JavacTaskImpl.
*/
public class JavadocTaskImplTest extends APITest {
public static void main(String... args) throws Exception {
new JavadocTaskImplTest().run();
}
@Test
public void testRawCall() throws Exception {
JavaFileObject srcFile = createSimpleJavaFileObject();
DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
try (StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null)) {
File outDir = getOutDir();
fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir));
Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile);
@SuppressWarnings("rawtypes")
Callable t = tool.getTask(null, fm, null, null, null, files);
if (t.call() == Boolean.TRUE) {
System.err.println("task succeeded");
} else {
throw new Exception("task failed");
}
}
}
@Test
public void testDirectAccess1() throws Exception {
JavaFileObject srcFile = createSimpleJavaFileObject();
Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile);
Context c = new Context();
Messager.preRegister(c, "javadoc");
try (StandardJavaFileManager fm = new JavacFileManager(c, true, null)) {
File outDir = getOutDir();
fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir));
DocumentationTask t = new JavadocTaskImpl(c, null, null, files);
if (t.call()) {
System.err.println("task succeeded");
} else {
throw new Exception("task failed");
}
}
}
@Test
public void testDirectAccess2() throws Exception {
JavaFileObject srcFile = null; // error, provokes NPE
Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile);
Context c = new Context();
Messager.preRegister(c, "javadoc");
try (StandardJavaFileManager fm = new JavacFileManager(c, true, null)) {
File outDir = getOutDir();
fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir));
try {
DocumentationTask t = new JavadocTaskImpl(c, null, null, files);;
error("getTask succeeded, no exception thrown");
} catch (NullPointerException e) {
System.err.println("exception caught as expected: " + e);
}
}
}
}

150
langtools/test/tools/javadoc/api/basic/RunTest.java
View file

@ -1,150 +0,0 @@
/*
* Copyright (c) 2012, 2015, 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 6493690 8007490
* @summary javadoc should have a javax.tools.Tool service provider
* @modules java.compiler
* jdk.compiler
* @build APITest
* @run main RunTest
*/
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.PrintStream;
import javax.tools.DocumentationTool;
import javax.tools.ToolProvider;
/**
* Tests for DocumentationTool.run method.
*/
public class RunTest extends APITest {
public static void main(String... args) throws Exception {
new RunTest().run();
}
/**
* Verify that run method can be invoked.
*/
@Test
public void testRunOK() throws Exception {
File testSrc = new File(System.getProperty("test.src"));
File srcFile = new File(testSrc, "pkg/C.java");
File outDir = getOutDir();
String[] args = { "-d", outDir.getPath(), srcFile.getPath() };
ByteArrayOutputStream stdout = new ByteArrayOutputStream();
ByteArrayOutputStream stderr = new ByteArrayOutputStream();
DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
int rc = tool.run(null, stdout, stderr, args);
System.err.println("stdout >>" + stdout.toString() + "<<");
System.err.println("stderr >>" + stderr.toString() + "<<");
if (rc == 0) {
System.err.println("call succeeded");
checkFiles(outDir, standardExpectFiles);
String out = stdout.toString();
for (String f: standardExpectFiles) {
String f1 = f.replace('/', File.separatorChar);
if (f1.endsWith(".html") && !out.contains(f1))
error("expected string not found: " + f1);
}
} else {
error("call failed");
}
}
/**
* Verify that run method can be invoked.
*/
@Test
public void testRunFail() throws Exception {
File outDir = getOutDir();
String badfile = "badfile.java";
String[] args = { "-d", outDir.getPath(), badfile };
ByteArrayOutputStream stdout = new ByteArrayOutputStream();
ByteArrayOutputStream stderr = new ByteArrayOutputStream();
DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
int rc = tool.run(null, stdout, stderr, args);
System.err.println("stdout >>" + stdout.toString() + "<<");
System.err.println("stderr >>" + stderr.toString() + "<<");
if (rc == 0) {
error("call succeeded unexpectedly");
} else {
String err = stderr.toString();
if (err.contains(badfile))
System.err.println("call failed as expected");
else
error("expected diagnostic not found");
}
}
/**
* Verify that null args are accepted.
*/
@Test
public void testNullArgs() throws Exception {
File testSrc = new File(System.getProperty("test.src"));
File srcFile = new File(testSrc, "pkg/C.java");
File outDir = getOutDir();
String[] args = { "-d", outDir.getPath(), srcFile.getPath() };
ByteArrayOutputStream stdout = new ByteArrayOutputStream();
PrintStream prevStdout = System.out;
System.setOut(new PrintStream(stdout));
ByteArrayOutputStream stderr = new ByteArrayOutputStream();
PrintStream prevStderr = System.err;
System.setErr(new PrintStream(stderr));
int rc ;
try {
DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
rc = tool.run(null, null, null, args);
} finally {
System.setOut(prevStdout);
System.setErr(prevStderr);
}
System.err.println("stdout >>" + stdout.toString() + "<<");
System.err.println("stderr >>" + stderr.toString() + "<<");
if (rc == 0) {
System.err.println("call succeeded");
checkFiles(outDir, standardExpectFiles);
String out = stdout.toString();
for (String f: standardExpectFiles) {
String f1 = f.replace('/', File.separatorChar);
if (f1.endsWith(".html") && !out.contains(f1))
error("expected string not found: " + f1);
}
} else {
error("call failed");
}
}
}

2
langtools/test/tools/javadoc/api/basic/TagletPathTest.java
View file

@ -81,7 +81,7 @@ public class TagletPathTest extends APITest {
Iterable<String> options = Arrays.asList("-taglet", "UnderlineTaglet");
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
DocumentationTask t = tool.getTask(pw, fm, null, null, options, files);
DocumentationTask t = tool.getTask(pw, fm, null, com.sun.tools.doclets.standard.Standard.class, options, files);
boolean ok = t.call();
String out = sw.toString();
System.err.println(">>" + out + "<<");