diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java index 5f80b8eef99..102b68b2018 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java @@ -686,7 +686,7 @@ public abstract class AbstractMemberWriter implements MemberSummaryWriter { parameters.add(")"); htmltree.add(Entity.ZERO_WIDTH_SPACE); htmltree.add("("); - htmltree.add(HtmlTree.SPAN(HtmlStyle.arguments, parameters)); + htmltree.add(HtmlTree.SPAN(HtmlStyle.parameters, parameters)); } // Exceptions diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java index 765bae24a1b..f81438cf5b9 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java @@ -48,8 +48,6 @@ public enum HtmlStyle { aboutLanguage, activeTableTab, altColor, - annotations, - arguments, block, blockList, bottomNav, @@ -68,18 +66,13 @@ public enum HtmlStyle { deprecatedSummary, deprecationBlock, deprecationComment, - description, descfrmTypeLabel, details, detail, emphasizedPhrase, - exceptions, externalLink, fieldDetails, fieldSummary, - flexBox, - flexHeader, - flexContent, header, helpSection, hierarchy, @@ -91,28 +84,21 @@ public enum HtmlStyle { interfaceName, legalCopy, memberDetails, - memberName, memberNameLabel, memberNameLink, - memberSignature, memberSummary, methodDetails, methodSummary, - modifiers, - moduleDescription, moduleLabelInPackage, moduleLabelInType, - moduleTags, modulesSummary, nameValue, navBarCell1Rev, navList, navListSearch, nestedClassSummary, - notes, overviewSummary, packages, - packageDescription, packageHierarchyLabel, packageLabelInType, packagesSummary, @@ -121,7 +107,6 @@ public enum HtmlStyle { propertySummary, providesSummary, requiresSummary, - returnType, rowColor, searchTagLink, searchTagResult, @@ -142,13 +127,133 @@ public enum HtmlStyle { topNav, typeNameLabel, typeNameLink, - typeParameters, - typeParametersLong, typeSummary, useSummary, usesSummary, verticalSeparator, + // + // The following constants are used for the components used to present the content + // generated from documentation comments. + + /** + * The class of the element used to present the documentation comment for a type or member + * element. + * The content of the block tags will be in a nested element with class {@link #notes}. + */ + description, + + /** + * The class of the element used to present the documentation comment for a module element, + * excluding block tags. + * The content of the block tags will be in a sibling element with class {@link #moduleTags}. + */ + moduleDescription, + + /** + * The class of the {@code dl} element used to present the block tags in the documentation + * comment for a module element. + * Additional (derived) information, such as implementation or inheritance details, may + * also appear in this element. + */ + moduleTags, + + /** + * The class of the element used to present the documentation comment for package element. + * The content of the block tags will be in a nested element with class {@link #notes}. + */ + packageDescription, + + /** + * The class of the {@code dl} element used to present the block tags in the documentation + * comment for a package, type or member element. + * Additional (derived) information, such as implementation or inheritance details, may + * also appear in this element. + */ + notes, + // + + // + // The following constants are used for the components of the top-level structures for "flex" layout. + + /** + * The class of the top-level {@code div} element used to arrange for "flex" layout in + * a browser window. The element should contain two child elements: one with class + * {@link #flexHeader flex-header} and one with class {@link #flexContent flex-content}. + */ + flexBox, + + /** + * The class of the {@code header} element within a {@link #flexBox flex-box} container. + * The element is always displayed at the top of the viewport. + */ + flexHeader, + + /** + * The class of the {@code div} element within a {@link #flexBox flex-box} container + * This element appears below the header and can be scrolled if too big for the available height. + */ + flexContent, + // + + // + // The following constants are used for the components of a signature of an element + + /** + * The class of a {@code span} element for the signature of an element. + * The signature will contain a member name and, depending on the kind of element, + * it can contain any of the following: + * annotations, type parameters, modifiers, return type, parameters, and exceptions. + */ + memberSignature, + + /** + * The class of a {@code span} element for any annotations in the signature of an element. + */ + annotations, + + /** + * The class of a {@code span} element for any exceptions in a signature of an executable element. + */ + exceptions, + + /** + * The class of a {@code span} for the member name in the signature of an element. + */ + memberName, + + /** + * The class of a {@code span} for any modifiers in the signature of an element. + */ + modifiers, + + /** + * The class of a {@code span} for any parameters in the signature of an executable element. + */ + parameters, + + /** + * The class of a {@code span} for the return type in the signature of an method element. + */ + returnType, + + /** + * The class of a {@code span} for type parameters in the signature of an element, + * used when the type parameters should reasonably be displayed inline. + */ + typeParameters, + + /** + * The class of a {@code span} for type parameters in the signature of an element, + * used when the type parameters are too long to be displayed inline. + * @implNote + * The threshold for choosing between {@code typeParameters} and {@code typeParametersLong} + * is 50 characters. + */ + typeParametersLong, + // + + // // The following constants are used for the class of the {@code } element // for the corresponding pages. @@ -256,6 +361,7 @@ public enum HtmlStyle { * The class of the {@code body} element for the page for the class hierarchy. */ treePage; + // private final String cssName; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/stylesheet.css b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/stylesheet.css index d053e66fbf6..90f3b60dd28 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/stylesheet.css +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/stylesheet.css @@ -531,7 +531,7 @@ div.member-signature span.annotations { white-space: pre-wrap; } div.member-signature span.type-parameters-long, -div.member-signature span.arguments, +div.member-signature span.parameters, div.member-signature span.exceptions { display: inline-block; vertical-align: top; diff --git a/test/langtools/jdk/javadoc/doclet/testIndentation/TestIndentation.java b/test/langtools/jdk/javadoc/doclet/testIndentation/TestIndentation.java index cff2245ec5d..b1109ed0d2c 100644 --- a/test/langtools/jdk/javadoc/doclet/testIndentation/TestIndentation.java +++ b/test/langtools/jdk/javadoc/doclet/testIndentation/TestIndentation.java @@ -51,7 +51,7 @@ public class TestIndentation extends JavadocTester { "
public " + "<T> " + "void m" - + "​(T t1,\n" + + "​(T t1,\n" + "T t2)\n" + " throws java.lang.Exception
"); diff --git a/test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java b/test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java index 3c447d69b9a..9ef7ac8d86a 100644 --- a/test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java +++ b/test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java @@ -58,7 +58,7 @@ public class TestJavaFX extends JavadocTester { + "setRate(double)", "
public final " + "void setRate​" - + "(double value)
\n" + + "(double value)\n" + "
Sets the value of the property rate.
\n" + "
\n" + "
Property description:
", @@ -103,7 +103,7 @@ public class TestJavaFX extends JavadocTester { + "

setPaused

\n" + "
public final " + "void setPaused​" - + "(boolean value)
\n" + + "(boolean value)\n" + "
Sets the value of the property paused.
\n" + "
\n" + "
Property description:
\n" @@ -132,7 +132,7 @@ public class TestJavaFX extends JavadocTester { + "

setRate

\n" + "
public final " + "void setRate​" - + "(double value)
\n" + + "(double value)\n" + "
Sets the value of the property rate.
\n" + "
\n" + "
Property description:
\n" diff --git a/test/langtools/jdk/javadoc/doclet/testMemberInheritance/TestMemberInheritance.java b/test/langtools/jdk/javadoc/doclet/testMemberInheritance/TestMemberInheritance.java index d728a4d9a15..b041ac9b0d7 100644 --- a/test/langtools/jdk/javadoc/doclet/testMemberInheritance/TestMemberInheritance.java +++ b/test/langtools/jdk/javadoc/doclet/testMemberInheritance/TestMemberInheritance.java @@ -125,7 +125,7 @@ public class TestMemberInheritance extends JavadocTester { + "
protected abstract" + " java.lang.String " + "parentMethod​" - + "(java.lang.String t)\n" + + "(java.lang.String t)\n" + " " + "throws java.lang.IllegalArgumentException,\n" + "java.lang.InterruptedException,\n" @@ -158,7 +158,7 @@ public class TestMemberInheritance extends JavadocTester { + "

method

\n" + "
public" + " java.lang.String " - + "method​(" + + "method​(" + "java.lang.String t)
\n" + ""); } diff --git a/test/langtools/jdk/javadoc/doclet/testMethodSignature/TestMethodSignature.java b/test/langtools/jdk/javadoc/doclet/testMethodSignature/TestMethodSignature.java index 9a11c33e2c8..d37745da700 100644 --- a/test/langtools/jdk/javadoc/doclet/testMethodSignature/TestMethodSignature.java +++ b/test/langtools/jdk/javadoc/doclet/testMethodSignature/TestMethodSignature.java @@ -23,7 +23,7 @@ /* * @test - * @bug 8214126 + * @bug 8214126 8241470 * @summary Method signatures not formatted correctly in browser * @library ../../lib/ * @modules jdk.javadoc/jdk.javadoc.internal.tool @@ -55,7 +55,7 @@ public class TestMethodSignature extends JavadocTester { "
public static" + " void " - + "simpleMethod​(int i,\n" + + "simpleMethod​(int i,\n" + "java.lang.String s,\nboolean b)
", "
@Generated" @@ -63,7 +63,7 @@ public class TestMethodSignature extends JavadocTester { + " comments=\"some comment about the method below\")\n" + "public static void annotatedMethod" - + "​(int i,\n" + + "​(int i,\n" + "java.lang.String s,\nboolean b)
", "
public static" @@ -79,7 +79,7 @@ public class TestMethodSignature extends JavadocTester { + "title=\"class in pkg\">C.With8Types<T1,​T2,​T3," + "​T4,​T5,​T6,​T7,​T8> " + "bigGenericMethod​(" - + "C.F0<? extends T1> t1,\n" + "" + "C.F0<? extends T2> t2,\n" @@ -117,7 +117,7 @@ public class TestMethodSignature extends JavadocTester { + "title=\"class in pkg\">C.With8Types<T1,​T2,​T3," + "​T4,​T5,​T6,​T7,​T8> " + "bigGenericAnnotatedMethod​(" - + "C.F0<? extends T1> t1,\n" + "" + "C.F0<? extends T2> t2,\n" diff --git a/test/langtools/jdk/javadoc/doclet/testNewLanguageFeatures/TestNewLanguageFeatures.java b/test/langtools/jdk/javadoc/doclet/testNewLanguageFeatures/TestNewLanguageFeatures.java index 1948b87b5dd..f3a0f7f5179 100644 --- a/test/langtools/jdk/javadoc/doclet/testNewLanguageFeatures/TestNewLanguageFeatures.java +++ b/test/langtools/jdk/javadoc/doclet/testNewLanguageFeatures/TestNewLanguageFeatures.java @@ -83,7 +83,7 @@ public class TestNewLanguageFeatures extends JavadocTester { "
public static " + "Coin " + "valueOf​(" - + "java.lang.String name)
\n" + + + "java.lang.String name)
\n" + "
Returns the enum constant of this type with the specified name.\n" + "The string must match exactly an identifier used to declare an\n" + "enum constant in this type. (Extraneous whitespace characters are \n" + @@ -135,7 +135,7 @@ public class TestNewLanguageFeatures extends JavadocTester { "
public " + "<T extends java.util.List,​\nV>\n" + "java.lang.String[] " - + "methodThatHasTypeParameters​(T param1,\n" + + "methodThatHasTypeParameters​(T param1,\n" + "V param2)
", // Method that returns TypeParameters "public " + "E[] methodThatReturnsTypeParameterA​(" - + "" + + "" + "E[] e)
\n", "<T extends java.lang.Object & java.lang.Comparable<? super T>>" + "
T\n" @@ -218,7 +218,7 @@ public class TestNewLanguageFeatures extends JavadocTester { "
public " + "<T extends java.lang.Number & java.lang.Runnable>\n" + "T foo​" - + "(T t)
"); + + "(T t)
"); //============================================================== // Test Class-Use Documentation for Type Parameters. @@ -562,14 +562,14 @@ public class TestNewLanguageFeatures extends JavadocTester { // METHOD PARAMS "
public void methodWithParams" - + "​(" + + "​(" + "@AnnotationType(optional" + "=\"Parameter Annotation\",required=1994)\n" + "int documented,\n" + "int undocmented)
", // CONSTRUCTOR PARAMS "
public " - + "AnnotationTypeUsage​(" + + "AnnotationTypeUsage​(" + "@AnnotationType(" + "optional=\"Constructor Param Annotation\"," + "required=1994)\n" diff --git a/test/langtools/jdk/javadoc/doclet/testPrivateClasses/TestPrivateClasses.java b/test/langtools/jdk/javadoc/doclet/testPrivateClasses/TestPrivateClasses.java index b72ddebda50..466ce6d14e4 100644 --- a/test/langtools/jdk/javadoc/doclet/testPrivateClasses/TestPrivateClasses.java +++ b/test/langtools/jdk/javadoc/doclet/testPrivateClasses/TestPrivateClasses.java @@ -71,7 +71,7 @@ public class TestPrivateClasses extends JavadocTester { // Method is documented as though it is declared in the inheriting method. "
public " + "void " - + "methodInheritedFromParent​(int p1)\n" + + "methodInheritedFromParent​(int p1)\n" + " throws java.lang.Exception
", "
\n" + "
All Implemented Interfaces:
\n" diff --git a/test/langtools/jdk/javadoc/doclet/testRecordTypes/TestRecordTypes.java b/test/langtools/jdk/javadoc/doclet/testRecordTypes/TestRecordTypes.java index d47321e872b..3b1b793ea9b 100644 --- a/test/langtools/jdk/javadoc/doclet/testRecordTypes/TestRecordTypes.java +++ b/test/langtools/jdk/javadoc/doclet/testRecordTypes/TestRecordTypes.java @@ -436,7 +436,7 @@ public class TestRecordTypes extends JavadocTester { + "private final int" + " i
", "
public R" - + "​(" + + "​(" + pAnno + "int i)
", "
" diff --git a/test/langtools/jdk/javadoc/doclet/testSerializedFormWithClassFile/TestSerializedFormWithClassFile.java b/test/langtools/jdk/javadoc/doclet/testSerializedFormWithClassFile/TestSerializedFormWithClassFile.java index 93d227e40e3..99d085d5637 100644 --- a/test/langtools/jdk/javadoc/doclet/testSerializedFormWithClassFile/TestSerializedFormWithClassFile.java +++ b/test/langtools/jdk/javadoc/doclet/testSerializedFormWithClassFile/TestSerializedFormWithClassFile.java @@ -75,7 +75,7 @@ public class TestSerializedFormWithClassFile extends JavadocTester { checkOutput("serialized-form.html", true, "
public " + "void readObject" - + "​(java.io.ObjectInputStream arg0)\n" + + "​(java.io.ObjectInputStream arg0)\n" + " throws java.lang.ClassNotFoundException,\n" + "java.io.IOException
\n"); } diff --git a/test/langtools/jdk/javadoc/doclet/testTypeAnnotations/TestTypeAnnotations.java b/test/langtools/jdk/javadoc/doclet/testTypeAnnotations/TestTypeAnnotations.java index 3a93f3b4ced..b1f9badf52b 100644 --- a/test/langtools/jdk/javadoc/doclet/testTypeAnnotations/TestTypeAnnotations.java +++ b/test/langtools/jdk/javadoc/doclet/testTypeAnnotations/TestTypeAnnotations.java @@ -219,13 +219,13 @@ public class TestTypeAnnotations extends JavadocTester { // Test for type annotations on parameters (Parameters.java). checkOutput("typeannos/Parameters.html", true, "
void " - + "unannotated​(" + + "unannotated​(" + "ParaParameterized" + "<java.lang.String,​java.lang.String> a)
", "
void " + "nestedParaParameterized​" - + "(ParaParameterized<@ParamA ParaParameterized<void " - + "array2Deep​(" + + "array2Deep​(" + "@ParamA " + "java.lang.String " + "@ParamB [] " @@ -259,13 +259,13 @@ public class TestTypeAnnotations extends JavadocTester { checkOutput("typeannos/ThrPublicModified.html", true, "
public final " + "void " - + "oneException​(java.lang.String a)\n" + + "oneException​(java.lang.String a)\n" + " throws @ThrA java.lang.Exception
", "
public final " + "void " - + "twoExceptions​(java.lang.String a)\n" + + "twoExceptions​(java.lang.String a)\n" + " throws @ThrA java.lang.RuntimeException,\n" + "@ThrA " @@ -296,7 +296,7 @@ public class TestTypeAnnotations extends JavadocTester { // Test for type annotations on wildcard type (Wildcards.java). checkOutput("typeannos/BoundTest.html", true, "
void " - + "wcExtends​(" + + "wcExtends​(" + "MyList<? extends " + "@WldA " + "java.lang.String> l)
", @@ -308,7 +308,7 @@ public class TestTypeAnnotations extends JavadocTester { checkOutput("typeannos/BoundWithValue.html", true, "
void " - + "wcSuper​(" + + "wcSuper​(" + "MyList<? super " + "@WldB(\"m\") " + "java.lang.String> l)
", @@ -321,20 +321,20 @@ public class TestTypeAnnotations extends JavadocTester { // Test for receiver annotations (Receivers.java). checkOutput("typeannos/DefaultUnmodified.html", true, "
void " - + "withException​(" + + "withException​(" + "@RcvrA" + " DefaultUnmodified this)\n" + " throws java.lang.Exception
", "
java.lang.String " - + "nonVoid​(" + + "nonVoid​(" + "@RcvrA " + "@RcvrB(\"m\")" + " DefaultUnmodified this)
", "
<T extends " + "java.lang.Runnable> void " - + "accept​(" + + "accept​(" + "@RcvrA " + "DefaultUnmodified this,\nT r)\n" + " throws " @@ -343,14 +343,14 @@ public class TestTypeAnnotations extends JavadocTester { checkOutput("typeannos/PublicModified.html", true, "
public final " + "java.lang.String " - + "nonVoid​(​(@RcvrA PublicModified this)" + "
", "
public final " + "<T extends java.lang.Runnable> " + "void accept" - + "​(​(@RcvrA PublicModified this,\n" + "T r)\n throws " + "java.lang.Exception
"); @@ -358,7 +358,7 @@ public class TestTypeAnnotations extends JavadocTester { checkOutput("typeannos/WithValue.html", true, "
<T extends " + "java.lang.Runnable> void " - + "accept​(" + + "accept​(" + "@RcvrB(\"m\")" + " WithValue this,\nT r)\n" + " throws " @@ -366,20 +366,20 @@ public class TestTypeAnnotations extends JavadocTester { checkOutput("typeannos/WithFinal.html", true, "
java.lang.String" - + " nonVoid​(" + + " nonVoid​(" + "@RcvrB(\"m\") " + "WithFinal" + " afield)
"); checkOutput("typeannos/WithBody.html", true, "
void " - + "field​(" + + "field​(" + "@RcvrA" + " WithBody this)
"); checkOutput("typeannos/Generic2.html", true, "
void " - + "test2​(" + + "test2​(" + "@RcvrA" + " Generic2<X> this)
"); @@ -434,7 +434,7 @@ public class TestTypeAnnotations extends JavadocTester { + "@RepConstructorB @RepConstructorB\n" + "RepeatingOnConstructor" - + "​(int i,\n" + + "​(int i,\n" + "int j)
", "
" @@ -445,11 +445,11 @@ public class TestTypeAnnotations extends JavadocTester { + "@RepAllContextsB @RepAllContextsB\n" + "RepeatingOnConstructor" - + "​(int i,\n" + + "​(int i,\n" + "int j,\nint k)
", "
RepeatingOnConstructor" - + "​(@RepParameterA " + "@RepParameterA " + "@RepParameterB " @@ -474,7 +474,7 @@ public class TestTypeAnnotations extends JavadocTester { + "@RepTypeUseA " + "@RepTypeUseB " + "@RepTypeUseB ... vararg)", - "Inner​(​(@RepTypeUseA @RepTypeUseA @RepTypeUseB test4()", "java.lang.String test5​(" - + "@RepTypeUseA " + "@RepTypeUseA " + "@RepTypeUseB " @@ -715,7 +715,7 @@ public class TestTypeAnnotations extends JavadocTester { "java.lang.String " + "test" - + "​(@RepTypeUseA " + "@RepTypeUseA