8006228: Doclint doesn't detect <code> {@code nested inline} </code>

Wed, 16 Jan 2013 20:41:14 -0800

author
jjg
date
Wed, 16 Jan 2013 20:41:14 -0800
changeset 1502
916143318f10
parent 1501
8b749558767b
child 1503
2d2b2be57c78

8006228: Doclint doesn't detect <code> {@code nested inline} </code>
Reviewed-by: darcy

src/share/classes/com/sun/tools/doclint/Checker.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/doclint/resources/doclint.properties file | annotate | diff | comparison | revisions
test/tools/doclint/LiteralTest.java file | annotate | diff | comparison | revisions
test/tools/doclint/LiteralTest.out file | annotate | diff | comparison | revisions
     1.1 --- a/src/share/classes/com/sun/tools/doclint/Checker.java	Wed Jan 16 13:22:09 2013 -0800
     1.2 +++ b/src/share/classes/com/sun/tools/doclint/Checker.java	Wed Jan 16 20:41:14 2013 -0800
     1.3 @@ -556,7 +556,7 @@
     1.4          if (tree.getKind() == DocTree.Kind.CODE) {
     1.5              for (TagStackItem tsi: tagStack) {
     1.6                  if (tsi.tag == HtmlTag.CODE) {
     1.7 -                    env.messages.warning(HTML, tree, "dc.tag.nested.not.allowed", "code");
     1.8 +                    env.messages.warning(HTML, tree, "dc.tag.code.within.code");
     1.9                      break;
    1.10                  }
    1.11              }
     2.1 --- a/src/share/classes/com/sun/tools/doclint/resources/doclint.properties	Wed Jan 16 13:22:09 2013 -0800
     2.2 +++ b/src/share/classes/com/sun/tools/doclint/resources/doclint.properties	Wed Jan 16 20:41:14 2013 -0800
     2.3 @@ -48,6 +48,7 @@
     2.4  dc.no.summary.or.caption.for.table=no summary or caption for table
     2.5  dc.param.name.not.found = @param name not found
     2.6  dc.ref.not.found = reference not found
     2.7 +dc.tag.code.within.code = '{@code'} within <code>
     2.8  dc.tag.empty = empty <{0}> tag
     2.9  dc.tag.end.not.permitted = invalid end tag: </{0}>
    2.10  dc.tag.end.unexpected = unexpected end tag: </{0}>
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/test/tools/doclint/LiteralTest.java	Wed Jan 16 20:41:14 2013 -0800
     3.3 @@ -0,0 +1,16 @@
     3.4 +/*
     3.5 + * @test /nodynamiccopyright/
     3.6 + * @bug 8006228
     3.7 + * @summary Doclint doesn't detect <code> {@code nested inline} </code>
     3.8 + * @build DocLintTester
     3.9 + * @run main DocLintTester -ref LiteralTest.out LiteralTest.java
    3.10 + */
    3.11 +
    3.12 +/** */
    3.13 +public class LiteralTest {
    3.14 +    /** <code> abc {@literal < & > } def </code> */
    3.15 +    public void ok_literal_in_code() { }
    3.16 +
    3.17 +    /** <code> abc {@code < & > } def </code> */
    3.18 +    public void bad_code_in_code() { }
    3.19 +}
     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/test/tools/doclint/LiteralTest.out	Wed Jan 16 20:41:14 2013 -0800
     4.3 @@ -0,0 +1,4 @@
     4.4 +LiteralTest.java:14: warning: {@code} within <code>
     4.5 +    /** <code> abc {@code < & > } def </code> */
     4.6 +                   ^
     4.7 +1 warning

mercurial