archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 15:24:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8169819: minor cleanup for deprecated page

Browse source 
Reviewed-by: jjg, ksrini
This commit is contained in:
Bhavesh Patel 2017-10-02 14:49:46 -07:00
parent 47e2972a64
commit 448718c0af
14 changed files with 166 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractExecutableMemberWriter.java
View file

@ -99,15 +99,19 @@ public abstract class AbstractExecutableMemberWriter extends AbstractMemberWrite
*/
@Override
protected Content getDeprecatedLink(Element member) {
StringBuilder sb = new StringBuilder();
sb.append(utils.getFullyQualifiedName(member));
Content deprecatedLinkContent = new ContentBuilder();
deprecatedLinkContent.addContent(utils.getFullyQualifiedName(member));
if (!utils.isConstructor(member)) {
sb.append(".");
sb.append(member.getSimpleName());
deprecatedLinkContent.addContent(".");
deprecatedLinkContent.addContent(member.getSimpleName());
}
sb.append(utils.flatSignature((ExecutableElement) member));
String signature = utils.flatSignature((ExecutableElement) member);
if (signature.length() > 2) {
deprecatedLinkContent.addContent(Contents.ZERO_WIDTH_SPACE);
}
deprecatedLinkContent.addContent(signature);
return writer.getDocLink(MEMBER, member, sb);
return writer.getDocLink(MEMBER, utils.getEnclosingTypeElement(member), member, deprecatedLinkContent);
}
/**

58
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DeprecatedListWriter.java
View file

@ -100,33 +100,33 @@ public class DeprecatedListWriter extends SubWriterHolderWriter {
private String getHeadingKey(DeprElementKind kind) {
switch (kind) {
case REMOVAL:
return "doclet.Deprecated_For_Removal";
return "doclet.For_Removal";
case MODULE:
return "doclet.Deprecated_Modules";
return "doclet.Modules";
case PACKAGE:
return "doclet.Deprecated_Packages";
return "doclet.Packages";
case INTERFACE:
return "doclet.Deprecated_Interfaces";
return "doclet.Interfaces";
case CLASS:
return "doclet.Deprecated_Classes";
return "doclet.Classes";
case ENUM:
return "doclet.Deprecated_Enums";
return "doclet.Enums";
case EXCEPTION:
return "doclet.Deprecated_Exceptions";
return "doclet.Exceptions";
case ERROR:
return "doclet.Deprecated_Errors";
return "doclet.Errors";
case ANNOTATION_TYPE:
return "doclet.Deprecated_Annotation_Types";
return "doclet.Annotation_Types";
case FIELD:
return "doclet.Deprecated_Fields";
return "doclet.Fields";
case METHOD:
return "doclet.Deprecated_Methods";
return "doclet.Methods";
case CONSTRUCTOR:
return "doclet.Deprecated_Constructors";
return "doclet.Constructors";
case ENUM_CONSTANT:
return "doclet.Deprecated_Enum_Constants";
return "doclet.Enum_Constants";
case ANNOTATION_TYPE_MEMBER:
return "doclet.Deprecated_Annotation_Type_Members";
return "doclet.Annotation_Type_Members";
default:
throw new AssertionError("unknown kind: " + kind);
}
@ -135,33 +135,33 @@ public class DeprecatedListWriter extends SubWriterHolderWriter {
private String getSummaryKey(DeprElementKind kind) {
switch (kind) {
case REMOVAL:
return "doclet.deprecated_for_removal";
return "doclet.for_removal";
case MODULE:
return "doclet.deprecated_modules";
return "doclet.modules";
case PACKAGE:
return "doclet.deprecated_packages";
return "doclet.packages";
case INTERFACE:
return "doclet.deprecated_interfaces";
return "doclet.interfaces";
case CLASS:
return "doclet.deprecated_classes";
return "doclet.classes";
case ENUM:
return "doclet.deprecated_enums";
return "doclet.enums";
case EXCEPTION:
return "doclet.deprecated_exceptions";
return "doclet.exceptions";
case ERROR:
return "doclet.deprecated_errors";
return "doclet.errors";
case ANNOTATION_TYPE:
return "doclet.deprecated_annotation_types";
return "doclet.annotation_types";
case FIELD:
return "doclet.deprecated_fields";
return "doclet.fields";
case METHOD:
return "doclet.deprecated_methods";
return "doclet.methods";
case CONSTRUCTOR:
return "doclet.deprecated_constructors";
return "doclet.constructors";
case ENUM_CONSTANT:
return "doclet.deprecated_enum_constants";
return "doclet.enum_constants";
case ANNOTATION_TYPE_MEMBER:
return "doclet.deprecated_annotation_type_members";
return "doclet.annotation_type_members";
default:
throw new AssertionError("unknown kind: " + kind);
}
@ -473,6 +473,6 @@ public class DeprecatedListWriter extends SubWriterHolderWriter {
default:
writer = new AnnotationTypeOptionalMemberWriterImpl(this, null);
}
return HtmlTree.TH_ROW_SCOPE(HtmlStyle.colFirst, writer.getDeprecatedLink(e));
return HtmlTree.TH_ROW_SCOPE(HtmlStyle.colDeprecatedItemName, writer.getDeprecatedLink(e));
}
}

1
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java
View file

@ -47,6 +47,7 @@ public enum HtmlStyle {
circle,
classUseContainer,
colConstructorName,
colDeprecatedItemName,
colFirst,
colLast,
colSecond,

34
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties
View file

@ -74,34 +74,12 @@ doclet.see.class_or_package_not_found=Tag {0}: reference not found: {1}
doclet.see.class_or_package_not_accessible=Tag {0}: reference not accessible: {1}
doclet.tag.invalid_usage=invalid usage of tag {0}
doclet.Deprecated_API=Deprecated API
doclet.Deprecated_For_Removal=Deprecated For Removal
doclet.Deprecated_Modules=Deprecated Modules
doclet.Deprecated_Packages=Deprecated Packages
doclet.Deprecated_Classes=Deprecated Classes
doclet.Deprecated_Enums=Deprecated Enums
doclet.Deprecated_Interfaces=Deprecated Interfaces
doclet.Deprecated_Exceptions=Deprecated Exceptions
doclet.Deprecated_Annotation_Types=Deprecated Annotation Types
doclet.Deprecated_Errors=Deprecated Errors
doclet.Deprecated_Fields=Deprecated Fields
doclet.Deprecated_Constructors=Deprecated Constructors
doclet.Deprecated_Methods=Deprecated Methods
doclet.Deprecated_Enum_Constants=Deprecated Enum Constants
doclet.Deprecated_Annotation_Type_Members=Deprecated Annotation Type Elements
doclet.deprecated_for_removal=deprecated for removal
doclet.deprecated_modules=deprecated modules
doclet.deprecated_packages=deprecated packages
doclet.deprecated_classes=deprecated classes
doclet.deprecated_enums=deprecated enums
doclet.deprecated_interfaces=deprecated interfaces
doclet.deprecated_exceptions=deprecated exceptions
doclet.deprecated_annotation_types=deprecated annotation types
doclet.deprecated_errors=deprecated errors
doclet.deprecated_fields=deprecated fields
doclet.deprecated_constructors=deprecated constructors
doclet.deprecated_methods=deprecated methods
doclet.deprecated_enum_constants=deprecated enum constants
doclet.deprecated_annotation_type_members=deprecated annotation type elements
doclet.For_Removal=For Removal
doclet.Annotation_Types=Annotation Types
doclet.Annotation_Type_Members=Annotation Type Elements
doclet.for_removal=for removal
doclet.annotation_types=annotation types
doclet.annotation_type_members=annotation type elements
doclet.Generated_Docs_Untitled=Generated Documentation (Untitled)
doclet.Other_Packages=Other Packages
doclet.Description=Description

11
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/stylesheet.css
View file

@ -531,14 +531,16 @@ Table styles
text-align:left;
padding:0px 0px 12px 10px;
}
th.colFirst, th.colSecond, th.colLast, th.colConstructorName, .useSummary th, .constantsSummary th, .packagesSummary th,
td.colFirst, td.colSecond, td.colLast, .useSummary td, .constantsSummary td {
th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th,
.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td,
.constantsSummary td {
vertical-align:top;
padding-right:0px;
padding-top:8px;
padding-bottom:3px;
}
th.colFirst, th.colSecond, th.colLast, th.colConstructorName, .constantsSummary th, .packagesSummary th {
th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th,
.packagesSummary th {
background:#dee3e9;
text-align:left;
padding:8px 3px 3px 7px;
@ -547,7 +549,7 @@ td.colFirst, th.colFirst {
white-space:nowrap;
font-size:13px;
}
td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colLast {
td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast {
font-size:13px;
}
.constantsSummary th, .packagesSummary th {
@ -576,6 +578,7 @@ td.colSecond a:link, td.colSecond a:visited,
th.colFirst a:link, th.colFirst a:visited,
th.colSecond a:link, th.colSecond a:visited,
th.colConstructorName a:link, th.colConstructorName a:visited,
th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited,
.constantValuesContainer td a:link, .constantValuesContainer td a:visited {
font-weight:bold;
}

2
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DeprecatedAPIListBuilder.java
View file

@ -78,7 +78,7 @@ public class DeprecatedAPIListBuilder {
deprecatedMap = new EnumMap<>(DeprElementKind.class);
for (DeprElementKind kind : DeprElementKind.values()) {
deprecatedMap.put(kind,
new TreeSet<>(utils.makeGeneralPurposeComparator()));
new TreeSet<>(utils.makeDeprecatedComparator()));
}
buildDeprecatedAPIInfo();
}

19
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java
View file

@ -1733,6 +1733,25 @@ public class Utils {
return packageComparator;
}
private Comparator<Element> deprecatedComparator = null;
/**
* Returns a Comparator for deprecated items listed on deprecated list page, by comparing the
* fully qualified names.
*
* @return a Comparator
*/
public Comparator<Element> makeDeprecatedComparator() {
if (deprecatedComparator == null) {
deprecatedComparator = new Utils.ElementComparator() {
@Override
public int compare(Element e1, Element e2) {
return compareFullyQualifiedNames(e1, e2);
}
};
}
return deprecatedComparator;
}
private Comparator<SerialFieldTree> serialFieldTreeComparator = null;
/**
* Returns a Comparator for SerialFieldTree.