/* * Copyright (c) 2013, 2019, 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 * @summary Test the output for -header, -footer, -nooverview, -nodeprecatedlist, -nonavbar, -notree, * -stylesheetfile, --main-stylesheet, --add-stylesheet 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 { TestOptions tester = new TestOptions(); tester.runTests(); } @Test public void testHeaderFooter() { javadoc("-d", "out-1", "-header", "Test header", "-footer", "Test footer", "-sourcepath", testSrc, "pkg"); checkExit(Exit.OK); checkOutput("pkg/package-summary.html", true, "
Test header
", "
Test footer
"); } @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, "
  • Tree
    • "); } @Test public void testStylesheetFile() { javadoc("-d", "out-8", "-stylesheetfile", new File(testSrc, "custom-stylesheet.css").getAbsolutePath(), "-sourcepath", testSrc, "pkg"); checkExit(Exit.OK); checkOutput("custom-stylesheet.css", true, "Custom javadoc style sheet"); checkOutput("pkg/Foo.html", true, ""); } @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("custom-stylesheet.css", true, "Custom javadoc style sheet"); checkOutput("pkg/Foo.html", true, ""); } @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("additional-stylesheet-1.css", true, "Additional javadoc style sheet 1"); checkOutput("additional-stylesheet-2.css", true, "Additional javadoc style sheet 2"); checkOutput("additional-stylesheet-3.css", true, "Additional javadoc style sheet 3"); checkOutput("pkg/Foo.html", true, "\n" + "\n" + ""); } @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, "javadoc: 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, "javadoc: error - File not found:", "additional-stylesheet-4.css"); } @Test public void testLinkSource() { javadoc("-d", "out-9", "-linksource", "-javafx", "--disable-javafx-strict-checks", "-sourcepath", testSrc, "-package", "linksource"); checkExit(Exit.OK); checkLinks(); checkOutput("linksource/AnnotationTypeField.html", true, "
    @Documented\npublic @interface "
                + "AnnotationTypeField
    ", "
    \n" + "

    DEFAULT_NAME

    \n" + "
    static final " + "java.lang.String " + "DEFAULT_NAME
    ", "
    \n" + "

    name

    \n" + "
    java.lang.String " + "" + "name
    "); checkOutput("src-html/linksource/AnnotationTypeField.html", true, "Source code", "031" + "@Documented public @interface AnnotationTypeField {"); checkOutput("linksource/Properties.html", true, "
    public class "
                + "Properties",
                "
    public "
                + "java.lang.Object "
                + "someProperty
    ");

        checkOutput("src-html/linksource/Properties.html", true,
                "Source code",
                "031    "
                + "public Object someProperty() {");

        checkOutput("linksource/SomeClass.html", true,
                "
    public class "
                + "SomeClass\nextends java.lang.Object
    ",
                "
    public "
                + "int "
                + "field
    ",
                "
    public "
                + ""
                + "SomeClass()
    ",
                "
    public "
                + "int "
                + "method()
    ");

        checkOutput("src-html/linksource/SomeClass.html", true,
                "Source code",
                "029"
                + "public class SomeClass {",
                "031    "
                + "public int field;",
                "033    "
                + "public SomeClass() {",
                "036    "
                + "public int method() {");

        checkOutput("linksource/SomeEnum.html", true,
                "
    public static final "
                + ""
                + "SomeEnum "
                + "VALUE1
    ",
                "
    public static final "
                + ""
                + "SomeEnum "
                + "VALUE2
    ");

        checkOutput("src-html/linksource/SomeEnum.html", true,
                "029    VALUE1,",
                "030    VALUE2");
    }

    @Test
    public void testNoQualifier() {
        javadoc("-d", "out-10",
                "-noqualifier", "pkg",
                "-sourcepath", testSrc,
                "pkg", "deprecated");
        checkExit(Exit.OK);

        checkOutput("pkg/Foo.html", true,
                "
    Foo
    ");
        checkOutput("deprecated/Foo.html", true,
                "
    deprecated.Foo
    ");

        javadoc("-d", "out-10a",
                "-noqualifier", "all",
                "-sourcepath", testSrc,
                "pkg", "deprecated");
        checkExit(Exit.OK);

        checkOutput("pkg/Foo.html", true,
                "
    Foo
    ");
        checkOutput("deprecated/Foo.html", true,
                "
    Foo
    ");
    }
}