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

Documentation of WINDOW_STATE_CHANGED incomplete

    Details

      Description

      A DESCRIPTION OF THE PROBLEM :
      The WINDOW_STATE_CHANGED descriptions says:

      "This event is delivered when a Window's state is changed by virtue of it being iconified, maximized etc."

      The 'etc.' indicates that the reader is expected to be able to fill in the omitted details by himself, using the 'iconified, maximized' words as clues. However, this means this particular event type is likely to be interpreted differently by different users of different knowledge.

      It is normally the task of documentation to remove such 'interpretation is left largely to reader', as this has imponderable ambiguities, and is likely to lead to support issues. Instead ensure that interpretation is exact and complete.

      Basically, I suggest you remove the 'etc.' and instead provide all situations where windows state is changed. If this is platform-dependent, or even L&F dependent, it needs to be documented as such, and references to more relevant platform-documentation provided.


        Attachments

          Activity

            People

            • Assignee:
              serb Sergey Bylokhov
              Reporter:
              webbuggrp Webbug Group
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated: