Corrections for Javadoc

Nir Lisker nlisker at gmail.com
Tue May 16 19:07:06 UTC 2017


Another thing:

javafx.scene.canvas.GraphicsContext should have a link to Canvas, either in
the first sentence or as a @see, or both.

On Fri, May 12, 2017 at 12:02 AM, Kevin Rushforth <
kevin.rushforth at oracle.com> wrote:

> Added. This is a questionable use of @see anyway.
>
> Thanks.
>
> -- Kevin
>
>
> Nir Lisker wrote:
>
> Add this to the list as well please:
>
> javafx.scene.image.Image's constructors:
>
> - Image(String url)
> - Image(String url, boolean backgroundLoading)
> - Image(String url, double requestedWidth, double requestedHeight, boolean
> preserveRatio, boolean smooth)
>
> all have a @see annotation pointing to a private constructor. This makes
> the link in the generated docs do nothing.
>
> On Wed, May 10, 2017 at 7:25 PM, Kevin Rushforth <
> kevin.rushforth at oracle.com> wrote:
>
>> I just filed a new issue to catch any last minute typos:
>>
>> https://bugs.openjdk.java.net/browse/JDK-8180070
>>
>> I'll add your note to this new JBS bug.
>>
>> Thank you.
>>
>> -- Kevin
>>
>>
>>
>>
>> Nir Lisker wrote:
>>
>>> I'm looking at build 168 of JDK9 and there are a few mistakes in the
>>> docs.
>>> I can't submit issues to the JIRA so I'll list them here. A similar issue
>>> was https://bugs.openjdk.java.net/browse/JDK-8177341.
>>>
>>>
>>>    - The following use "a Observable..." instead of "an Observable...".
>>>    - javafx.beans.property
>>>          - ListProperty<E>
>>>          - MapProperty<K,V>
>>>          - ReadOnlyListPropertyBase<E>
>>>          - SetProperty<E>
>>>       - javafx.beans.binding
>>>          - NumberExpression
>>>          - BooleanExpression
>>>          - DoubleExpression
>>>          - FloatExpression
>>>          - IntegerExpression
>>>          - ListExpression
>>>          - LongExpression
>>>          - MapExpression
>>>          - ObjectExpression
>>>          - SetExpression
>>>          - StringExpression
>>>          - javafx.scene.shape.ObservableFaceArray copies its description
>>>    from its superinteface ObservableIntegerArray, does not declare any
>>> API
>>>    methods and is listed under package javafx.scene.shape. It's not
>>> clear at
>>>    all what this interface is. As it is, it looks like it's not meant to
>>> be
>>>    exposed.
>>>    - javafx.collections.ObservableIntegerArray uses "a int[]" instead of
>>>    "an int[]". This writing ("a int") is found in java.lang.Integer as
>>> well in
>>>    a few places.
>>>
>>> Nir
>>>
>>>
>>
>


More information about the openjfx-dev mailing list