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

Inet4Address class description first sentence is inappropriate

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P5 P5
    • 1.4.0
    • 1.4.0
    • docs
    • beta3
    • generic
    • generic



      Name: bsC130419 Date: 07/13/2001


      1.4beta documentation on Sun site as of 2001-07-13

      In the class description for java.net.Inet4Address, the first sentence is
      inappropriate.

      Look in http://java.sun.com/j2se/1.4/docs/api/java/net/package-summary.html
      for Inet4Address and notice how it says:

        Historically the IPv4 TTL field in the IP header has doubled as a multicast
        scope field: a TTL of 0 means node-local, 1 means link-local, up through 32
        means site-local, up through 64 means region-local, up through 128 means
        continent-local, and up through 255 are global.

      That doesn't tell the reader anything about what class Inet4Address represents
      or how it related to Inet6Address (which is undocumented, by the way) or
      how Inet4Address differs from InetAddress.


      (Have people who write documentation look at how their text shows up in the
      context of other things, e.g., that a summary sentence looks vaguely
      like its siblings.)

      (Review ID: 128074)
      ======================================================================

            shommel Scott Hommel (Inactive)
            bstrathesunw Bill Strathearn (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: