JDK-8177341 : Fix typos in FX API docs
  • Type: Bug
  • Component: javafx
  • Sub-Component: scenegraph
  • Affected Version: 9
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2017-03-21
  • Updated: 2017-05-10
  • Resolved: 2017-05-10
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 9
9Fixed
Related Reports
Duplicate :  
JDK-8177351 - Bad first sentence in doc for Timeline
Duplicate :  
JDK-8177379 - Dialog API javadoc close() and hide() methods description are backwards
Relates :  
JDK-8177081 - visible entity for @ in sample code in ImageView
Relates :  
JDK-8180019 - javadoc should treat failure to access URL as an error, not a warning.
Description
We have at least one typo in the JavaFX scenegraph docs.

As a comment added to JDK-8177081, Jon Gibbons wrote:

-----------

Separate typo, bad punctuation in Circle.java. The first sentence is "broken".

The Circle class creates a new circle with the specified radius and center location measured in pixels Example usage.

This leaks through to the corresponding package summary page as well.

At a minimum, I suggest a period after "pixels".
Comments
Changeset: 6e6860b1f95f Author: kcr Date: 2017-05-09 16:16 -0700 URL: http://hg.openjdk.java.net/openjfx/9-dev/rt/rev/6e6860b1f95f 8177341: Fix typos in FX API docs Reviewed-by: ckyang, jgiles
10-05-2017
+1
09-05-2017
+1
09-05-2017
Update webrev: http://cr.openjdk.java.net/~kcr/8177341/webrev.01/ Delta between .00 and .01 versions: http://cr.openjdk.java.net/~kcr/8177341/webrev.delta.00-01/ This fixes the 4 remaining places where < and > are visible in the generated docs.
09-05-2017
And thanks for taking care of the non-javafx ones :)
08-05-2017
Using Jon's grep command, I see the following 4 occurrences in the javafx.* modules after applying the .00 patch: ./javafx/css/StyleablePropertyFactory.html: StyleableProperty&amp;lt;Orientation&amp;gt; orientation = ./javafx/css/converter/URLConverter.html: The input value is in the form: <code>url("&amp;lt;path&amp;gt;")</code>.</div> ./javafx/css/package-summary.html: <code>public static List&amp;lt;CssMetaData&amp;lt;? extends Styleable, ?&amp;gt;&amp;gt; getClassCssMetaData()</code> method that ./javafx/css/ParsedValue.html: the parser creates a <code>ParsedValue&amp;lt;String,Color&amp;gt;</code> when it parses a
08-05-2017
I'll check out the javax.swing and org.w3c.dom ones, as my penance for not providing a filtered list specific to javafx ;-)
08-05-2017
The ones in JavaBeanProperty and ReadOnlyJavaBeanProperty are already addressed in the .00 webrev. I'll take care of the rest of the javafx ones. It might be good to file a separate bug against the javax.swing and org.w3c.dom classes (since they aren't in the javafx.* modules)
08-05-2017
grep the generated docs for &amp;gt; and &amp;lt; :-) $ grep -r '&amp;gt;' build/linux-x86_64-normal-server-release/images/docs/api build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/value/class-use/ObservableValue.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/value/class-use/ObservableValue.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/value/class-use/WritableValue.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/JavaBeanProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/ReadOnlyJavaBeanProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/package-use.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/package-use.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/class-use/ReadOnlyJavaBeanProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/package-summary.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/package-summary.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/class-use/ReadOnlyProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/class-use/ReadOnlyProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/class-use/Property.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/class-use/Observable.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/class-use/Observable.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/css/StyleablePropertyFactory.html: StyleableProperty&amp;lt;Orientation&amp;gt; orientation = build/linux-x86_64-normal-server-release/images/docs/api/javafx/css/converter/URLConverter.html: The input value is in the form: <code>url("&amp;lt;path&amp;gt;")</code>.</div> build/linux-x86_64-normal-server-release/images/docs/api/javafx/css/ParsedValue.html: the parser creates a <code>ParsedValue&amp;lt;String,Color&amp;gt;</code> when it parses a build/linux-x86_64-normal-server-release/images/docs/api/javafx/css/package-summary.html: <code>public static List&amp;lt;CssMetaData&amp;lt;? extends Styleable, ?&amp;gt;&amp;gt; getClassCssMetaData()</code> method that build/linux-x86_64-normal-server-release/images/docs/api/index-files/index-10.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/index-files/index-18.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/org/w3c/dom/ls/LSSerializer.html: entities (&amp;gt;, &amp;apos;, and &amp;quot;) might not be used, except build/linux-x86_64-normal-server-release/images/docs/api/org/w3c/dom/ls/LSSerializer.html: where needed (e.g. using &amp;gt; in cases such as ']]&gt;'). Any $ grep -r '&amp;lt;' build/linux-x86_64-normal-server-release/images/docs/api build/linux-x86_64-normal-server-release/images/docs/api/java/io/class-use/IOException.html: &lt; to &amp;lt;.</div> build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/value/class-use/ObservableValue.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/value/class-use/ObservableValue.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/value/class-use/WritableValue.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/JavaBeanProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/ReadOnlyJavaBeanProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/package-use.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/package-use.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/class-use/ReadOnlyJavaBeanProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/package-summary.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/adapter/package-summary.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/class-use/ReadOnlyProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/class-use/ReadOnlyProperty.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/property/class-use/Property.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/class-use/Observable.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/beans/class-use/Observable.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/javafx/css/StyleablePropertyFactory.html: StyleableProperty&amp;lt;Orientation&amp;gt; orientation = build/linux-x86_64-normal-server-release/images/docs/api/javafx/css/converter/URLConverter.html: The input value is in the form: <code>url("&amp;lt;path&amp;gt;")</code>.</div> build/linux-x86_64-normal-server-release/images/docs/api/javafx/css/ParsedValue.html: the parser creates a <code>ParsedValue&amp;lt;String,Color&amp;gt;</code> when it parses a build/linux-x86_64-normal-server-release/images/docs/api/javafx/css/package-summary.html: <code>public static List&amp;lt;CssMetaData&amp;lt;? extends Styleable, ?&amp;gt;&amp;gt; getClassCssMetaData()</code> method that build/linux-x86_64-normal-server-release/images/docs/api/javax/swing/text/html/HTMLWriter.html: &lt; to &amp;lt;.</div> build/linux-x86_64-normal-server-release/images/docs/api/javax/swing/text/html/HTMLWriter.html: &lt; to &amp;lt;. <code>super.output</code> will be invoked to build/linux-x86_64-normal-server-release/images/docs/api/index-files/index-10.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/index-files/index-18.html:<div class="block"><code>JavaBeanProperty&amp;lt;T&amp;gt;</code> is the super interface of all adapters between build/linux-x86_64-normal-server-release/images/docs/api/index-files/index-15.html: &lt; to &amp;lt;.</div> build/linux-x86_64-normal-server-release/images/docs/api/org/w3c/dom/Attr.html: <pre>"y&amp;lt;6"</pre> build/linux-x86_64-normal-server-release/images/docs/api/org/w3c/dom/Attr.html: <pre>"y&amp;lt;6"</pre> build/linux-x86_64-normal-server-release/images/docs/api/org/w3c/dom/ls/LSSerializer.html: the predefined entities &amp;lt; and &amp;amp;. The other predefined
08-05-2017
Dave Grieve found a couple more instances of visible &gt; and &lt; strings, so I'll scrub the docs looking for those and generate a new webrev.
08-05-2017
Webrev: http://cr.openjdk.java.net/~kcr/8177341/webrev.00/ This addresses the set of issues raised in this bug.
08-05-2017
While doing the above I found a few more minor, but related items: 1. javafx.beans.binding package description Missing a proper first introductory sentence. 2. Bindings class docs * missing the '@param <T>' tag 3. JavaBeanProperty, ReadOnlyJavaBeanProperty class docs * garbled text appears in description: '&lt;T&gt;' (it was meant to be <T> but better to just remove it) * '@param T' should be '@param <T>' 4. TransformationList class docs The following has an inconsistent verb tense, a misspelled word (it's), and is a bit awkward: A base class for all lists that wraps other lists in a way that changes the list's elements, order, size or generally it's structure I will reword as: A base class for all lists that wrap another list in a way that changes (transforms) the wrapped list's elements, order, size, or structure.
08-05-2017
Another change, recommended by Alex Buckley, regarding Application.java and FXML.java (and any other place this might crop up) is to refer to module-info.java rather than .class and to not mention Module#addExports or #addOpens -- the focus should be on ordinary source code. This will make the docs more straight-forward. This will affect the docs for the Application class (the FXML class, which previously had the same problem was fixed as part of JDK-8177566).
08-05-2017
The following three packages are missing a package summary: javafx.base: javafx.beans.property.adapter javafx.collections.transformation javafx.graphics: javafx.css.converter
04-05-2017
Here is one more: > KeyEvent has two constructors, with identical descriptions. Both say: > > Constructs new KeyEvent event with null source and target and KeyCode object directly specified. > > This despite the fact that one of the constructors allows the source and target to be specified.
24-04-2017
> Another tiny one: > > http://download.java.net/java/jdk9/jfxdocs/javafx/beans/package-summary.html > > For WeakListener: > > WeakListener is the super interface of all weak listener implementations JavaFX runtime.
04-04-2017
Here are a couple more: > In RadialGradient, look for "follwing", in getCycleMethod. > > Also, the class-level doc says, "by default, proportional is true", but both constructors take a `proportional` arg, so there would not seem to be a default.
03-04-2017
Here are two more issues that I will fix as part of this bug: JDK-8177351 - Bad first sentence in doc for Timeline JDK-8177379 - Dialog API javadoc close() and hide() methods description are backwards
22-03-2017
We can use this bug to track any additional typos that might be found. I'll wait for a couple weeks then fix the ones found thus far.
21-03-2017