8196202: Javadoc should not generate frames by default

Reviewed-by: ksrini
This commit is contained in:
Jonathan Gibbons 2018-05-29 11:20:04 -07:00
parent b721c804c5
commit 8589446792
41 changed files with 176 additions and 62 deletions
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html
test/langtools
jdk/javadoc
doclet
AccessFrameTitle
AccessH1
AccessSummary
DocRootSlash
JavascriptWinTitle
MetaTag
PackagesHeader
ValidHtml
WindowTitles
testClassDocCatalog
testFramesNoFrames
testGeneratedBy
testGroupName
testGroupOption
testHeadings
testHiddenTag
testHtmlTableStyles
testHtmlTableTags
testHtmlVersion
testIndex
testJavascript
testModuleDirs
testModules
testNavigation
testNewLanguageFeatures
testOrdering
testOverview
testPackageDeprecation
testRecurseSubPackages
testRelativeLinks
testSearch
testSummaryTag
testTopOption
testUseOption
testWindowTitle
tool
tools/javadoc/api/basic

@ -198,9 +198,9 @@ public class HtmlConfiguration extends BaseConfiguration {
/**
* Specifies whether or not frames should be generated.
* Defaults to true; can be set by --frames; can be set to false by --no-frames; last one wins.
* Defaults to false; can be set to true by --frames; can be set to false by --no-frames; last one wins.
*/
public boolean frames = true;
public boolean frames = false;
/**
* This is the HTML version of the generated pages.
@ -740,6 +740,7 @@ public class HtmlConfiguration extends BaseConfiguration {
new Option(resources, "--frames") {
@Override
public boolean process(String opt, List<String> args) {
reporter.print(WARNING, getText("doclet.Frames_specified", helpfile));
frames = true;
return true;
}

@ -403,10 +403,10 @@ doclet.usage.docencoding.description=\
Specify the character encoding for the output
doclet.usage.frames.description=\
Enable the use of frames in the generated output (default)
Enable the use of frames in the generated output
doclet.usage.no-frames.description=\
Disable the use of frames in the generated output
Disable the use of frames in the generated output (default)
doclet.usage.override-methods.parameters=\
(detail|summary)
@ -450,3 +450,10 @@ doclet.HTML_4_specified=\
The default is currently HTML5 and the support for HTML 4.01 will be removed\n\
in a future release. To suppress this warning, please ensure that any HTML constructs\n\
in your comments are valid in HTML5, and remove the -html4 option.
# L10N: do not localize the option names --frames
doclet.Frames_specified=\
You have specified to generate frames, by using the --frames option.\n\
The default is currently to not generate frames and the support for \n\
frames will be removed in a future release.\n\
To suppress this warning, remove the --frames option and avoid the use of frames.

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4636655
* @bug 4636655 8196202
* @summary Add title attribute to <FRAME> tags for accessibility
* @author dkramer
* @library ../lib
@ -42,6 +42,7 @@ public class AccessFrameTitle extends JavadocTester {
@Test
void test() {
javadoc("-d", "out",
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4636667 7052425 8016549
* @bug 4636667 7052425 8016549 8196202
* @summary Use <H1, <H2>, and <H3> in proper sequence for accessibility
* @author dkramer
* @library ../lib
@ -44,6 +44,7 @@ public class AccessH1 extends JavadocTester {
void test() {
javadoc("-d", "out",
"-doctitle", "Document Title",
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 4637604 4775148 8183037 8182765
* @bug 4637604 4775148 8183037 8182765 8196202
* @summary Test the tables for summary attribute
* @author dkramer
* @library ../lib
@ -45,7 +45,10 @@ public class AccessSummary extends JavadocTester {
@Test
void testAccessSummary() {
javadoc("-d", "out", "-sourcepath", testSrc, "p1", "p2");
javadoc("-d", "out",
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);
checkSummary(false);
}
@ -54,6 +57,7 @@ public class AccessSummary extends JavadocTester {
void testAccessSummary_html4() {
javadoc("-d", "out-html4",
"-html4",
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 4524350 4662945 4633447
* @bug 4524350 4662945 4633447 8196202
* @summary stddoclet: {@docRoot} inserts an extra trailing "/"
* @author dkramer
* @library ../lib
@ -56,6 +56,7 @@ public class DocRootSlash extends JavadocTester {
javadoc("-d", "out",
"-Xdoclint:none",
"-overview", (srcdir + "/overview.html"),
"--frames",
"-header", "<A HREF=\"{@docroot}/package-list\">{&#064;docroot}</A> <A HREF=\"{@docRoot}/help-doc\">{&#064;docRoot}</A>",
"-sourcepath", srcdir,
"p1", "p2");

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4645058 4747738 4855054 8024756 8141492
* @bug 4645058 4747738 4855054 8024756 8141492 8196202
* @summary Javascript IE load error when linked by -linkoffline
* Window title shouldn't change when loading left frames (javascript)
* @author dkramer
@ -43,6 +43,7 @@ public class JavascriptWinTitle extends JavadocTester {
@Test
void test() {
javadoc("-d", "out",
"--frames",
"-doctitle", "Document Title",
"-windowtitle", "Window Title",
"-overview", testSrc("overview.html"),

@ -23,7 +23,7 @@
/*
* @test
* @bug 4034096 4764726 6235799 8182765
* @bug 4034096 4764726 6235799 8182765 8196202
* @summary Add support for HTML keywords via META tag for
* class and member names to improve API search
* @author dkramer
@ -53,6 +53,7 @@ public class MetaTag extends JavadocTester {
javadoc("-d", "out-1",
"-sourcepath", testSrc,
"-keywords",
"--frames",
"-doctitle", "Sample Packages",
"p1", "p2");
@ -66,6 +67,7 @@ public class MetaTag extends JavadocTester {
javadoc("-d", "out-2",
"-sourcepath", testSrc,
"-notimestamp",
"--frames",
"-doctitle", "Sample Packages",
"p1", "p2");
checkExit(Exit.OK);
@ -80,6 +82,7 @@ public class MetaTag extends JavadocTester {
"-html4",
"-sourcepath", testSrc,
"-keywords",
"--frames",
"-doctitle", "Sample Packages",
"p1", "p2");
@ -94,6 +97,7 @@ public class MetaTag extends JavadocTester {
"-html4",
"-sourcepath", testSrc,
"-notimestamp",
"--frames",
"-doctitle", "Sample Packages",
"p1", "p2");
checkExit(Exit.OK);

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4766385
* @bug 4766385 8196202
* @summary Test that the header option for upper left frame
* is present for three sets of options: (1) -header,
* (2) -packagesheader, and (3) -header -packagesheader
@ -46,6 +46,7 @@ public class PackagesHeader extends JavadocTester {
// First test with -header only
javadoc("-d", "out-header",
"-header", "Main Frame Header",
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);
@ -60,6 +61,7 @@ public class PackagesHeader extends JavadocTester {
// Second test with -packagesheader only
javadoc("-d", "out-packages-header",
"-packagesheader", "Packages Frame Header",
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);
@ -76,6 +78,7 @@ public class PackagesHeader extends JavadocTester {
javadoc("-d", "out-both",
"-packagesheader", "Packages Frame Header",
"-header", "Main Frame Header",
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 4275630 4749453 4625400 4753048 4415270 8074521 8182765
* @bug 4275630 4749453 4625400 4753048 4415270 8074521 8182765 8196202
* @summary Generated HTML is invalid with frames.
* Displays unnecessary horizontal scroll bars.
* Missing whitespace in DOCTYPE declaration
@ -49,6 +49,7 @@ public class ValidHtml extends JavadocTester {
"-doctitle", "Document Title",
"-windowtitle", "Window Title",
"-use",
"--frames",
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"p1", "p2");
@ -72,6 +73,7 @@ public class ValidHtml extends JavadocTester {
"-doctitle", "Document Title",
"-windowtitle", "Window Title",
"-use",
"--frames",
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"p1", "p2");

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4530730
* @bug 4530730 8196202
* @summary stddoclet: With frames off, window titles have "()" appended
* @author dkramer
* @library ../lib
@ -47,6 +47,7 @@ public class WindowTitles extends JavadocTester {
// Test for all cases except the split index page
javadoc("-d", "out-1",
"-use",
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);

@ -1,5 +1,5 @@
/*
* Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2016, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 8071982
* @bug 8071982 8196202
* @summary Test for package-frame.html.
* @library ../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
@ -41,6 +41,7 @@ public class TestClassDocCatalog extends JavadocTester {
@Test
void test() {
javadoc("-d", "out",
"--frames",
testSrc("pkg1/EmptyAnnotation.java"),
testSrc("pkg1/EmptyClass.java"),
testSrc("pkg1/EmptyEnum.java"),

@ -23,7 +23,7 @@
/*
* @test
* @bug 8162353 8164747 8173707
* @bug 8162353 8164747 8173707 8196202
* @summary javadoc should provide a way to disable use of frames
* @library /tools/lib ../lib
* @modules
@ -226,6 +226,11 @@ public class TestFramesNoFrames extends JavadocTester {
private boolean frames;
private boolean overview;
private static final String framesWarning
= "javadoc: warning - You have specified to generate frames, by using the --frames option.\n"
+ "The default is currently to not generate frames and the support for \n"
+ "frames will be removed in a future release.\n"
+ "To suppress this warning, remove the --frames option and avoid the use of frames.";
Checker(FrameKind fKind, OverviewKind oKind, HtmlKind hKind) {
this.fKind = fKind;
@ -240,11 +245,11 @@ public class TestFramesNoFrames extends JavadocTester {
void check() throws IOException {
switch (fKind) {
case DEFAULT:
case FRAMES:
frames = true;
break;
case DEFAULT:
case NO_FRAMES:
frames = false;
break;
@ -272,6 +277,8 @@ public class TestFramesNoFrames extends JavadocTester {
checkNavBar();
checkHelpDoc();
checkWarning();
}
private void checkAllClassesFiles() {
@ -379,6 +386,10 @@ public class TestFramesNoFrames extends JavadocTester {
"overview-summary.html");
}
private void checkWarning() {
checkOutput(Output.OUT, frames, framesWarning);
}
private long getPackageCount() {
return this.classes.stream()
.filter(name -> name.contains("."))

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 8000418 8024288
* @bug 8000418 8024288 8196202
* @summary Verify that files use a common Generated By string
* @library ../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
@ -41,6 +41,7 @@ public class TestGeneratedBy extends JavadocTester {
@Test
void testTimestamp() {
javadoc("-d", "out-timestamp",
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
@ -52,6 +53,7 @@ public class TestGeneratedBy extends JavadocTester {
void testNoTimestamp() {
javadoc("-d", "out-notimestamp",
"-notimestamp",
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 8190003 8196201
* @bug 8190003 8196201 8196202
* @summary Special characters in group names should be escaped
* @library /tools/lib ../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
@ -58,6 +58,7 @@ public class TestGroupName extends JavadocTester {
"package p3; public class C3 { }");
javadoc("-d", base.resolve("out").toString(),
"--frames",
"-sourcepath", src.toString(),
"-group", "abc < & > def", "p1",
"p1", "p2", "p3");
@ -90,6 +91,7 @@ public class TestGroupName extends JavadocTester {
"package pc3; public class CC3 { }");
javadoc("-d", base.resolve("out").toString(),
"--frames",
"--module-source-path", src.toString(),
"-group", "abc < & > def", "ma",
"--module", "ma,mb,mc");

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4924383 8149402
* @bug 4924383 8149402 8196202
* @summary Test to make sure the -group option works correctly
* with the given pattern usages.
* @author jamieh
@ -60,6 +60,7 @@ public class TestGroupOption extends JavadocTester {
// Make sure that the headers of group that is defined using patterns are printed.
void test2() {
javadoc("-d", "out-2",
"--frames",
"-sourcepath", testSrc,
"-group", "Group pkg*", "pkg*",
"-group", "Group abc*", "abc*",

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4905786 6259611 8162363
* @bug 4905786 6259611 8162363 8196202
* @summary Make sure that headings use the TH tag instead of the TD tag.
* @author jamieh
* @library ../lib
@ -62,6 +62,7 @@ public class TestHeadings extends JavadocTester {
javadoc("-d", "out",
"-sourcepath", testSrc,
"-use",
"--frames",
"-header", "Test Files",
"pkg1", "pkg2");
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 8073100 8182765
* @bug 8073100 8182765 8196202
* @summary ensure the hidden tag works as intended
* @library ../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
@ -44,6 +44,7 @@ public class TestHiddenTag extends JavadocTester {
@Test
public void test1() {
javadoc("-d", "out1",
"--frames",
"-sourcepath", testSrc,
"-package",
"pkg1");

@ -23,7 +23,7 @@
/*
* @test
* @bug 8008164 8169819 8183037 8182765
* @bug 8008164 8169819 8183037 8182765 8196202
* @summary Test styles on HTML tables generated by javadoc.
* @author Bhavesh Patel
* @library ../lib
@ -44,6 +44,7 @@ public class TestHtmlTableStyles extends JavadocTester {
javadoc("-d", "out",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg1", "pkg2");
checkExit(Exit.ERROR);
checkOutput(Output.OUT, true,
@ -81,6 +82,7 @@ public class TestHtmlTableStyles extends JavadocTester {
"-html4",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg1", "pkg2");
checkExit(Exit.OK);

@ -50,6 +50,7 @@ public class TestHtmlTableTags extends JavadocTester {
javadoc("-d", "out",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg1", "pkg2");
checkExit(Exit.OK);
@ -64,6 +65,7 @@ public class TestHtmlTableTags extends JavadocTester {
"-html4",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg1", "pkg2");
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 8072945 8081854 8141492 8148985 8150188 4649116 8173707 8151743 8169819 8183037 8182765
* @bug 8072945 8081854 8141492 8148985 8150188 4649116 8173707 8151743 8169819 8183037 8182765 8196202
* @summary Test the version of HTML generated by the javadoc tool.
* @author bpatel
* @library ../lib
@ -45,6 +45,7 @@ public class TestHtmlVersion extends JavadocTester {
javadoc("-d", "out-1",
"-private",
"-linksource",
"--frames",
"-sourcepath", testSrc,
"-use",
"pkg", "pkg1", "pkg2", "pkg3");
@ -62,6 +63,7 @@ public class TestHtmlVersion extends JavadocTester {
"-html4",
"-private",
"-linksource",
"--frames",
"-sourcepath", testSrc,
"-use",
"pkg", "pkg1", "pkg2", "pkg3");
@ -79,6 +81,7 @@ public class TestHtmlVersion extends JavadocTester {
"-html4",
"-private",
"-linksource",
"--frames",
"-sourcepath", testSrc,
"-use",
"pkg", "pkg1", "pkg2", "pkg3");

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4852280 4517115 4973608 4994589 8026567 8071982
* @bug 4852280 4517115 4973608 4994589 8026567 8071982 8196202
* @summary Perform tests on index.html file.
* Also test that index-all.html has the appropriate output.
* Test for unnamed package in index.
@ -44,6 +44,7 @@ public class TestIndex extends JavadocTester {
@Test
void test() {
javadoc("-d", "out",
"--frames",
"-sourcepath", testSrc,
"pkg", testSrc("NoPackage.java"));
checkExit(Exit.OK);

@ -1,5 +1,5 @@
/*
* Copyright (c) 2004, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2004, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4665566 4855876 7025314 8012375 8015997 8016328 8024756 8148985 8151921 8151743
* @bug 4665566 4855876 7025314 8012375 8015997 8016328 8024756 8148985 8151921 8151743 8196202
* @summary Verify that the output has the right javascript.
* @author jamieh
* @library ../lib
@ -42,6 +42,7 @@ public class TestJavascript extends JavadocTester {
@Test
void test() {
javadoc("-d", "out",
"--frames",
"-sourcepath", testSrc,
"pkg", testSrc("TestJavascript.java"));
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 8195795 8201396
* @bug 8195795 8201396 8196202
* @summary test the use of module directories in output,
* and the --no-module-directories option
* @modules jdk.javadoc/jdk.javadoc.internal.api
@ -82,6 +82,7 @@ public class TestModuleDirs extends JavadocTester {
javadoc("-d", base.resolve("api").toString(),
"-quiet",
"--frames",
"--module-source-path", src.toString(),
"--no-module-directories",
"--module", "ma,mb");
@ -125,6 +126,7 @@ public class TestModuleDirs extends JavadocTester {
javadoc("-d", base.resolve("api").toString(),
"-quiet",
"--frames",
"--module-source-path", src.toString(),
"--module", "ma,mb");

@ -26,7 +26,7 @@
* @bug 8154119 8154262 8156077 8157987 8154261 8154817 8135291 8155995 8162363
* 8168766 8168688 8162674 8160196 8175799 8174974 8176778 8177562 8175218
* 8175823 8166306 8178043 8181622 8183511 8169819 8074407 8183037 8191464
8164407 8192007 8182765 8196200 8196201
8164407 8192007 8182765 8196200 8196201 8196202
* @summary Test modules support in javadoc.
* @author bpatel
* @library ../lib
@ -51,6 +51,7 @@ public class TestModules extends JavadocTester {
"-use",
"-Xdoclint:none",
"-overview", testSrc("overview.html"),
"--frames",
"--module-source-path", testSrc,
"--module", "moduleA,moduleB",
"testpkgmdlA", "testpkgmdlB");
@ -76,6 +77,7 @@ public class TestModules extends JavadocTester {
"-use",
"-Xdoclint:none",
"-overview", testSrc("overview.html"),
"--frames",
"--module-source-path", testSrc,
"--module", "moduleA,moduleB",
"testpkgmdlA", "testpkgmdlB");
@ -102,6 +104,7 @@ public class TestModules extends JavadocTester {
"-nocomment",
"-use",
"-Xdoclint:none",
"--frames",
"-overview", testSrc("overview.html"),
"--module-source-path", testSrc,
"--module", "moduleA,moduleB",
@ -123,6 +126,7 @@ public class TestModules extends JavadocTester {
"-nocomment",
"-use",
"-Xdoclint:none",
"--frames",
"-overview", testSrc("overview.html"),
"--module-source-path", testSrc,
"--module", "moduleA,moduleB",
@ -143,6 +147,7 @@ public class TestModules extends JavadocTester {
javadoc("-d", "out-nomodule",
"-html4",
"-use",
"--frames",
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"testpkgnomodule", "testpkgnomodule1");
@ -161,6 +166,7 @@ public class TestModules extends JavadocTester {
void testHtml5UnnamedModule() {
javadoc("-d", "out-html5-nomodule",
"-use",
"--frames",
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"testpkgnomodule", "testpkgnomodule1");
@ -264,6 +270,7 @@ public class TestModules extends JavadocTester {
void testModuleFilesAndLinks() {
javadoc("-d", "out-modulelinks",
"-Xdoclint:none",
"--frames",
"--module-source-path", testSrc,
"--module", "moduleA,moduleB",
"testpkgmdlA", "testpkgmdlB");
@ -328,6 +335,7 @@ public class TestModules extends JavadocTester {
"-author",
"-version",
"-Xdoclint:none",
"--frames",
"-tag", "regular:a:Regular Tag:",
"-tag", "moduletag:s:Module Tag:",
"--module-source-path", testSrc,
@ -352,6 +360,7 @@ public class TestModules extends JavadocTester {
"-author",
"-version",
"-Xdoclint:none",
"--frames",
"-tag", "regular:a:Regular Tag:",
"-tag", "moduletag:s:Module Tag:",
"--module-source-path", testSrc,
@ -377,6 +386,7 @@ public class TestModules extends JavadocTester {
"-author",
"-version",
"-Xdoclint:none",
"--frames",
"-tag", "regular:a:Regular Tag:",
"-tag", "moduletag:s:Module Tag:",
"--module-source-path", testSrc,
@ -453,6 +463,7 @@ public class TestModules extends JavadocTester {
@Test
void testSingleModuleSinglePkg() {
javadoc("-d", "out-singlemod",
"--frames",
"--module-source-path", testSrc,
"--module", "moduleC",
"testpkgmdlC");
@ -468,6 +479,7 @@ public class TestModules extends JavadocTester {
javadoc("-d", "out-singlemodmultiplepkg",
"--show-module-contents=all",
"-Xdoclint:none",
"--frames",
"--module-source-path", testSrc,
"--module", "moduleB",
"testpkg2mdlB", "testpkgmdlB");
@ -483,6 +495,7 @@ public class TestModules extends JavadocTester {
javadoc("-d", "out-group",
"--show-module-contents=all",
"-Xdoclint:none",
"--frames",
"-tag", "regular:a:Regular Tag:",
"-tag", "moduletag:s:Module Tag:",
"--module-source-path", testSrc,
@ -505,6 +518,7 @@ public class TestModules extends JavadocTester {
"-html4",
"--show-module-contents=all",
"-Xdoclint:none",
"--frames",
"-tag", "regular:a:Regular Tag:",
"-tag", "moduletag:s:Module Tag:",
"--module-source-path", testSrc,
@ -528,6 +542,7 @@ public class TestModules extends JavadocTester {
javadoc("-d", "out-groupOrder",
"--show-module-contents=all",
"-Xdoclint:none",
"--frames",
"-tag", "regular:a:Regular Tag:",
"-tag", "moduletag:s:Module Tag:",
"--module-source-path", testSrc,
@ -550,6 +565,7 @@ public class TestModules extends JavadocTester {
javadoc("-d", "out-groupnomodule",
"-use",
"-Xdoclint:none",
"--frames",
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"-group", "Package Group 0", "testpkgnomodule",
@ -568,6 +584,7 @@ public class TestModules extends JavadocTester {
"-html4",
"-use",
"-Xdoclint:none",
"--frames",
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"-group", "Package Group 0", "testpkgnomodule",
@ -587,6 +604,7 @@ public class TestModules extends JavadocTester {
javadoc("-d", "out-groupPkgOrder",
"-use",
"-Xdoclint:none",
"--frames",
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"-group", "Z Group", "testpkgnomodule",
@ -604,6 +622,7 @@ public class TestModules extends JavadocTester {
javadoc("-d", "out-groupsinglemodule",
"-use",
"-Xdoclint:none",
"--frames",
"--module-source-path", testSrc,
"-group", "Module Group B", "moduleB*",
"--module", "moduleB",
@ -621,6 +640,7 @@ public class TestModules extends JavadocTester {
"-html4",
"-use",
"-Xdoclint:none",
"--frames",
"--module-source-path", testSrc,
"-group", "Module Group B", "moduleB*",
"--module", "moduleB",
@ -637,6 +657,7 @@ public class TestModules extends JavadocTester {
javadoc("-d", "out-modulename",
"-use",
"-Xdoclint:none",
"--frames",
"--module-source-path", testSrc,
"--module", "moduleB,test.moduleFullName",
"testpkg2mdlB", "testpkgmdlB", "testpkgmdlfullname");

@ -23,7 +23,7 @@
/*
* @test
* @bug 8196027
* @bug 8196027 8196202
* @summary test navigation links
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
@ -74,6 +74,7 @@ public class TestModuleNavigation extends JavadocTester {
javadoc("-d", base.resolve("out").toString(), "-use",
"-quiet",
"--frames",
"--module-source-path", src.toString(),
"--module", "m,m2");
checkExit(Exit.OK);

@ -24,7 +24,7 @@
/*
* @test
* @bug 4131628 4664607 7025314 8023700 7198273 8025633 8026567 8081854 8150188 8151743 8196027 8182765
* 8196200
* 8196200 8196202
* @summary Make sure the Next/Prev Class links iterate through all types.
* Make sure the navagation is 2 columns, not 3.
* @author jamieh
@ -56,6 +56,7 @@ public class TestNavigation extends JavadocTester {
void test(Path ignore) {
javadoc("-d", "out",
"-overview", testSrc("overview.html"),
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
@ -112,6 +113,7 @@ public class TestNavigation extends JavadocTester {
javadoc("-d", "out-html4",
"-html4",
"-overview", testSrc("overview.html"),
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
@ -150,6 +152,7 @@ public class TestNavigation extends JavadocTester {
void test1(Path ignore) {
javadoc("-d", "out-1",
"-html5",
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
@ -182,6 +185,7 @@ public class TestNavigation extends JavadocTester {
void test2(Path ignore) {
javadoc("-d", "out-2",
"-nonavbar",
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
@ -213,6 +217,7 @@ public class TestNavigation extends JavadocTester {
javadoc("-d", "out-3",
"-html5",
"-nonavbar",
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);

@ -24,7 +24,7 @@
/*
* @test
* @bug 4789689 4905985 4927164 4827184 4993906 5004549 7025314 7010344 8025633 8026567 8162363
* 8175200 8186332 8182765
* 8175200 8186332 8182765 8196202
* @summary Run Javadoc on a set of source files that demonstrate new
* language features. Check the output to ensure that the new
* language features are properly documented.
@ -47,6 +47,7 @@ public class TestNewLanguageFeatures extends JavadocTester {
javadoc("-Xdoclint:none",
"-d", "out",
"-use",
"--frames",
"-sourcepath", testSrc,
"pkg", "pkg1", "pkg2");
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 8039410 8042601 8042829 8049393 8050031 8155061 8155995 8167967 8169813 8182765
* @bug 8039410 8042601 8042829 8049393 8050031 8155061 8155995 8167967 8169813 8182765 8196202
* @summary test to determine if members are ordered correctly
* @library ../lib/
* @modules jdk.javadoc/jdk.javadoc.internal.tool
@ -129,6 +129,7 @@ public class TestOrdering extends JavadocTester {
tester.javadoc("-d", "out-1",
"-sourcepath", tester.testSrc,
"-use",
"--frames",
"pkg1");
tester.checkExit(Exit.OK);
@ -383,6 +384,7 @@ public class TestOrdering extends JavadocTester {
List<String> cmdArgs = new ArrayList();
cmdArgs.add("-d");
cmdArgs.add("out-2");
cmdArgs.add("--frames");
cmdArgs.add("-sourcepath");
cmdArgs.add("src");
cmdArgs.add("-package");

@ -23,7 +23,7 @@
/*
* @test
* @bug 8173302 8182765
* @bug 8173302 8182765 8196202
* @summary make sure the overview-summary and module-summary pages don't
* don't have the See link, and the overview is copied correctly.
* @library ../lib
@ -45,6 +45,7 @@ public class TestOverview extends JavadocTester {
"-doctitle", "Document Title",
"-windowtitle", "Window Title",
"-overview", testSrc("overview.html"),
"--frames",
"-sourcepath", testSrc("src"),
"p1", "p2");
checkExit(Exit.OK);
@ -58,6 +59,7 @@ public class TestOverview extends JavadocTester {
"-doctitle", "Document Title",
"-windowtitle", "Window Title",
"-overview", testSrc("overview.html"),
"--frames",
"-sourcepath", testSrc("src"),
"p1", "p2");
checkExit(Exit.OK);
@ -70,6 +72,7 @@ public class TestOverview extends JavadocTester {
"-doctitle", "Document Title",
"-windowtitle", "Window Title",
"-overview", testSrc("overview.html"),
"--frames",
"-sourcepath", testSrc("msrc"),
"p1", "p2");
checkExit(Exit.OK);
@ -83,6 +86,7 @@ public class TestOverview extends JavadocTester {
"-doctitle", "Document Title",
"-windowtitle", "Window Title",
"-overview", testSrc("overview.html"),
"--frames",
"-sourcepath", testSrc("msrc"),
"p1", "p2");
checkExit(Exit.OK);

@ -23,7 +23,7 @@
/*
* @test
* @bug 6492694 8026567 8048351 8162363 8183511 8169819 8074407
* @bug 6492694 8026567 8048351 8162363 8183511 8169819 8074407 8196202
* @summary Test package deprecation.
* @author bpatel
* @library ../lib/
@ -45,6 +45,7 @@ public class TestPackageDeprecation extends JavadocTester {
javadoc("-d", "out-default",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", testSrc("C2.java"), testSrc("FooDepr.java"));
checkExit(Exit.OK);
@ -64,6 +65,7 @@ public class TestPackageDeprecation extends JavadocTester {
"-sourcepath", testSrc,
"-use",
"-nodeprecated",
"--frames",
"pkg", "pkg1", testSrc("C2.java"), testSrc("FooDepr.java"));
checkExit(Exit.OK);

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4074234
* @bug 4074234 8196202
* @summary Make Javadoc capable of traversing/recursing all of given subpackages.
* @author jamieh
* @library ../lib
@ -42,6 +42,7 @@ public class TestRecurseSubPackages extends JavadocTester {
@Test
void test() {
javadoc("-d", "out",
"--frames",
"-sourcepath", testSrc,
"-subpackages", "pkg1",
"-exclude", "pkg1.pkg2.packageToExclude");

@ -23,7 +23,7 @@
/*
* @test
* @bug 4460354 8014636 8043186 8195805 8182765
* @bug 4460354 8014636 8043186 8195805 8182765 8196202
* @summary Test to make sure that relative paths are redirected in the
* output so that they are not broken.
* @author jamieh
@ -44,6 +44,7 @@ public class TestRelativeLinks extends JavadocTester {
void test() {
javadoc("-d", "out",
"-use",
"--frames",
"-sourcepath", testSrc,
"pkg", "pkg2");
checkExit(Exit.ERROR);

@ -24,7 +24,7 @@
/*
* @test
* @bug 8141492 8071982 8141636 8147890 8166175 8168965 8176794 8175218 8147881
* 8181622 8182263 8074407 8187521 8198522 8182765 8199278 8196201
* 8181622 8182263 8074407 8187521 8198522 8182765 8199278 8196201 8196202
* @summary Test the search feature of javadoc.
* @author bpatel
* @library ../lib
@ -67,6 +67,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.OK);
checkInvalidUsageIndexTag();
@ -105,6 +106,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:all",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.ERROR);
checkDocLintErrors();
@ -142,6 +144,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.OK);
checkSearchOutput(false);
@ -167,6 +170,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.OK);
checkSearchOutput(true);
@ -193,6 +197,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.OK);
checkSearchOutput(false);
@ -216,6 +221,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.OK);
checkSearchOutput(true);
@ -241,6 +247,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
setAutomaticCheckLinks(true); // @ignore JDK-8202627
checkExit(Exit.OK);
@ -266,6 +273,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.OK);
checkInvalidUsageIndexTag();
@ -293,6 +301,7 @@ public class TestSearch extends JavadocTester {
"--disable-javafx-strict-checks",
"-package",
"-use",
"--frames",
"pkgfx", "pkg3");
checkExit(Exit.OK);
checkSearchOutput(true);
@ -318,6 +327,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.OK);
checkSearchOutput(true, false);
@ -345,6 +355,7 @@ public class TestSearch extends JavadocTester {
"-Xdoclint:none",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
checkExit(Exit.OK);
checkSearchJS();

@ -25,7 +25,7 @@
/*
* @test
* @bug 8173425 8186332 8182765
* @bug 8173425 8186332 8182765 8196202
* @summary tests for the summary tag behavior
* @library ../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
@ -157,6 +157,7 @@ public class TestSummaryTag extends JavadocTester {
@Test
void test3() {
javadoc("-d", "out3",
"--frames",
"-sourcepath", testSrc,
"-overview", testSrc("p3/overview.html"),
"p3");

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 6227616 8043186
* @bug 6227616 8043186 8196202
* @summary Test the new -top option.
* @author jamieh
* @library ../lib
@ -45,6 +45,7 @@ public class TestTopOption extends JavadocTester {
"-use",
"-top", "TOP TEXT",
"-d", "out-1",
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
@ -68,6 +69,7 @@ public class TestTopOption extends JavadocTester {
"-use",
"-top", "\u0130{@docroot}TOP TEXT",
"-d", "out-2",
"--frames",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);

@ -24,7 +24,7 @@
/*
* @test
* @bug 4496290 4985072 7006178 7068595 8016328 8050031 8048351 8081854 8071982 8162363 8175200 8186332
* 8182765
* 8182765 8196202
* @summary A simple test to ensure class-use files are correct.
* @author jamieh
* @library ../lib
@ -46,6 +46,7 @@ public class TestUseOption extends JavadocTester {
javadoc("-d", "out-1",
"-sourcepath", testSrc,
"-use",
"--frames",
"pkg1", "pkg2");
checkExit(Exit.OK);

@ -1,5 +1,5 @@
/*
* Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2013, 2018, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 8016675 8026736
* @bug 8016675 8026736 8196202
* @summary Test for window title.
* @author Bhavesh Patel
* @library ../lib
@ -48,6 +48,7 @@ public class TestWindowTitle extends JavadocTester {
javadoc("-d", "out-js-chars",
"-windowtitle", title,
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);
@ -72,6 +73,7 @@ public class TestWindowTitle extends JavadocTester {
javadoc("-d", "out-script",
"-windowtitle", title,
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);
@ -105,6 +107,7 @@ public class TestWindowTitle extends JavadocTester {
javadoc("-d", "out-html-tags",
"-windowtitle", title,
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);
@ -128,6 +131,7 @@ public class TestWindowTitle extends JavadocTester {
javadoc("-d", "out-html-entities",
"-windowtitle", title,
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
@ -148,6 +152,7 @@ public class TestWindowTitle extends JavadocTester {
javadoc("-d", "out-empty-tags",
"-windowtitle", title,
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
@ -167,6 +172,7 @@ public class TestWindowTitle extends JavadocTester {
javadoc("-d", "out-unicode",
"-windowtitle", title,
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);
@ -188,6 +194,7 @@ public class TestWindowTitle extends JavadocTester {
String title = "";
javadoc("-d", "out-empty",
"-windowtitle", title,
"--frames",
"-sourcepath", testSrc, "p1", "p2");
checkExit(Exit.OK);
@ -205,6 +212,7 @@ public class TestWindowTitle extends JavadocTester {
javadoc("-d", "out-doctitle",
"-doctitle", title,
"--frames",
"-sourcepath", testSrc,
"p1", "p2");
checkExit(Exit.OK);

@ -1,5 +1,5 @@
/*
* Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2016, 2018, 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
@ -242,6 +242,7 @@ public class TestScriptInComment {
opts.add(srcDir.getPath());
opts.add("-d");
opts.add(outDir.getPath());
opts.add("--frames");
if (option.text != null)
opts.add(option.text);
for (String opt: template.getOpts(srcDir)) {

@ -190,9 +190,8 @@ class APITest {
* Standard files generated by processing a documented class pkg.C.
*/
protected static Set<String> standardExpectFiles = new HashSet<>(Arrays.asList(
"allclasses-frame.html",
"allclasses.html",
"allclasses-index.html",
"allclasses-noframe.html",
"allpackages-index.html",
"constant-values.html",
"deprecated-list.html",
@ -233,7 +232,6 @@ class APITest {
"package-search-index.js",
"package-search-index.zip",
"pkg/C.html",
"pkg/package-frame.html",
"pkg/package-summary.html",
"pkg/package-tree.html",
"resources/glass.png",

@ -190,9 +190,8 @@ class APITest {
* Standard files generated by processing a documented class pkg.C.
*/
protected static Set<String> standardExpectFiles = new HashSet<>(Arrays.asList(
"allclasses-frame.html",
"allclasses.html",
"allclasses-index.html",
"allclasses-noframe.html",
"allpackages-index.html",
"constant-values.html",
"deprecated-list.html",
@ -233,7 +232,6 @@ class APITest {
"package-search-index.js",
"package-search-index.zip",
"pkg/C.html",
"pkg/package-frame.html",
"pkg/package-summary.html",
"pkg/package-tree.html",
"resources/glass.png",