/*
* Copyright (c) 2003, 2024, 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 7025314 8023700 7198273 8025633 8026567 8081854 8196027 8182765
* 8196200 8196202 8223378 8258659 8261976 8320458 8329537
* @summary Make sure the Next/Prev Class links iterate through all types.
* Make sure the navagation is 2 columns, not 3.
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.* builder.ClassBuilder
* @run main TestNavigation
*/
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
import builder.ClassBuilder;
import toolbox.ToolBox;
public class TestNavigation extends JavadocTester {
public final ToolBox tb;
public static void main(String... args) throws Exception {
var tester = new TestNavigation();
tester.runTests();
}
public TestNavigation() {
tb = new ToolBox();
}
@Test
public void testOverview(Path base) {
javadoc("-d", base.resolve("api").toString(),
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkSubNav();
checkOutput("index.html", true,
"""
""");
checkOutput("pkg/package-summary.html", true,
"""
""");
checkOutput("pkg/A.html", true,
"""
""");
checkOutput("pkg/C.html", true,
"""
""");
checkOutput("pkg/E.html", true,
"""
""");
checkOutput("pkg/I.html", true,
// Test for 4664607
"""
""",
"""
- Overview
""");
}
@Test
public void testNavLinks(Path base) throws IOException {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package pkg1; public class A {
/**
* Class with members.
*/
public static class X {
/**
* A ctor
*/
public X() {
}
/**
* A field
*/
public int field;
/**
* A method
*/
public void method() {
}
/**
* An inner class
*/
public static class IC {
}
}
/**
* Class with all inherited members.
*/
public static class Y extends X {
}
}""");
tb.writeJavaFiles(src,
"package pkg1; public class C {\n"
+ "}");
tb.writeJavaFiles(src,
"""
package pkg1; public interface InterfaceWithNoMembers {
}""");
javadoc("-d", base.resolve("api").toString(),
"-sourcepath", src.toString(),
"pkg1");
checkExit(Exit.OK);
checkOrder("pkg1/A.X.html",
"""
- pkg1
- A
- X
""",
"""
- Description
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary
- Field Details
- field
- Constructor Details
- X()
- Method Details
- method()
""");
checkOrder("pkg1/A.Y.html",
"""
- pkg1
- A
- Y
""",
"""
- Description
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary
- Constructor Details
- Y()
""");
checkOrder("pkg1/A.X.IC.html",
"""
- pkg1
- A
- X
- IC
""",
"""
- Description
- Constructor Summary
- Method Summary
- Constructor Details
- IC()
""");
checkOrder("pkg1/C.html",
"""
- Description
- Constructor Summary
- Method Summary
- Constructor Details
- C()
""");
checkOrder("pkg1/InterfaceWithNoMembers.html",
"""
- Description
""");
}
private void checkSubNav() {
checkOutput("pkg/A.html", false,
"All Classes",
"""