changeset 43145:35ee451a5fd3

8172474: javac should enable doclint checking for HTML 5 Reviewed-by: jlahoda
author jjg
date Fri, 13 Jan 2017 15:48:12 -0800
parents b5e41646e1a6
children 7c249fca6c06
files langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/main/Arguments.java langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/main/Option.java langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac.properties langtools/test/tools/javac/doclint/DocLintFormatTest.java
diffstat 4 files changed, 121 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/main/Arguments.java	Fri Jan 13 01:35:30 2017 +0000
+++ b/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/main/Arguments.java	Fri Jan 13 15:48:12 2017 -0800
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 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
@@ -818,13 +818,17 @@
             return List.nil();
 
         String checkPackages = options.get(Option.XDOCLINT_PACKAGE);
-
         if (checkPackages != null) {
             for (String s : checkPackages.split("\\s+")) {
                 doclintOpts.add(DocLint.XCHECK_PACKAGE + s);
             }
         }
 
+        String format = options.get(Option.DOCLINT_FORMAT);
+        if (format != null) {
+            doclintOpts.add(DocLint.XHTML_VERSION_PREFIX + format);
+        }
+
         // standard doclet normally generates H1, H2,
         // so for now, allow user comments to assume that
         doclintOpts.add(DocLint.XIMPLICIT_HEADERS + "2");
--- a/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/main/Option.java	Fri Jan 13 01:35:30 2017 +0000
+++ b/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/main/Option.java	Fri Jan 13 15:48:12 2017 -0800
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2006, 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
@@ -154,6 +154,8 @@
         }
     },
 
+    DOCLINT_FORMAT("--doclint-format", "opt.doclint.format", EXTENDED, BASIC, ONEOF, "html4", "html5"),
+
     // -nowarn is retained for command-line backward compatibility
     NOWARN("-nowarn", "opt.nowarn", STANDARD, BASIC) {
         @Override
@@ -1216,10 +1218,12 @@
         sb.append(name);
         if (argsNameKey == null) {
             if (choices != null) {
+                if (!name.endsWith(":"))
+                    sb.append(" ");
                 String sep = "{";
                 for (String choice : choices) {
                     sb.append(sep);
-                    sb.append(choices);
+                    sb.append(choice);
                     sep = ",";
                 }
                 sb.append("}");
--- a/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac.properties	Fri Jan 13 01:35:30 2017 +0000
+++ b/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac.properties	Fri Jan 13 15:48:12 2017 -0800
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 1999, 2016, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 1999, 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
@@ -263,6 +263,9 @@
     expands to all sub-packages of the given package. Each <package> can be prefixed\n\
     with '-' to disable checks for the specified package or packages.
 
+javac.opt.doclint.format=\
+    Specify the format for documentation comments
+
 javac.opt.Xstdout=\
     Redirect standard output
 javac.opt.X=\
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/javac/doclint/DocLintFormatTest.java	Fri Jan 13 15:48:12 2017 -0800
@@ -0,0 +1,105 @@
+/*
+ * Copyright (c) 2012, 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 8172474
+ * @summary javac should enable doclint checking for HTML 5
+ * @library /tools/lib
+ * @modules jdk.compiler/com.sun.tools.javac.api
+ *          jdk.compiler/com.sun.tools.javac.main
+ * @build toolbox.ToolBox toolbox.JavacTask
+ * @run main DocLintFormatTest
+ */
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+
+import toolbox.JavacTask;
+import toolbox.Task;
+import toolbox.ToolBox;
+
+public class DocLintFormatTest {
+    public static void main(String... args) throws Exception {
+        new DocLintFormatTest().run();
+    }
+
+    private ToolBox tb = new ToolBox();
+    private Path src = Paths.get("src");
+    private Path classes = Paths.get("classes");
+
+    void run() throws Exception {
+        Files.createDirectories(classes);
+
+        tb.writeJavaFiles(src,
+            //        1         2
+            //2345678901234567890
+            "/** This is an <tt>HTML 4</tt> comment. */ public class Test4 { }",
+            "/** This is an <mark>HTML 5</mark> comment. */ public class Test5 { }"
+        );
+
+        test(src.resolve("Test4.java"), "html4");
+        test(src.resolve("Test4.java"), "html5",
+                "Test4.java:1:16: compiler.err.proc.messager: tag not supported in the generated HTML version: tt");
+        test(src.resolve("Test5.java"), "html4",
+                "Test5.java:1:16: compiler.err.proc.messager: tag not supported in the generated HTML version: mark");
+        test(src.resolve("Test5.java"), "html5");
+
+        if (errors > 0) {
+            throw new Exception(errors + " errors occurred");
+        }
+    }
+
+    void test(Path file, String format, String... expect) {
+        System.err.println("Test: " + format + " " + file);
+        List<String> output = new JavacTask(tb)
+                  .outdir(classes)
+                  .options("-XDrawDiagnostics", "-Xdoclint", "--doclint-format", format)
+                  .files(file)
+                  .run(expect.length == 0 ? Task.Expect.SUCCESS : Task.Expect.FAIL)
+                  .writeAll()
+                  .getOutputLines(Task.OutputKind.DIRECT);
+
+        if (expect.length == 0) {
+            if (!(output.size() == 1 && output.get(0).isEmpty())) {
+                error("All output unexpected.");
+            }
+        } else {
+            for (String e : expect) {
+                if (!output.contains(e)) {
+                    error("expected output not found: " + e);
+                }
+            }
+        }
+    }
+
+    void error(String message) {
+        System.err.println("Error: " + message);
+        errors++;
+    }
+
+    private int errors = 0;
+}
+