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

Incorrect parameter list in method description

    XMLWordPrintable

Details

    • Bug
    • Resolution: Duplicate
    • P4
    • None
    • 1.2.0
    • client-libs

    Description

      Name: vi73552 Date: 03/01/99


      The following is the description of a method of BorderFactory from the on-line doco:

      createTitledBorder

      public static TitledBorder createTitledBorder(Border border)

          Create a new title border with an empty title specifying the border object, using the default
          text position (sitting on the top line) and default justification (left) and using the default font,
          text color, and edge determined by the current look and feel. (The Motif look and feel uses
          an etched border edge. The Windows and the Java look and feel use a gray edge.)
          Parameters:
              title - a String containing the text of the title
          Returns:
              the TitledBorder object

      Note three problems with this description...

      1. The argument shown in the definition is incorrect. The correct argument list should be:
      createTitledBorder(String title)

      2. The description says the title will be empty, when in fact it will be the value provided as the argument.

      3. At least the Window L&F (and possibly the Java one) actually show an etched border rather than a grey one.
      (Review ID: 53934)
      ======================================================================

      Attachments

        Issue Links

          Activity

            People

              shickeysunw Shannon Hickey (Inactive)
              vasya Vassili Igouchkine (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: