stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8272375: Improve phrasing of synthesized descriptions in JavaFX docs

Browse Source 
Reviewed-by: kcr, prappo
This commit is contained in:
Jonathan Gibbons 2021-09-08 17:38:05 +00:00
parent 267c61a16a
commit 4d5e1ed958
4 changed files with 56 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
View File

@ -85,11 +85,11 @@ doclet.not_standard_file_manager = Cannot set taglet path; the file manager is n
doclet.Author=Author:
doclet.DefaultValue=Default value:
doclet.PropertyDescription=Property description:
doclet.PropertyGetterWithName=Gets the value of the property {0}.
doclet.PropertyGetterReturn=the value of the property {0}
doclet.PropertySetterWithName=Sets the value of the property {0}.
doclet.PropertySetterParam=the value for the property {0}
doclet.PropertyMethodReturn=the property {0}
doclet.PropertyGetterWithName=Gets the value of the {0} property.
doclet.PropertyGetterReturn=the value of the {0} property
doclet.PropertySetterWithName=Sets the value of the {0} property.
doclet.PropertySetterParam=the value for the {0} property
doclet.PropertyMethodReturn=the {0} property
doclet.Default=Default:
doclet.Parameters=Parameters:
doclet.TypeParameters=Type Parameters:

76
test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java
View File

@ -72,14 +72,14 @@ public class TestJavaFX extends JavadocTester {
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">void</span>&nbsp;<span class="element-name">setRate</span><wbr>\
<span class="parameters">(double&nbsp;value)</span></div>
<div class="block">Sets the value of the property <code>rate</code>.</div>
<div class="block">Sets the value of the <code>rate</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>""",
"""
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">double</span>&nbsp;<span class="element-name">getRate</span>()<\
/div>
<div class="block">Gets the value of the property <code>rate</code>.</div>
<div class="block">Gets the value of the <code>rate</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>""",
"""
@ -117,14 +117,14 @@ public class TestJavaFX extends JavadocTester {
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">double</span>&nbsp;<span class="element-name">isPaused<\
/span>()</div>
<div class="block">Gets the value of the property <code>paused</code>.</div>""",
<div class="block">Gets the value of the <code>paused</code> property.</div>""",
"""
<section class="detail" id="setPaused(boolean)">
<h3>setPaused</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">void</span>&nbsp;<span class="element-name">setPaused</\
span><wbr><span class="parameters">(boolean&nbsp;value)</span></div>
<div class="block">Sets the value of the property <code>paused</code>.</div>
<div class="block">Sets the value of the <code>paused</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>
<dd>Defines if paused. The second line.</dd>
@ -136,7 +136,7 @@ public class TestJavaFX extends JavadocTester {
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">double</span>&nbsp;<span class="element-name">isPaused<\
/span>()</div>
<div class="block">Gets the value of the property <code>paused</code>.</div>
<div class="block">Gets the value of the <code>paused</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>
<dd>Defines if paused. The second line.</dd>
@ -151,39 +151,39 @@ public class TestJavaFX extends JavadocTester {
<div class="block">Defines the direction/speed at which the <code>Timeline</code> is expected to
be played. This is the second line.</div>""",
"""
<section class="detail" id="setRate(double)">
<h3>setRate</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">void</span>&nbsp;<span class="element-name">setRate</sp\
an><wbr><span class="parameters">(double&nbsp;value)</span></div>
<div class="block">Sets the value of the property <code>rate</code>.</div>
<dl class="notes">
<dt>Property description:</dt>
<dd>Defines the direction/speed at which the <code>Timeline</code> is expected to
be played. This is the second line.</dd>
<dt>Default value:</dt>
<dd>11</dd>
<dt>Parameters:</dt>
<dd><code>value</code> - the value for the property <code>rate</code></dd>
<dt>Since:</dt>
<dd>JavaFX 8.0</dd>""",
<section class="detail" id="setRate(double)">
<h3>setRate</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">void</span>&nbsp;<span class="element-name">setRate</sp\
an><wbr><span class="parameters">(double&nbsp;value)</span></div>
<div class="block">Sets the value of the <code>rate</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>
<dd>Defines the direction/speed at which the <code>Timeline</code> is expected to
be played. This is the second line.</dd>
<dt>Default value:</dt>
<dd>11</dd>
<dt>Parameters:</dt>
<dd><code>value</code> - the value for the <code>rate</code> property</dd>
<dt>Since:</dt>
<dd>JavaFX 8.0</dd>""",
"""
<section class="detail" id="getRate()">
<h3>getRate</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">double</span>&nbsp;<span class="element-name">getRate</span>()<\
/div>
<div class="block">Gets the value of the property <code>rate</code>.</div>
<dl class="notes">
<dt>Property description:</dt>
<dd>Defines the direction/speed at which the <code>Timeline</code> is expected to
be played. This is the second line.</dd>
<dt>Default value:</dt>
<dd>11</dd>
<dt>Returns:</dt>
<dd>the value of the property <code>rate</code></dd>
<dt>Since:</dt>
<dd>JavaFX 8.0</dd>""",
<section class="detail" id="getRate()">
<h3>getRate</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<\
span class="return-type">double</span>&nbsp;<span class="element-name">getRate</span>()<\
/div>
<div class="block">Gets the value of the <code>rate</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>
<dd>Defines the direction/speed at which the <code>Timeline</code> is expected to
be played. This is the second line.</dd>
<dt>Default value:</dt>
<dd>11</dd>
<dt>Returns:</dt>
<dd>the value of the <code>rate</code> property</dd>
<dt>Since:</dt>
<dd>JavaFX 8.0</dd>""",
"""
<section class="property-summary" id="property-summary">
<h2>Property Summary</h2>
@ -226,7 +226,7 @@ public class TestJavaFX extends JavadocTester {
checkOutput("index-all.html", true,
"""
<div class="block">Gets the value of the property <code>paused</code>.</div>""",
<div class="block">Gets the value of the <code>paused</code> property.</div>""",
"""
<div class="block">Defines if paused.</div>""");

18
test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFXCombo.java
View File

@ -155,12 +155,12 @@ public class TestJavaFXCombo extends JavadocTester {
<section class="detail" id="getExample()">
<h3>getExample</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getExample</span>()</div>
<div class="block">Gets the value of the property <code>example</code>.</div>
<div class="block">Gets the value of the <code>example</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>
#DESC#
<dt>Returns:</dt>
<dd>the value of the property <code>example</code></dd>
<dd>the value of the <code>example</code> property</dd>
#SEE#
</dl>
</section>
@ -180,7 +180,7 @@ public class TestJavaFXCombo extends JavadocTester {
<div class="block">Getter method description. More getter method description.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the property <code>example</code></dd>
<dd>the <code>example</code> property</dd>
</dl>
</section>
""");
@ -200,12 +200,12 @@ public class TestJavaFXCombo extends JavadocTester {
<section class="detail" id="setExample(boolean)">
<h3>setExample</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setExample</span><wbr><span class="parameters">(boolean&nbsp;b)</span></div>
<div class="block">Sets the value of the property <code>example</code>.</div>
<div class="block">Sets the value of the <code>example</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>
#DESC#
<dt>Parameters:</dt>
<dd><code>b</code> - the value for the property <code>example</code></dd>
<dd><code>b</code> - the value for the <code>example</code> property</dd>
#SEE#
</dl>
</section>
@ -246,7 +246,7 @@ public class TestJavaFXCombo extends JavadocTester {
#PCOMM#
<dl class="notes">
<dt>Returns:</dt>
<dd>the property <code>example</code></dd>
<dd>the <code>example</code> property</dd>
#SEE#
</dl>
</section>
@ -266,7 +266,7 @@ public class TestJavaFXCombo extends JavadocTester {
<div class="block">Property method description. More property method description.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the property <code>example</code></dd>
<dd>the <code>example</code> property</dd>
#SEE#
</dl>
</section>
@ -371,7 +371,7 @@ public class TestJavaFXCombo extends JavadocTester {
case COMMENT -> """
/**
* Property method description. More property method description.
* @return the property {@code example}
* @return the {@code example} property
*/
public BooleanProperty exampleProperty();
""";
@ -392,7 +392,7 @@ public class TestJavaFXCombo extends JavadocTester {
case COMMENT -> """
/**
* Getter method description. More getter method description.
* @return the property {@code example}
* @return the {@code example} property
*/
public boolean getExample();
""";

8
test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFXMissingPropComments.java
View File

@ -92,12 +92,12 @@ public class TestJavaFXMissingPropComments extends JavadocTester {
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span c\
lass="return-type">boolean</span>&nbsp;<span class="element-name">getValue</span\
>()</div>
<div class="block">Gets the value of the property <code>value</code>.</div>
<div class="block">Gets the value of the <code>value</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>
<dd>The value property (property method comment).</dd>
<dt>Returns:</dt>
<dd>the value of the property <code>value</code></dd>
<dd>the value of the <code>value</code> property</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
@ -156,12 +156,12 @@ public class TestJavaFXMissingPropComments extends JavadocTester {
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span c\
lass="return-type">boolean</span>&nbsp;<span class="element-name">getValue</span\
>()</div>
<div class="block">Gets the value of the property <code>value</code>.</div>
<div class="block">Gets the value of the <code>value</code> property.</div>
<dl class="notes">
<dt>Property description:</dt>
<dd>The value property (field comment).</dd>
<dt>Returns:</dt>
<dd>the value of the property <code>value</code></dd>
<dd>the value of the <code>value</code> property</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">