6758050: javadoc handles nested generic types incorrectly

Mon, 18 Apr 2011 15:39:16 -0700

author
bpatel
date
Mon, 18 Apr 2011 15:39:16 -0700
changeset 981
bbd053476ec3
parent 973
5ed971fce27c
child 982
671bb63f3ed5

6758050: javadoc handles nested generic types incorrectly
Reviewed-by: jjg

src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java file | annotate | diff | comparison | revisions
test/com/sun/javadoc/testNestedGenerics/TestNestedGenerics.java file | annotate | diff | comparison | revisions
test/com/sun/javadoc/testNestedGenerics/pkg/NestedGenerics.java file | annotate | diff | comparison | revisions
     1.1 --- a/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java	Sun Apr 17 16:23:22 2011 -0700
     1.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java	Mon Apr 18 15:39:16 2011 -0700
     1.3 @@ -2120,7 +2120,7 @@
     1.4                  }
     1.5              }
     1.6              text = (isplaintext) ?
     1.7 -                refMemName : getCode() + refMemName + getCodeEnd();
     1.8 +                refMemName : getCode() + Util.escapeHtmlChars(refMemName) + getCodeEnd();
     1.9  
    1.10              result.append(getDocLink(LinkInfoImpl.CONTEXT_SEE_TAG, containing,
    1.11                  refMem, (label.length() == 0)? text: label, false));
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/test/com/sun/javadoc/testNestedGenerics/TestNestedGenerics.java	Mon Apr 18 15:39:16 2011 -0700
     2.3 @@ -0,0 +1,78 @@
     2.4 +/*
     2.5 + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
     2.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     2.7 + *
     2.8 + * This code is free software; you can redistribute it and/or modify it
     2.9 + * under the terms of the GNU General Public License version 2 only, as
    2.10 + * published by the Free Software Foundation.
    2.11 + *
    2.12 + * This code is distributed in the hope that it will be useful, but WITHOUT
    2.13 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    2.14 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    2.15 + * version 2 for more details (a copy is included in the LICENSE file that
    2.16 + * accompanied this code).
    2.17 + *
    2.18 + * You should have received a copy of the GNU General Public License version
    2.19 + * 2 along with this work; if not, write to the Free Software Foundation,
    2.20 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    2.21 + *
    2.22 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    2.23 + * or visit www.oracle.com if you need additional information or have any
    2.24 + * questions.
    2.25 + */
    2.26 +
    2.27 +/*
    2.28 + * @test
    2.29 + * @bug      6758050
    2.30 + * @summary  Test HTML output for nested generic types.
    2.31 + * @author   bpatel
    2.32 + * @library  ../lib/
    2.33 + * @build    JavadocTester TestNestedGenerics
    2.34 + * @run main TestNestedGenerics
    2.35 + */
    2.36 +
    2.37 +public class TestNestedGenerics extends JavadocTester {
    2.38 +
    2.39 +    //Test information.
    2.40 +    private static final String BUG_ID = "6758050";
    2.41 +
    2.42 +    //Javadoc arguments.
    2.43 +    private static final String[] ARGS = new String[]{
    2.44 +        "-d", BUG_ID, "-source", "1.5", "-sourcepath", SRC_DIR,
    2.45 +        "pkg"
    2.46 +    };
    2.47 +
    2.48 +    //Input for string search tests.
    2.49 +    private static final String[][] TEST = {
    2.50 +        {BUG_ID + FS + "pkg" + FS + "NestedGenerics.html",
    2.51 +            "<div class=\"block\">Contains <a " +
    2.52 +            "href=\"../pkg/NestedGenerics.html#foo(java.util.Map)\"><code>foo" +
    2.53 +            "(java.util.Map&lt;A, java.util.Map&lt;A, A&gt;&gt;)</code></a></div>"
    2.54 +        }
    2.55 +    };
    2.56 +    private static final String[][] NEGATED_TEST = NO_TEST;
    2.57 +
    2.58 +    /**
    2.59 +     * The entry point of the test.
    2.60 +     * @param args the array of command line arguments.
    2.61 +     */
    2.62 +    public static void main(String[] args) {
    2.63 +        TestNestedGenerics tester = new TestNestedGenerics();
    2.64 +        run(tester, ARGS, TEST, NEGATED_TEST);
    2.65 +        tester.printSummary();
    2.66 +    }
    2.67 +
    2.68 +    /**
    2.69 +     * {@inheritDoc}
    2.70 +     */
    2.71 +    public String getBugId() {
    2.72 +        return BUG_ID;
    2.73 +    }
    2.74 +
    2.75 +    /**
    2.76 +     * {@inheritDoc}
    2.77 +     */
    2.78 +    public String getBugName() {
    2.79 +        return getClass().getName();
    2.80 +    }
    2.81 +}
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/test/com/sun/javadoc/testNestedGenerics/pkg/NestedGenerics.java	Mon Apr 18 15:39:16 2011 -0700
     3.3 @@ -0,0 +1,31 @@
     3.4 +/*
     3.5 + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
     3.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     3.7 + *
     3.8 + * This code is free software; you can redistribute it and/or modify it
     3.9 + * under the terms of the GNU General Public License version 2 only, as
    3.10 + * published by the Free Software Foundation.
    3.11 + *
    3.12 + * This code is distributed in the hope that it will be useful, but WITHOUT
    3.13 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    3.14 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    3.15 + * version 2 for more details (a copy is included in the LICENSE file that
    3.16 + * accompanied this code).
    3.17 + *
    3.18 + * You should have received a copy of the GNU General Public License version
    3.19 + * 2 along with this work; if not, write to the Free Software Foundation,
    3.20 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    3.21 + *
    3.22 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    3.23 + * or visit www.oracle.com if you need additional information or have any
    3.24 + * questions.
    3.25 + */
    3.26 +
    3.27 +package pkg;
    3.28 +
    3.29 +import java.util.Map;
    3.30 +
    3.31 +/** Contains {@link #foo} */
    3.32 +public class NestedGenerics {
    3.33 +  public static <A> void foo(Map<A, Map<A, A>> map) {}
    3.34 +}

mercurial