From ac2fede165e0ecbfa51f5cc75a3218c51e3528be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hannes=20Walln=C3=B6fer?= Date: Mon, 2 Dec 2024 08:39:47 +0000 Subject: [PATCH] 8344041: Re-enable external specs page Reviewed-by: erikj, nbenalla, liach --- make/Docs.gmk | 6 ++--- .../doclets/formats/html/HtmlDoclet.java | 4 +-- .../doclets/formats/html/HtmlOptions.java | 26 +------------------ .../doclet/testSpecTag/TestSpecTag.java | 16 +----------- 4 files changed, 5 insertions(+), 47 deletions(-) diff --git a/make/Docs.gmk b/make/Docs.gmk index e6a98c4fbd2..fb2726e6dad 100644 --- a/make/Docs.gmk +++ b/make/Docs.gmk @@ -107,15 +107,13 @@ JAVA_WARNINGS_ARE_ERRORS ?= -Werror JAVADOC_OPTIONS := -use -keywords -notimestamp \ -encoding ISO-8859-1 -docencoding UTF-8 -breakiterator \ -splitIndex --system none -javafx --expand-requires transitive \ - --override-methods=summary \ - --no-external-specs-page + --override-methods=summary # The reference options must stay stable to allow for comparisons across the # development cycle. REFERENCE_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \ -encoding ISO-8859-1 -breakiterator -splitIndex --system none \ - -html5 -javafx --expand-requires transitive \ - --no-external-specs-page + -html5 -javafx --expand-requires transitive # Should we add DRAFT stamps to the generated javadoc? ifeq ($(VERSION_IS_GA), true) diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java index 193e1f3a129..fefe0ab191c 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java @@ -280,9 +280,7 @@ public class HtmlDoclet extends AbstractDoclet { } if (options.createIndex()) { - if (!options.noExternalSpecsPage()){ - writerFactory.newExternalSpecsWriter().buildPage(); - } + writerFactory.newExternalSpecsWriter().buildPage(); writerFactory.newSearchTagsWriter().buildPage(); writerFactory.newSystemPropertiesWriter().buildPage(); diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlOptions.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlOptions.java index f9d1f6f5dd3..10483fb4a4c 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlOptions.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlOptions.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1998, 2023, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1998, 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 @@ -144,13 +144,6 @@ public class HtmlOptions extends BaseOptions { */ private boolean noDeprecatedList = false; - /** - * Argument for command-line option {@code --no-external-spec-page}. - * True if command-line option "--no-external-spec-page" is used. Default value is - * false. - */ - private boolean noExternalSpecsPage = false; - /** * Argument for command-line option {@code -nohelp}. * True if command-line option "-nohelp" is used. Default value is false. @@ -374,14 +367,6 @@ public class HtmlOptions extends BaseOptions { } }, - new Hidden(resources, "--no-external-specs-page") { - @Override - public boolean process(String opt, List args) { - noExternalSpecsPage = true; - return true; - } - }, - new Option(resources, "-notree") { @Override public boolean process(String opt, List args) { @@ -749,15 +734,6 @@ public class HtmlOptions extends BaseOptions { return noDeprecatedList; } - /** - * Argument for command-line option {@code --no-external-specs-page}. - * True if command-line option "--no-external-specs-page" is used. Default value is - * false. - */ - public boolean noExternalSpecsPage() { - return noExternalSpecsPage; - } - /** * Argument for command-line option {@code -nohelp}. * True if command-line option "-nohelp" is used. Default value is false. diff --git a/test/langtools/jdk/javadoc/doclet/testSpecTag/TestSpecTag.java b/test/langtools/jdk/javadoc/doclet/testSpecTag/TestSpecTag.java index 265dfcb8600..cd92bbe0364 100644 --- a/test/langtools/jdk/javadoc/doclet/testSpecTag/TestSpecTag.java +++ b/test/langtools/jdk/javadoc/doclet/testSpecTag/TestSpecTag.java @@ -23,7 +23,7 @@ /* * @test - * @bug 6251738 8226279 8297802 8296546 8305407 + * @bug 6251738 8226279 8297802 8305407 * @summary JDK-8226279 javadoc should support a new at-spec tag * @library /tools/lib ../../lib * @modules jdk.javadoc/jdk.javadoc.internal.tool @@ -511,20 +511,6 @@ public class TestSpecTag extends JavadocTester { .replace("#FILE#", src.resolve("p").resolve("C.java").toString())); } - @Test - public void testSuppressSpecPage(Path base) throws IOException { - Path src = base.resolve("src"); - tb.writeJavaFiles(src, "package p; /** @spec http://example.com label */ public class C { }"); - - javadoc("-d", base.resolve("out").toString(), - "--source-path", src.toString(), - "--no-external-specs-page", - "p"); - checkExit(Exit.OK); - - checkFiles(false, "external-specs.html"); - } - @Test public void testCombo(Path base) throws IOException { for (LinkKind lk : LinkKind.values()) {