--- a/langtools/src/share/classes/com/sun/tools/javadoc/Comment.java Fri May 03 09:56:56 2013 -0700
+++ b/langtools/src/share/classes/com/sun/tools/javadoc/Comment.java Fri May 03 10:17:12 2013 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, 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
@@ -25,6 +25,8 @@
package com.sun.tools.javadoc;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
import com.sun.javadoc.*;
import com.sun.tools.javac.util.ListBuffer;
@@ -296,6 +298,7 @@
static Tag[] getInlineTags(DocImpl holder, String inlinetext) {
ListBuffer<Tag> taglist = new ListBuffer<Tag>();
int delimend = 0, textstart = 0, len = inlinetext.length();
+ boolean inPre = false;
DocEnv docenv = holder.env;
if (len == 0) {
@@ -309,6 +312,7 @@
inlinetext.substring(textstart)));
break;
} else {
+ inPre = scanForPre(inlinetext, textstart, linkstart, inPre);
int seetextstart = linkstart;
for (int i = linkstart; i < inlinetext.length(); i++) {
char c = inlinetext.charAt(i);
@@ -319,18 +323,20 @@
}
}
String linkName = inlinetext.substring(linkstart+2, seetextstart);
- //Move past the white space after the inline tag name.
- while (Character.isWhitespace(inlinetext.
- charAt(seetextstart))) {
- if (inlinetext.length() <= seetextstart) {
- taglist.append(new TagImpl(holder, "Text",
- inlinetext.substring(textstart, seetextstart)));
- docenv.warning(holder,
- "tag.Improper_Use_Of_Link_Tag",
- inlinetext);
- return taglist.toArray(new Tag[taglist.length()]);
- } else {
- seetextstart++;
+ if (!(inPre && (linkName.equals("code") || linkName.equals("literal")))) {
+ //Move past the white space after the inline tag name.
+ while (Character.isWhitespace(inlinetext.
+ charAt(seetextstart))) {
+ if (inlinetext.length() <= seetextstart) {
+ taglist.append(new TagImpl(holder, "Text",
+ inlinetext.substring(textstart, seetextstart)));
+ docenv.warning(holder,
+ "tag.Improper_Use_Of_Link_Tag",
+ inlinetext);
+ return taglist.toArray(new Tag[taglist.length()]);
+ } else {
+ seetextstart++;
+ }
}
}
taglist.append(new TagImpl(holder, "Text",
@@ -366,6 +372,17 @@
return taglist.toArray(new Tag[taglist.length()]);
}
+ /** regex for case-insensitive match for {@literal <pre> } and {@literal </pre> }. */
+ private static final Pattern prePat = Pattern.compile("(?i)<(/?)pre>");
+
+ private static boolean scanForPre(String inlinetext, int start, int end, boolean inPre) {
+ Matcher m = prePat.matcher(inlinetext).region(start, end);
+ while (m.find()) {
+ inPre = m.group(1).isEmpty();
+ }
+ return inPre;
+ }
+
/**
* Recursively find the index of the closing '}' character for an inline tag
* and return it. If it can't be found, return -1.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/com/sun/javadoc/testLiteralCodeInPre/TestLiteralCodeInPre.java Fri May 03 10:17:12 2013 -0700
@@ -0,0 +1,117 @@
+/*
+ * Copyright (c) 2002, 2013, 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 8002387
+ * @summary Improve rendered HTML formatting for {@code}
+ * @library ../lib/
+ * @build JavadocTester TestLiteralCodeInPre
+ * @run main TestLiteralCodeInPre
+ */
+
+public class TestLiteralCodeInPre extends JavadocTester {
+
+ //Test information.
+ private static final String BUG_ID = "8002387";
+ private static final String OUTPUT_DIR = BUG_ID;
+
+ //Javadoc arguments.
+ private static final String[] ARGS = new String[] {
+ "-d", OUTPUT_DIR, "-sourcepath", SRC_DIR, "-Xdoclint:none", "pkg"
+ };
+
+ //Input for string search tests.
+ private static final String[][] TEST = {
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "no_pre()</pre>" + NL +
+ "<div class=\"block\">abc<code>def</code>ghi</div>" },
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "no_pre_extra_whitespace()</pre>" + NL +
+ "<div class=\"block\">abc<code>def </code>ghi</div>" },
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "in_pre()</pre>" + NL +
+ "<div class=\"block\"><pre> abc<code> def </code>ghi</pre></div>" },
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "pre_after_text()</pre>" + NL +
+ "<div class=\"block\">xyz <pre> abc<code> def </code>ghi</pre></div>" },
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "after_pre()</pre>" + NL +
+ "<div class=\"block\">xyz <pre> pqr </pre> abc<code>def </code>ghi</div>" },
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "back_in_pre()</pre>" + NL +
+ "<div class=\"block\">xyz <pre> pqr </pre> mno <pre> abc<code> def </code>ghi</pre></div>" },
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "typical_usage_code()</pre>" + NL +
+ "<div class=\"block\">Lorem ipsum dolor sit amet, consectetur adipiscing elit." + NL +
+ " Example: <pre><code>" + NL +
+ " line 1 <T> void m(T t) {" + NL +
+ " line 2 // do something with T" + NL +
+ " line 3 }" + NL +
+ " </code></pre>" + NL +
+ " and so it goes.</div>" },
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "typical_usage_literal()</pre>" + NL +
+ "<div class=\"block\">Lorem ipsum dolor sit amet, consectetur adipiscing elit." + NL +
+ " Example: <pre>" + NL +
+ " line 1 <T> void m(T t) {" + NL +
+ " line 2 // do something with T" + NL +
+ " line 3 }" + NL +
+ " </pre>" + NL +
+ " and so it goes.</div>" },
+ { BUG_ID + FS + "pkg" + FS + "Test.html",
+ "recommended_usage_literal()</pre>" + NL +
+ "<div class=\"block\">Lorem ipsum dolor sit amet, consectetur adipiscing elit." + NL +
+ " Example: <pre>" + NL +
+ " line 1 <T> void m(T t) {" + NL +
+ " line 2 // do something with T" + NL +
+ " line 3 } </pre>" + NL +
+ " and so it goes.</div>" }
+ };
+
+ private static final String[][] NEGATED_TEST = NO_TEST;
+
+ /**
+ * The entry point of the test.
+ * @param args the array of command line arguments.
+ */
+ public static void main(String[] args) {
+ TestLiteralCodeInPre tester = new TestLiteralCodeInPre();
+ run(tester, ARGS, TEST, NEGATED_TEST);
+ tester.printSummary();
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public String getBugId() {
+ return BUG_ID;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public String getBugName() {
+ return getClass().getName();
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/com/sun/javadoc/testLiteralCodeInPre/pkg/Test.java Fri May 03 10:17:12 2013 -0700
@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2013, 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 pkg;
+
+/** */
+public class Test {
+ /**
+ * abc{@code def}ghi
+ */
+ public void no_pre() { }
+
+ /**
+ * abc{@code def }ghi
+ */
+ public void no_pre_extra_whitespace() { }
+
+ /**
+ * <pre> abc{@code def }ghi</pre>
+ */
+ public void in_pre() { }
+
+ /**
+ * xyz <pre> abc{@code def }ghi</pre>
+ */
+ public void pre_after_text() { }
+
+ /**
+ * xyz <pre> pqr </pre> abc{@code def }ghi
+ */
+ public void after_pre() { }
+
+ /**
+ * xyz <pre> pqr </pre> mno <pre> abc{@code def }ghi</pre>
+ */
+ public void back_in_pre() { }
+
+ /**
+ * Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+ * Example: <pre>{@code
+ * line 1 <T> void m(T t) {
+ * line 2 // do something with T
+ * line 3 }
+ * }</pre>
+ * and so it goes.
+ */
+ public void typical_usage_code() { }
+
+ /**
+ * Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+ * Example: <pre>{@literal
+ * line 1 <T> void m(T t) {
+ * line 2 // do something with T
+ * line 3 }
+ * }</pre>
+ * and so it goes.
+ */
+ public void typical_usage_literal() { }
+
+ /**
+ * Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+ * Example: <pre>{@literal
+ * line 1 <T> void m(T t) {
+ * line 2 // do something with T
+ * line 3 } }</pre>
+ * and so it goes.
+ */
+ public void recommended_usage_literal() { }
+
+ /**
+ * abc {@code
+ */
+ public void bad_code_no_content() { }
+
+ /**
+ * abc {@code abc
+ */
+ public void bad_code_content() { }
+}