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

doc.: undefined concepts and initial states in AbstractUndoableEdit

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 1.4.0
    • 1.2.0
    • docs
    • beta
    • generic
    • generic



      Name: rm29839 Date: 05/20/98


      1. The description of AbstractUndoableEdit (see
      http://java.sun.com/products/jdk/1.2/docs/api/java.awt.swing.undo.AbstractUndoableEdit.html )
      refers to hasBeenDone, but neither specifies what
      it is nor specifies its initial state.

      2. Similarly, it refers to the liveness, or
      deadness, or "killedness" of an edit, but never
      specifies that a edit has such a state variable,
      and never specifies that initial value.

      Yes, I can tell what you meant this time, but
      Sun has really got to specify things less
      ambiguously.

      You might not want to use four different words
      when talking about a single concept. (The method
      description of die (#1) talks about a state
      variable named "alive" (#2), talks about dead (#3)
      edits, and talks about when an edit it killed (#4).

      It's true that the metaphor is consistent, but since
      you've never defined what aliveness of an edit means,
      using four different words is even more likely to
      confuse non-native English speakers.
      (Review ID: 28793)
      ======================================================================

            sharonz Sharon Zakhour (Inactive)
            rmandelsunw Ronan Mandel (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: