-
Notifications
You must be signed in to change notification settings - Fork 6.2k
8177100: APIs duplicated in JavaDoc #25123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
4a55b00
41578ad
8d30046
d630e6a
d9ef182
fccec4c
c7b6269
4c645c7
684a880
315922f
23ce62f
b53817d
071fcf3
caeb20a
55e29d3
79a1aa0
00e7adc
cd67eac
a34c4d5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,220 @@ | ||
/* | ||
* Copyright (c) 2025, 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 8177100 | ||
* @summary Test to check for duplicate methods across different inheritance patterns | ||
* @library /tools/lib ../../lib | ||
* @modules jdk.javadoc/jdk.javadoc.internal.tool | ||
* @build toolbox.ToolBox javadoc.tester.* | ||
* @run main TestDuplicateMethods | ||
*/ | ||
|
||
import java.io.IOException; | ||
import java.nio.file.Path; | ||
|
||
import javadoc.tester.JavadocTester; | ||
import toolbox.ToolBox; | ||
|
||
public class TestDuplicateMethods extends JavadocTester { | ||
|
||
public static void main(String... args) throws Exception { | ||
var tester = new TestDuplicateMethods(); | ||
tester.runTests(); | ||
} | ||
|
||
ToolBox tb = new ToolBox(); | ||
Path src = Path.of("src"); | ||
|
||
|
||
TestDuplicateMethods() throws IOException { | ||
// Diamond class inheritance | ||
tb.writeJavaFiles(src, """ | ||
package p; | ||
interface A { | ||
/** | ||
* JavaDoc for method in interface A. | ||
*/ | ||
abstract void testA( ); | ||
}""", """ | ||
package p; | ||
interface B extends A { | ||
/** | ||
* JavaDoc for method in interface B. | ||
*/ | ||
abstract void testB( ); | ||
}""", """ | ||
package p; | ||
abstract class C implements A { | ||
/** | ||
* Inherited JavaDoc for method in class C. | ||
*/ | ||
public final void testA( ) { | ||
// Do nothing. | ||
} | ||
}""",""" | ||
package p; | ||
public final class D extends C implements B { | ||
/** | ||
* Inherited JavaDoc. | ||
*/ | ||
public final void testB() { | ||
// Do nothing. | ||
} | ||
} | ||
"""); | ||
|
||
// Mirrors the implementation of StringBuilder | ||
tb.writeJavaFiles(src, | ||
""" | ||
package sb; | ||
public interface I { | ||
/** | ||
* JavaDoc for method in public interface I. | ||
*/ | ||
void testI(); | ||
} | ||
""", """ | ||
package sb; | ||
abstract class P implements I { | ||
/** | ||
* Inherited JavaDoc for method in class P. | ||
*/ | ||
public final void testI() { | ||
// Do nothing. | ||
} | ||
} | ||
""", """ | ||
package sb; | ||
public class U extends P implements I { | ||
// No overrides | ||
} | ||
""" | ||
); | ||
|
||
// Mirrors the implementation of HashMap | ||
tb.writeJavaFiles(src, | ||
""" | ||
package hm; | ||
public interface J { | ||
/** | ||
* JavaDoc for method in public interface J. | ||
*/ | ||
void testJ(); | ||
} | ||
""", | ||
""" | ||
package hm; | ||
public abstract class PubJ implements J { | ||
/** | ||
* Inherited JavaDoc for method in public abstract class PubJ. | ||
*/ | ||
public final void testJ() { | ||
// Do nothing. | ||
} | ||
} | ||
""", | ||
""" | ||
package hm; | ||
public class V extends PubJ implements J { | ||
// No override | ||
} | ||
""" | ||
); | ||
} | ||
|
||
@Test | ||
public void testDiamondInheritance(Path base) { | ||
javadoc("-d", base.resolve("out").toString(), | ||
"-sourcepath", src.toString(), | ||
"p"); | ||
checkExit(Exit.OK); | ||
checkOutput("p/D.html", true, | ||
""" | ||
<div class="block">Inherited JavaDoc for method in class C.</div> | ||
""", """ | ||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">testA</span>()</div> | ||
<div class="block">Inherited JavaDoc for method in class C.</div> | ||
""" | ||
); | ||
|
||
checkOutput("p/D.html", false, """ | ||
<div class="block">JavaDoc for method in Interface A.</div>""", """ | ||
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">testA</span>()</div> | ||
<div class="block">JavaDoc for method in Interface A.</div>"""); | ||
|
||
|
||
checkOutput("p/D.html", false, | ||
""" | ||
<div class="block">JavaDoc for method in interface A.</div> | ||
"""); | ||
} | ||
|
||
@Test | ||
public void testStringBuilderInheritance(Path base) { | ||
javadoc("-d", base.resolve("out").toString(), | ||
"-sourcepath", src.toString(), | ||
"sb"); | ||
checkExit(Exit.OK); | ||
|
||
checkOutput("sb/U.html", false, | ||
""" | ||
<div class="inherited-list"> | ||
<h3 id="methods-inherited-from-class-sb.I">Methods inherited from interface <a href="I.html#method-summary" title="interface in sb">I</a></h3> | ||
<code><a href="I.html#testI()" title="testI()">testI</a></code></div> | ||
"""); | ||
|
||
checkOutput("sb/U.html", true, | ||
""" | ||
<h3>testI</h3> | ||
<div class="horizontal-scroll"> | ||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">testI</span>()</div> | ||
<div class="block">Inherited JavaDoc for method in class P.</div> | ||
<dl class="notes"> | ||
<dt>Specified by:</dt> | ||
<dd><code><a href="I.html#testI()">testI</a></code> in interface <code><a href="I.html" title="interface in sb">I</a></code></dd> | ||
</dl>"""); | ||
} | ||
|
||
@Test | ||
public void testHashMapInheritance(Path base) { | ||
javadoc("-d", base.resolve("out").toString(), | ||
"-sourcepath", src.toString(), | ||
"hm"); | ||
checkExit(Exit.OK); | ||
|
||
checkOutput("hm/V.html", false, | ||
""" | ||
<div class="inherited-list"> | ||
<h3 id="methods-inherited-from-class-hm.J">Methods inherited from interface <a href="J.html#method-summary" title="interface in hm">J</a></h3> | ||
<code><a href="J.html#testJ()" title="testJ()">testJ</a></code></div>"""); | ||
|
||
checkOutput("hm/V.html", true, | ||
""" | ||
<div class="inherited-list"> | ||
<h3 id="methods-inherited-from-class-hm.PubJ">Methods inherited from class <a href="PubJ.html#method-summary" title="class in hm">PubJ</a></h3> | ||
<code><a href="PubJ.html#testJ()" title="testJ()">testJ</a></code></div> | ||
"""); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's the doc for the constructor. I was looking for method There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, that's what should be tested. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in a34c4d5. |
||
} | ||
} |
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add a positive check to this test and
testHashMapInheritance
that the method is documented as expected (as local method in this test, and as inherited from the public abstract class intestHashMapInheritance
), and that the method details has a "Specified by: ..." entry pointing to the interface method?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the test to add a positive check. Tests are currently running in CI.
If the update look trivial enough, could you set the reviewer count back to 1?