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

JavaDoc for JComboBox constructor has grammatical error: "it's" should be "its"

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 5.0
    • 1.4.1
    • docs
    • tiger
    • sparc
    • solaris_9



      Name: gm110360 Date: 02/09/2003


      FULL PRODUCT VERSION :
      This is not a runtime issue. The grammar error is visible on the Sun website.
      That would appear to be the JavaDoc for J2SE version 1.4.1.

      http://java.sun.com/j2se/1.4.1/docs/api/index.html



      FULL OPERATING SYSTEM VERSION :
      Not applicable.

      ADDITIONAL OPERATING SYSTEMS :
      Not applicable.

      A DESCRIPTION OF THE PROBLEM :
      The JavaDoc for the "JComboBox( ComboBoxModel model )"
      constructor is not correct English, assuming that English is
      what the author was trying to write.

      The description reads:
      Creates a JComboBox that takes it's items from an existing
      ComboBoxModel.

      The word "it's" should be replaced by "its". "It's" is a
      contraction for "it is"; try reading the sentence using "it
      is" in place of "it's" and you'll see that what the author
      intended to use was the possessive word "its". Thank you.

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      1. Go to Sun-hosted JavaDoc at
      http://java.sun.com/j2se/1.4.1/docs/api/index.html
      2. Click on JavaDoc for JComboBox.
      3. Note the error.

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      I thought I would see the word "its" but, alas, I saw "it's"
      instead. It's a common mistake (no pun intended).

      ERROR MESSAGES/STACK TRACES THAT OCCUR :
      I believe the exception occured somewhere in my brain's left hemisphere,
      possibly in Broca's Area, as studies have shown a connection between damage to
      this area (Broca's Aphasia) and an inability to use short "linking" words.

      REPRODUCIBILITY :
      This bug can be reproduced always.

      ---------- BEGIN SOURCE ----------
      import java.net.*;
      import java.io.IOException;
      import javax.swing.*;


      public class JComboBoxDocTest {
          public static void main( String[] args ) throws IOException, MalformedURLExc
      eption {
              JFrame frame = new JFrame( "JComboBox" );
              frame.setSize( new java.awt.Dimension( 600, 400 ) );
              frame.getContentPane().add( new JScrollPane( new JEditorPane(
                  new URL(
      "http://java.sun.com/j2se/1.4.1/docs/api/javax/swing/JComboBox.html" ) ) ) );
              frame.setVisible( true );
          }
      }

      ---------- END SOURCE ----------

      CUSTOMER WORKAROUND :
      Unpack src.jar and fix the error, then generate your own
      javadoc. Alternatively, crack Sun's website and fix the error.
      (Review ID: 181028)
      ======================================================================

            sharonz Sharon Zakhour (Inactive)
            gmanwanisunw Girish Manwani (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: