345 lines
15 KiB
Java
345 lines
15 KiB
Java
/*
|
|
* Copyright (c) 2013, 2023, 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 4749567 8071982 8175200 8186332 8185371 8182765 8217034 8261976 8261976
|
|
* 8275786
|
|
* @summary Test the output for -header, -footer, -nooverview, -nodeprecatedlist,
|
|
* -nonavbar, -notree, -stylesheetfile, --main-stylesheet, --add-stylesheet,
|
|
* --add-script options.
|
|
* @library ../../lib
|
|
* @modules jdk.javadoc/jdk.javadoc.internal.tool
|
|
* @build javadoc.tester.*
|
|
* @run main TestOptions
|
|
*/
|
|
|
|
import java.io.File;
|
|
|
|
import javadoc.tester.JavadocTester;
|
|
|
|
public class TestOptions extends JavadocTester {
|
|
|
|
public static void main(String... args) throws Exception {
|
|
var tester = new TestOptions();
|
|
tester.runTests();
|
|
}
|
|
|
|
@Test
|
|
public void testHeader() {
|
|
javadoc("-d", "out-1",
|
|
"-header", "Test header",
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.OK);
|
|
|
|
checkOutput("pkg/package-summary.html", true,
|
|
"""
|
|
<div class="about-language">Test header</div>""");
|
|
}
|
|
|
|
@Test
|
|
public void testNoOverview() {
|
|
javadoc("-d", "out-4",
|
|
"-nooverview",
|
|
"-sourcepath", testSrc,
|
|
"pkg", "deprecated");
|
|
|
|
checkExit(Exit.OK);
|
|
|
|
checkFiles(false, "overview-summary.html");
|
|
}
|
|
|
|
@Test
|
|
public void testNoDeprecatedList() {
|
|
javadoc("-d", "out-5",
|
|
"-nodeprecatedlist",
|
|
"-sourcepath", testSrc,
|
|
"deprecated");
|
|
checkExit(Exit.OK);
|
|
|
|
checkFiles(false, "deprecated-list.html");
|
|
}
|
|
|
|
@Test
|
|
public void testNoNavbar() {
|
|
javadoc("-d", "out-6",
|
|
"-nonavbar",
|
|
"-bottom", "Bottom text",
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.OK);
|
|
|
|
checkOutput("pkg/Foo.html", false, "navbar");
|
|
checkOutput("pkg/Foo.html", true, "Bottom text");
|
|
}
|
|
|
|
@Test
|
|
public void testNoTree() {
|
|
javadoc("-d", "out-7",
|
|
"-notree",
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.OK);
|
|
|
|
checkFiles(false, "overview-tree.html");
|
|
checkFiles(false, "pkg/package-tree.html");
|
|
checkOutput("pkg/Foo.html", false, """
|
|
<li><a href="package-tree.html">Tree</a></li>""");
|
|
}
|
|
|
|
@Test
|
|
public void testStylesheetFile() {
|
|
javadoc("-d", "out-8",
|
|
"-stylesheetfile", new File(testSrc, "custom-stylesheet.css").getAbsolutePath(),
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.OK);
|
|
|
|
checkOutput("resource-files/custom-stylesheet.css", true, "Custom javadoc style sheet");
|
|
checkOutput("pkg/Foo.html", true, """
|
|
<link rel="stylesheet" type="text/css" href="../resource-files/custom-stylesheet.css" title="Style">""");
|
|
}
|
|
|
|
@Test
|
|
public void testStylesheetFileAltOption() {
|
|
javadoc("-d", "out-stylesheet-file",
|
|
"--main-stylesheet", new File(testSrc, "custom-stylesheet.css").getAbsolutePath(),
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.OK);
|
|
|
|
checkOutput("resource-files/custom-stylesheet.css", true, "Custom javadoc style sheet");
|
|
checkOutput("pkg/Foo.html", true, """
|
|
<link rel="stylesheet" type="text/css" href="../resource-files/custom-stylesheet.css" title="Style">""");
|
|
}
|
|
|
|
@Test
|
|
public void testAdditionalStylesheetFile() {
|
|
javadoc("-d", "out-additional-css",
|
|
"--add-stylesheet", new File(testSrc, "additional-stylesheet-1.css").getAbsolutePath(),
|
|
"--add-stylesheet", new File(testSrc, "additional-stylesheet-2.css").getAbsolutePath(),
|
|
"--add-stylesheet", new File(testSrc, "additional-stylesheet-3.css").getAbsolutePath(),
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.OK);
|
|
|
|
checkOutput("resource-files/additional-stylesheet-1.css", true, "Additional javadoc style sheet 1");
|
|
checkOutput("resource-files/additional-stylesheet-2.css", true, "Additional javadoc style sheet 2");
|
|
checkOutput("resource-files/additional-stylesheet-3.css", true, "Additional javadoc style sheet 3");
|
|
checkOutput("pkg/Foo.html", true,
|
|
"""
|
|
<link rel="stylesheet" type="text/css" href="../resource-files/additional-stylesheet-1.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../resource-files/additional-stylesheet-2.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../resource-files/additional-stylesheet-3.css" title="Style">""");
|
|
}
|
|
|
|
@Test
|
|
public void testInvalidStylesheetFile() {
|
|
javadoc("-d", "out-invalid-css",
|
|
"--main-stylesheet", new File(testSrc, "custom-stylesheet-1.css").getAbsolutePath(),
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.ERROR);
|
|
|
|
checkOutput(Output.OUT, true,
|
|
"error: File not found:",
|
|
"custom-stylesheet-1.css");
|
|
}
|
|
|
|
@Test
|
|
public void testInvalidAdditionalStylesheetFiles() {
|
|
javadoc("-d", "out-invalid-additional-css",
|
|
"--add-stylesheet", new File(testSrc, "additional-stylesheet-4.css").getAbsolutePath(),
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.ERROR);
|
|
|
|
checkOutput(Output.OUT, true,
|
|
"error: File not found:",
|
|
"additional-stylesheet-4.css");
|
|
}
|
|
|
|
@Test
|
|
public void testAdditionalScriptFile() {
|
|
javadoc("-d", "out-additional-script",
|
|
"--add-script", new File(testSrc, "additional-script-1.js").getAbsolutePath(),
|
|
"--add-script", new File(testSrc, "additional-script-2.js").getAbsolutePath(),
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.OK);
|
|
|
|
checkOutput("script-files/additional-script-1.js", true, "Additional script file 1");
|
|
checkOutput("script-files/additional-script-2.js", true, "Additional script file 2");
|
|
checkOutput("pkg/Foo.html", true,
|
|
"""
|
|
<script type="text/javascript" src="../script-files/additional-script-1.js"></script>
|
|
<script type="text/javascript" src="../script-files/additional-script-2.js"></script>
|
|
""");
|
|
}
|
|
|
|
@Test
|
|
public void testInvalidAdditionalScriptFile() {
|
|
javadoc("-d", "out-invalid-additional-script",
|
|
"--add-script", new File(testSrc, "additional-script-3.js").getAbsolutePath(),
|
|
"-sourcepath", testSrc,
|
|
"pkg");
|
|
checkExit(Exit.ERROR);
|
|
|
|
checkOutput(Output.OUT, true,
|
|
"error: File not found:",
|
|
"additional-script-3.js");
|
|
}
|
|
|
|
@Test
|
|
public void testLinkSource() {
|
|
javadoc("-d", "out-9",
|
|
"-linksource",
|
|
"--no-platform-links",
|
|
"-javafx",
|
|
"--disable-javafx-strict-checks",
|
|
"-sourcepath", testSrc,
|
|
"-package",
|
|
"linksource");
|
|
checkExit(Exit.OK);
|
|
checkLinks();
|
|
checkOutput("linksource/AnnotationTypeField.html", true,
|
|
"""
|
|
<div class="type-signature"><span class="annotations">@Documented
|
|
</span><span class="modifiers">public @interface </span><span class="element-name"><a hr\
|
|
ef="../src-html/linksource/AnnotationTypeField.html#line-31">AnnotationTypeField\
|
|
</a></span></div>""",
|
|
"""
|
|
<section class="detail" id="DEFAULT_NAME">
|
|
<h3>DEFAULT_NAME</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">static final</span> <\
|
|
span class="return-type">java.lang.String</span> <span class="element-name"><a href\
|
|
="../src-html/linksource/AnnotationTypeField.html#line-32">DEFAULT_NAME</a></spa\
|
|
n></div>""",
|
|
"""
|
|
<section class="detail" id="name()">
|
|
<h3>name</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="return-type">java.lang.String</span>&\
|
|
nbsp;<span class="element-name"><a href="../src-html/linksource/AnnotationTypeField.html\
|
|
#line-34">name</a></span></div>""");
|
|
|
|
checkOutput("src-html/linksource/AnnotationTypeField.html", true,
|
|
"<title>Source code</title>",
|
|
"""
|
|
<span class="source-line-no">031</span><span id="line-31">@Documented public @interface AnnotationTypeField {</span>""");
|
|
|
|
checkOutput("linksource/Properties.html", true,
|
|
"""
|
|
<div class="type-signature"><span class="modifiers">public class </span><span cl\
|
|
ass="element-name"><a href="../src-html/linksource/Properties.html#line-29">Properties</a>""",
|
|
"""
|
|
<div class="member-signature"><span class="modifiers">public</span> <span c\
|
|
lass="return-type">java.lang.Object</span> <span class="element-name"><a href="../s\
|
|
rc-html/linksource/Properties.html#line-31">someProperty</a></span></div>""");
|
|
|
|
checkOutput("src-html/linksource/Properties.html", true,
|
|
"<title>Source code</title>",
|
|
"""
|
|
<span class="source-line-no">031</span><span id="line-31"> public Object someProperty() {</span>""");
|
|
|
|
checkOutput("linksource/SomeClass.html", true,
|
|
"""
|
|
<div class="type-signature"><span class="modifiers">public class </span><span cl\
|
|
ass="element-name"><a href="../src-html/linksource/SomeClass.html#line-29">SomeC\
|
|
lass</a></span>
|
|
<span class="extends-implements">extends java.lang.Object</span></div>""",
|
|
"""
|
|
<div class="member-signature"><span class="modifiers">public</span> <span c\
|
|
lass="return-type">int</span> <span class="element-name"><a href="../src-html/links\
|
|
ource/SomeClass.html#line-31">field</a></span></div>""",
|
|
"""
|
|
<div class="member-signature"><span class="modifiers">public</span> <span c\
|
|
lass="element-name"><a href="../src-html/linksource/SomeClass.html#line-33">Some\
|
|
Class</a></span>()</div>""",
|
|
"""
|
|
<div class="member-signature"><span class="modifiers">public</span> <span c\
|
|
lass="return-type">int</span> <span class="element-name"><a href="../src-html/links\
|
|
ource/SomeClass.html#line-36">method</a></span>()</div>""");
|
|
|
|
checkOutput("src-html/linksource/SomeClass.html", true,
|
|
"<title>Source code</title>",
|
|
"""
|
|
<span class="source-line-no">029</span><span id="line-29">public class SomeClass {</span>""",
|
|
"""
|
|
<span class="source-line-no">031</span><span id="line-31"> public int field;</span>""",
|
|
"""
|
|
<span class="source-line-no">033</span><span id="line-33"> public SomeClass() {</span>""",
|
|
"""
|
|
<span class="source-line-no">036</span><span id="line-36"> public int method() {</span>""");
|
|
|
|
checkOutput("linksource/SomeEnum.html", true,
|
|
"""
|
|
<div class="member-signature"><span class="modifiers">public static final</span>\
|
|
<span class="return-type"><a href="SomeEnum.html" title="enum class in linksourc\
|
|
e">SomeEnum</a></span> <span class="element-name"><a href="../src-html/linksource/S\
|
|
omeEnum.html#line-29">VALUE1</a></span></div>""",
|
|
"""
|
|
<div class="member-signature"><span class="modifiers">public static final</span>\
|
|
<span class="return-type"><a href="SomeEnum.html" title="enum class in linksourc\
|
|
e">SomeEnum</a></span> <span class="element-name"><a href="../src-html/linksource/S\
|
|
omeEnum.html#line-30">VALUE2</a></span></div>""");
|
|
|
|
checkOutput("src-html/linksource/SomeEnum.html", true,
|
|
"""
|
|
<span class="source-line-no">029</span><span id="line-29"> VALUE1,</span>""",
|
|
"""
|
|
<span class="source-line-no">030</span><span id="line-30"> VALUE2</span>""");
|
|
}
|
|
|
|
@Test
|
|
public void testNoQualifier() {
|
|
javadoc("-d", "out-10",
|
|
"-noqualifier", "pkg",
|
|
"-sourcepath", testSrc,
|
|
"pkg", "deprecated");
|
|
checkExit(Exit.OK);
|
|
|
|
checkOutput("pkg/Foo.html", true,
|
|
"""
|
|
<div class="inheritance">Foo</div>""");
|
|
checkOutput("deprecated/Foo.html", true,
|
|
"""
|
|
<div class="inheritance">deprecated.Foo</div>""");
|
|
|
|
javadoc("-d", "out-10a",
|
|
"-noqualifier", "all",
|
|
"-sourcepath", testSrc,
|
|
"pkg", "deprecated");
|
|
checkExit(Exit.OK);
|
|
|
|
checkOutput("pkg/Foo.html", true,
|
|
"""
|
|
<div class="inheritance">Foo</div>""");
|
|
checkOutput("deprecated/Foo.html", true,
|
|
"""
|
|
<div class="inheritance">Foo</div>""");
|
|
}
|
|
}
|