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

Bad HTML tag in javadoc comment for Socket.setTcpNoDelay()

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 1.4.0
    • 1.3.0
    • docs
    • beta2
    • generic
    • generic



      Name: skT45625 Date: 04/17/2000


      I was running jdk 1.3rc2 - I've already uninstalled it
      so I can't do this step.


      javadoc comment for java.net.Socket method setTcpNoDelay() has a
      misspelled </code> tag which causes all the following javadoc
      documentation for Socket to appear in <code> font for the remaining
      methods. From the source code, you can see there is a </coder>
      tag instead of </code> :

          /**
           * Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).
           *
           * @param on <code>true</code> to enable TCP_NODELAY,
           * <code>false</coder> to disable.
           *
           * @exception SocketException if there is an error
           * in the underlying protocol, such as a TCP error.
           *
           * @since JDK1.1
           *
           * @see #getTcpNoDelay()
           */
          public void setTcpNoDelay(boolean on) throws SocketException {
              impl.setOption(SocketOptions.TCP_NODELAY, new Boolean(on));
          }
      (Review ID: 103732)
      ======================================================================

      Name: skT45625 Date: 05/11/2000


      java version "1.3.0"
      Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.0-C)
      Java HotSpot(TM) Client VM (build 1.3.0-C, mixed mode)


      Note the use of </coder> rather than </code> in the following documentation
      for Socket.setTcpNoDelay. This causes all subsequent documentation to use
      an incorrect font.

          /**
           * Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).
           *
           * @param on <code>true</code> to enable TCP_NODELAY,
           * <code>false</coder> to disable.
           *
           * @exception SocketException if there is an error
           * in the underlying protocol, such as a TCP error.
           *
           * @since JDK1.1
           *
           * @see #getTcpNoDelay()
           */
          public void setTcpNoDelay(boolean on) throws SocketException {
      impl.setOption(SocketOptions.TCP_NODELAY, new Boolean(on));
          }
      (Review ID: 104764)
      ======================================================================

            shommel Scott Hommel (Inactive)
            skondamasunw Suresh Kondamareddy (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: