changeset 806:285896f2227a

6942366: javadoc no longer inherits doc from sourcepath Reviewed-by: mcimadamore
author jjg
date Tue, 23 Nov 2010 13:32:29 -0800
parents 2536dedd897e
children 79d0c48d361e
files src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java test/tools/javadoc/6942366/T6942366.java test/tools/javadoc/6942366/Test.java test/tools/javadoc/6942366/p/Base.java
diffstat 4 files changed, 193 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java	Tue Nov 23 11:08:43 2010 +0000
+++ b/src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java	Tue Nov 23 13:32:29 2010 -0800
@@ -62,6 +62,7 @@
     private JavadocClassReader(Context context) {
         super(context, true);
         docenv = DocEnv.instance(context);
+        preferSource = true;
     }
 
     /**
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/tools/javadoc/6942366/T6942366.java	Tue Nov 23 13:32:29 2010 -0800
@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2010, 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 6942366
+ * @summary javadoc no longer inherits doc from sourcepath
+ * @build p.Base Test
+ * @run main T6942366
+ */
+
+import java.io.*;
+import java.util.*;
+
+public class T6942366 {
+    public static void main(String... args) throws Exception {
+        new T6942366().run();
+    }
+
+    File testSrc;
+    File testClasses;
+    int count;
+    int errors;
+
+    void run() throws Exception {
+        testSrc = new File(System.getProperty("test.src"));
+        testClasses = new File(System.getProperty("test.classes"));
+
+        test(true,  false);
+        test(false, true);
+        test(true,  true);
+
+        if (errors > 0)
+            throw new Exception(errors + " errors found");
+    }
+
+    void test(boolean useSourcePath, boolean useClassPath) throws Exception {
+        System.out.println("test " + (++count) + " sp:" + useSourcePath + " cp:" + useClassPath);
+        File testDir = new File("test" + count);
+        testDir.mkdirs();
+
+        List<String> args = new ArrayList<String>();
+        //args.add("-verbose");
+        args.add("-d");
+        args.add(testDir.getPath());
+        if (useSourcePath) {
+            args.add("-sourcepath");
+            args.add(testSrc.getPath());
+        }
+        if (useClassPath) {
+            args.add("-classpath");
+            args.add(testClasses.getPath());
+        } else {
+            // override classpath to avoid stuff jtreg might have put on papth
+            args.add("-classpath");
+            args.add(".");
+        }
+
+        // use a very simple bootclasspath to avoid stuff jtreg might have put on path
+        File javaHome = new File(System.getProperty("java.home"));
+        File rt_jar = new File(javaHome, "lib/rt.jar");
+        if (!rt_jar.exists())
+            throw new Exception("rt.jar not found");
+        args.add("-bootclasspath");
+        args.add(rt_jar.getPath());
+
+        args.add(new File(testSrc, "Test.java").getPath());
+        System.out.println("javadoc: " + args);
+
+        int rc = com.sun.tools.javadoc.Main.execute(args.toArray(new String[args.size()]));
+        if (rc != 0)
+            throw new Exception("unexpected exit from javadoc, rc=" + rc);
+
+        if (useSourcePath && useClassPath) {
+            long srcLastMod = new File(testSrc, "Test.java").lastModified();
+            long classLastMod = new File(testClasses, "Test.class").lastModified();
+            System.out.println("Test.java last modified:  " + new Date(srcLastMod));
+            System.out.println("Test.class last modified: " + new Date(classLastMod));
+            System.out.println((srcLastMod > classLastMod ? "source" : "class") + " is newer");
+        }
+
+        String s = "javadoc-for-Base.m";
+        boolean expect = useSourcePath;
+        boolean found = contains(new File(testDir, "Test.html"), s);
+        if (found) {
+            if (expect)
+                System.out.println("javadoc content \"" + s + "\" found, as expected");
+            else
+                error("javadoc content \"" + s + "\" found unexpectedly");
+        } else {
+            if (expect)
+                error("javadoc content \"" + s + "\" not found");
+            else
+                System.out.println("javadoc content \"" + s + "\" not found, as expected");
+        }
+
+        System.out.println();
+    }
+
+    boolean contains(File f, String s) throws Exception {
+        byte[] buf = new byte[(int) f.length()];
+        try (DataInputStream in = new DataInputStream(new FileInputStream(f))) {
+            in.readFully(buf);
+        }
+        return new String(buf).contains(s);
+    }
+
+    void error(String msg) {
+        System.out.println("Error: " + msg);
+        errors++;
+    }
+
+}
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/tools/javadoc/6942366/Test.java	Tue Nov 23 13:32:29 2010 -0800
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2010, 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.
+ */
+
+public class Test extends p.Base {
+    // overrides Base.m
+    public void m() { }
+}
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/tools/javadoc/6942366/p/Base.java	Tue Nov 23 13:32:29 2010 -0800
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2010, 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 p;
+
+public class Base {
+    /** javadoc-for-Base.m. */
+    public void m() { }
+}
+