Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8194871

Fix mistakes in FX API docs

XMLWordPrintable

    • generic
    • generic

      FULL PRODUCT VERSION :
      openjdk version "10-internal" 2018-03-20
      OpenJDK Runtime Environment (build 10-internal+0-adhoc.Nir.jdk)
      OpenJDK 64-Bit Server VM (build 10-internal+0-adhoc.Nir.jdk, mixed mode)

      A DESCRIPTION OF THE PROBLEM :
      The following JavaDoc issues should be fixed:

      HBox#setHgrow:
      - "extra space will be split evening between them" evening -> evenly

      TableView:
      - "As mentioned, for this example, we'll be using a ObservableList<Person>." a -> an
      - "new PropertyValueFactory" and "new TableColumn" could have their generics inferred with <>.

      TextAreaSkin#getCaretBounds:
      - Empty description.

      TriangleMesh:
      - "Lastly, the term face is used to indicate 3 set of interleaving points" set -> sets

      Node:
      - "Coordinate System" and "Transformations" should use the same font as other titles.
      #boundsInParent:
      - Should mention Z transforms as well (or use a running variable like "i where i=x,y,z").
      #scale_:
      - "This is used to stretch or animate the node either manually or by using an animation." 'or animate' makes no sense. Maybe "or contract"? In 3D maybe "expand or shrink"?

      MatrixType#MT_2D_2x3 and 3x4:
      - Need a proper 1st sentence description.

      Parent#updateBounds:
      - Missing documentation.

      Animation#rate:
      - "Rate 1.0 is normal play, 2.0 is 2 time normal, -1.0 is backwards, etc..." etc... -> etc.
      - "The absolute value of rate indicates the speed which the Animation is to be played" which -> at which

      ObservableValue:
      - "( ObservableBooleanValue etc.)" extra space after (

      Bindings:
      - All "The ___ will hold ___, if" don't need a comma before 'if'.
      #equal​(ObservableObjectValue<?> op1, Object op2) and #equal​(Object op1, ObservableObjectValue<?> op2):
      - ObservableCharacterValue -> ObservableObjectValue

      FXCollections#emptyObservable___:
      - "Creates and empty" and -> an

      ListChangeListener.Change:
      - "from(inclusive) and to(exclusive)" missing spaces before (
      - "denotes the sublist of the list that contain new elements" contain -> contains

      ImageView#preserveRatio:
      - "in the following way *" remove *

      Timeline:
      - "Warning :" extra space before :

      Transition#getParentTargetNode:
      - Documentation is unclear. The `parent` is the parent of the animation (internal field in Animation), not of the node. Also 'if-else-otherwise' sentence is confusing at best.

      (Non-API)
      MouseEvent:
      - The class has a "// PENDING_DOC_REVIEW" comment. Hopefully it was reviewed by now...


      REPRODUCIBILITY :
      This bug can be reproduced always.

            kcr Kevin Rushforth
            webbuggrp Webbug Group
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: