Hannes Wallnöfer 1e8e543b26 8216497: javadoc should auto-link to platform classes
Co-authored-by: Jan Lahoda <jlahoda@openjdk.org>
Reviewed-by: erikj, jjg
2020-10-07 13:08:34 +00:00

131 lines
7.4 KiB
Java

/*
* Copyright (c) 2019, 2020, 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 8214126 8241470
* @summary Method signatures not formatted correctly in browser
* @library ../../lib/
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestMethodSignature
*/
import javadoc.tester.JavadocTester;
public class TestMethodSignature extends JavadocTester {
public static void main(String... args) throws Exception {
TestMethodSignature tester = new TestMethodSignature();
tester.runTests();
}
@Test
public void test() {
javadoc("-d", "out",
"-sourcepath", testSrc,
"--no-platform-links",
"pkg");
checkExit(Exit.OK);
checkOutput("pkg/C.html", true,
"""
<div class="member-signature"><span class="annotations">@Generated("GeneratedConstructor")
</span><span class="modifiers">public</span>&nbsp;<span class="member-name">C</span>()</div>""",
"""
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;\
<span class="return-type">void</span>&nbsp;<span class="member-name">simpleMetho\
d</span>&#8203;<span class="parameters">(int&nbsp;i,
java.lang.String&nbsp;s,
boolean&nbsp;b)</span></div>""",
"""
<div class="member-signature"><span class="annotations">@Generated(value="SomeGeneratedName",
date="a date",
comments="some comment about the method below")
</span><span class="modifiers">public static</span>&nbsp;<span class="return-typ\
e">void</span>&nbsp;<span class="member-name">annotatedMethod</span>&#8203;<span\
class="parameters">(int&nbsp;i,
java.lang.String&nbsp;s,
boolean&nbsp;b)</span></div>""",
"""
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;\
<span class="type-parameters-long">&lt;T1 extends java.lang.AutoCloseable,&#8203\
;
T2 extends java.lang.AutoCloseable,&#8203;
T3 extends java.lang.AutoCloseable,&#8203;
T4 extends java.lang.AutoCloseable,&#8203;
T5 extends java.lang.AutoCloseable,&#8203;
T6 extends java.lang.AutoCloseable,&#8203;
T7 extends java.lang.AutoCloseable,&#8203;
T8 extends java.lang.AutoCloseable&gt;</span>
<span class="return-type"><a href="C.With8Types.html" title="class in pkg">C.Wit\
h8Types</a>&lt;T1,&#8203;T2,&#8203;T3,&#8203;T4,&#8203;T5,&#8203;T6,&#8203;T7,&#\
8203;T8&gt;</span>&nbsp;<span class="member-name">bigGenericMethod</span>&#8203;\
<span class="parameters">(<a href="C.F0.html" title="interface in pkg">C.F0</a>&\
lt;? extends T1&gt;&nbsp;t1,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T2&gt;&nbsp;t2,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T3&gt;&nbsp;t3,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T4&gt;&nbsp;t4,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T5&gt;&nbsp;t5,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T6&gt;&nbsp;t6,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T7&gt;&nbsp;t7,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T8&gt;&nbsp;t8)</span>
throws <span class="exceptions">java.lang.IllegalArgumentException,
java.lang.IllegalStateException</span></div>""",
"""
<div class="member-signature"><span class="annotations">@Generated(value="SomeGeneratedName",
date="a date",
comments="some comment about the method below")
</span><span class="modifiers">public static</span>&nbsp;<span class="type-param\
eters-long">&lt;T1 extends java.lang.AutoCloseable,&#8203;
T2 extends java.lang.AutoCloseable,&#8203;
T3 extends java.lang.AutoCloseable,&#8203;
T4 extends java.lang.AutoCloseable,&#8203;
T5 extends java.lang.AutoCloseable,&#8203;
T6 extends java.lang.AutoCloseable,&#8203;
T7 extends java.lang.AutoCloseable,&#8203;
T8 extends java.lang.AutoCloseable&gt;</span>
<span class="return-type"><a href="C.With8Types.html" title="class in pkg">C.Wit\
h8Types</a>&lt;T1,&#8203;T2,&#8203;T3,&#8203;T4,&#8203;T5,&#8203;T6,&#8203;T7,&#\
8203;T8&gt;</span>&nbsp;<span class="member-name">bigGenericAnnotatedMethod</spa\
n>&#8203;<span class="parameters">(<a href="C.F0.html" title="interface in pkg">\
C.F0</a>&lt;? extends T1&gt;&nbsp;t1,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T2&gt;&nbsp;t2,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T3&gt;&nbsp;t3,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T4&gt;&nbsp;t4,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T5&gt;&nbsp;t5,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T6&gt;&nbsp;t6,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T7&gt;&nbsp;t7,
<a href="C.F0.html" title="interface in pkg">C.F0</a>&lt;? extends T8&gt;&nbsp;t8)</span>
throws <span class="exc\
eptions">java.lang.IllegalArgumentException,
java.lang.IllegalStateException</span></div>
<div class="block">Generic method with eight type args and annotation.</div>""");
}
}