Skip to content

Commit

Permalink
8274666: rename HtmlStyle.descfrmTypeLabel to be less cryptic
Browse files Browse the repository at this point in the history 
Reviewed-by: hannesw
  • Loading branch information
@jonathan-gibbons
jonathan-gibbons committed Oct 4, 2021
1 parent 139a833 commit 6f727d8
Show file tree
Hide file tree
Showing 11 changed files with 30 additions and 31 deletions.
8 changes: 4 additions & 4 deletions src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Contents.java
View file
Expand Up @@ -81,8 +81,8 @@ public class Contents {
public final Content deprecatedLabel;
public final Content deprecatedPhrase;
public final Content deprecatedForRemovalPhrase;
public final Content descfrmClassLabel;
public final Content descfrmInterfaceLabel;
public final Content descriptionFromClassLabel;
public final Content descriptionFromInterfaceLabel;
public final Content descriptionLabel;
public final Content detailLabel;
public final Content enclosingClassLabel;
Expand Down Expand Up @@ -227,8 +227,8 @@ public class Contents {
deprecatedLabel = getContent("doclet.navDeprecated");
deprecatedPhrase = getContent("doclet.Deprecated");
deprecatedForRemovalPhrase = getContent("doclet.DeprecatedForRemoval");
descfrmClassLabel = getContent("doclet.Description_From_Class");
descfrmInterfaceLabel = getContent("doclet.Description_From_Interface");
descriptionFromClassLabel = getContent("doclet.Description_From_Class");
descriptionFromInterfaceLabel = getContent("doclet.Description_From_Interface");
descriptionLabel = getContent("doclet.Description");
detailLabel = getContent("doclet.Detail");
enclosingClassLabel = getContent("doclet.Enclosing_Class");
Expand Down
12 changes: 6 additions & 6 deletions ...jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/MethodWriterImpl.java
View file
Expand Up @@ -157,13 +157,13 @@ public void addComments(TypeMirror holderType, ExecutableElement method, Content
? utils.getSimpleName(holder)
: utils.getFullyQualifiedName(holder));
Content codeLink = HtmlTree.CODE(link);
Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
Content descriptionFromTypeLabel = HtmlTree.SPAN(HtmlStyle.descriptionFromTypeLabel,
utils.isClass(holder)
? contents.descfrmClassLabel
: contents.descfrmInterfaceLabel);
descfrmLabel.add(Entity.NO_BREAK_SPACE);
descfrmLabel.add(codeLink);
methodDocTree.add(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
? contents.descriptionFromClassLabel
: contents.descriptionFromInterfaceLabel);
descriptionFromTypeLabel.add(Entity.NO_BREAK_SPACE);
descriptionFromTypeLabel.add(codeLink);
methodDocTree.add(HtmlTree.DIV(HtmlStyle.block, descriptionFromTypeLabel));
}
writer.addInlineComment(method, methodDocTree);
}
Expand Down
12 changes: 6 additions & 6 deletions ...k.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PropertyWriterImpl.java
View file
Expand Up @@ -118,13 +118,13 @@ public void addComments(ExecutableElement property, Content propertyDocTree) {
utils.isIncluded(holder)
? holder.getSimpleName() : holder.getQualifiedName());
Content codeLink = HtmlTree.CODE(link);
Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
Content descriptionFromLabel = HtmlTree.SPAN(HtmlStyle.descriptionFromTypeLabel,
utils.isClass(holder)
? contents.descfrmClassLabel
: contents.descfrmInterfaceLabel);
descfrmLabel.add(Entity.NO_BREAK_SPACE);
descfrmLabel.add(codeLink);
propertyDocTree.add(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
? contents.descriptionFromClassLabel
: contents.descriptionFromInterfaceLabel);
descriptionFromLabel.add(Entity.NO_BREAK_SPACE);
descriptionFromLabel.add(codeLink);
propertyDocTree.add(HtmlTree.DIV(HtmlStyle.block, descriptionFromLabel));
}
writer.addInlineComment(property, propertyDocTree);
}
Expand Down
3 changes: 1 addition & 2 deletions ...jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java
View file
Expand Up @@ -385,8 +385,7 @@ public enum HtmlStyle {
/**
* The class for a label indicating the element from which a description has been copied.
*/
// This should be renamed to something less cryptic
descfrmTypeLabel,
descriptionFromTypeLabel,

/**
* The class for a note providing information about the permitted subtypes of a
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/stylesheet.css
View file
Expand Up @@ -549,7 +549,7 @@ h1.hidden {
margin:0 10px 5px 0;
color:#474747;
}
.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link,
.deprecated-label, .description-from-type-label, .implementation-label, .member-name-label, .member-name-link,
.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type,
.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label {
font-weight:bold;
Expand Down
2 changes: 1 addition & 1 deletion test/langtools/jdk/javadoc/doclet/testInterface/TestInterface.java
View file
Expand Up @@ -150,7 +150,7 @@ public void test() {
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;\
<span class="return-type">void</span>&nbsp;<span class="element-name">staticMethod</span\
>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from inte\
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface:&nbsp;<code><a href="InterfaceWithStaticMembers.html#staticMethod()">Inter\
faceWithStaticMembers</a></code></span></div>
<div class="block">A static method</div>
Expand Down
2 changes: 1 addition & 1 deletion test/langtools/jdk/javadoc/doclet/testOptions/custom-stylesheet.css
View file
Expand Up @@ -609,7 +609,7 @@ h1.hidden {
margin:3px 10px 2px 0px;
color:#474747;
}
.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink,
.deprecatedLabel, .descriptionFromTypeLabel, .memberNameLabel, .memberNameLink,
.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel,
.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink {
font-weight:bold;
Expand Down
2 changes: 1 addition & 1 deletion test/langtools/jdk/javadoc/doclet/testOverriddenMethods/TestOverriddenMethodDocCopy.java
View file
Expand Up @@ -54,7 +54,7 @@ public void test() {

checkOutput("pkg1/SubClass.html", true,
"""
<span class="descfrm-type-label">Description copied from class:&nbsp;<code><a hr\
<span class="description-from-type-label">Description copied from class:&nbsp;<code><a hr\
ef="BaseClass.html#overriddenMethodWithDocsToCopy()">BaseClass</a></code></span>""");
}
}
14 changes: 7 additions & 7 deletions test/langtools/jdk/javadoc/doclet/testOverriddenMethods/TestOverrideMethods.java
View file
Expand Up @@ -412,7 +412,7 @@ annotation interface in pkg7">@A</a>
="element-name">m1</span><wbr><span class="parameters">(java.lang.Class&lt;? ext\
ends java.lang.CharSequence&gt;&nbsp;p1,
int[]&nbsp;p2)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from inte\
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface:&nbsp;<code><a href="AnnotatedBase.html#m1(java.lang.Class,int%5B%5D)">Ann\
otatedBase</a></code></span></div>
<div class="block">This is AnnotatedBase::m1.</div>
Expand All @@ -437,7 +437,7 @@ annotation interface in pkg7">@A</a>
="element-name">m1</span><wbr><span class="parameters">(java.lang.Class&lt;? ext\
ends java.lang.CharSequence&gt;&nbsp;p1,
int[]&nbsp;p2)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from inte\
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface:&nbsp;<code><a href="AnnotatedBase.html#m1(java.lang.Class,int%5B%5D)">Ann\
otatedBase</a></code></span></div>
<div class="block">This is AnnotatedBase::m1.</div>
Expand All @@ -460,7 +460,7 @@ annotation interface in pkg7">@A</a>
/span>&nbsp;<span class="element-name">m1</span><wbr><span class="parameters">(j\
ava.lang.Class&lt;? extends java.lang.CharSequence&gt;&nbsp;p1,
int[]&nbsp;p2)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from inte\
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface:&nbsp;<code><a href="AnnotatedBase.html#m1(java.lang.Class,int%5B%5D)">Ann\
otatedBase</a></code></span></div>
<div class="block">This is AnnotatedBase::m1.</div>
Expand All @@ -484,7 +484,7 @@ annotation interface in pkg7">@A</a>
<a href="A.html" title="annotation interface in pkg7">@A</a> java.lang.Class&lt\
;? extends java.lang.CharSequence&gt;&nbsp;p1,
int[]&nbsp;p2)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from inte\
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface:&nbsp;<code><a href="AnnotatedBase.html#m1(java.lang.Class,int%5B%5D)">Ann\
otatedBase</a></code></span></div>
<div class="block">This is AnnotatedBase::m1.</div>
Expand All @@ -507,7 +507,7 @@ annotation interface in pkg7">@A</a>
ass="parameters">(java.lang.Class&lt;<a href="A.html" title="annotation interfac\
e in pkg7">@A</a> ? extends java.lang.CharSequence&gt;&nbsp;p1,
int[]&nbsp;p2)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from inte\
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface:&nbsp;<code><a href="AnnotatedBase.html#m1(java.lang.Class,int%5B%5D)">Ann\
otatedBase</a></code></span></div>
<div class="block">This is AnnotatedBase::m1.</div>
Expand All @@ -530,7 +530,7 @@ annotation interface in pkg7">@A</a>
ass="parameters">(java.lang.Class&lt;? extends <a href="A.html" title="annotatio\
n interface in pkg7">@A</a> java.lang.CharSequence&gt;&nbsp;p1,
int[]&nbsp;p2)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from inte\
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface:&nbsp;<code><a href="AnnotatedBase.html#m1(java.lang.Class,int%5B%5D)">Ann\
otatedBase</a></code></span></div>
<div class="block">This is AnnotatedBase::m1.</div>
Expand All @@ -553,7 +553,7 @@ n interface in pkg7">@A</a> java.lang.CharSequence&gt;&nbsp;p1,
ass="parameters">(java.lang.Class&lt;? extends java.lang.CharSequence&gt;&nbsp;p1,
int <a href="A.html" title="annotation interface in pkg7">@A</a> []&nbsp;p2)</s\
pan></div>
<div class="block"><span class="descfrm-type-label">Description copied from inte\
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface:&nbsp;<code><a href="AnnotatedBase.html#m1(java.lang.Class,int%5B%5D)">Ann\
otatedBase</a></code></span></div>
<div class="block">This is AnnotatedBase::m1.</div>
Expand Down
2 changes: 1 addition & 1 deletion test/langtools/jdk/javadoc/doclet/testPrivateClasses/TestPrivateClasses.java
View file
Expand Up @@ -224,7 +224,7 @@ public void testPrivate() {
//Since private flag is used, we can document that private interface method
//with generic parameters has been implemented.
"""
<span class="descfrm-type-label">Description copied from interface:&nbsp;<code><\
<span class="description-from-type-label">Description copied from interface:&nbsp;<code><\
a href="I.html#hello(T)">I</a></code></span>""",
"""
<dt>Specified by:</dt>
Expand Down
2 changes: 1 addition & 1 deletion test/langtools/jdk/javadoc/doclet/testReturnTag/TestReturnTag.java
View file
Expand Up @@ -379,7 +379,7 @@ public class C extends Super {

checkOutput("C.html", true,
"""
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code>Super</code></span></div>
<div class="block"><span class="description-from-type-label">Description copied from class:&nbsp;<code>Super</code></span></div>
<div class="block">Returns the result.</div>
<dl class="notes">
<dt>Overrides:</dt>
Expand Down

1 comment on commit 6f727d8

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review

Issues

Please sign in to comment.