code review 8063043: net: update documentation for ListenTCP, ListenUDP

src/pkg/net/tcpsock_posix.go

 // Copyright 2009 The Go Authors.  All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
 // +build darwin freebsd linux netbsd openbsd windows
 
 // TCP sockets
 
 package net
 
@@ skipping 254 matching lines @@
                 return syscall.EINVAL
         }
         return setDeadline(l.fd, t)
 }
 
 // File returns a copy of the underlying os.File, set to blocking mode.
 // It is the caller's responsibility to close f when finished.
 // Closing l does not affect f, and closing f does not affect l.
 func (l *TCPListener) File() (f *os.File, err error) { return l.fd.dup() }
 
 // ListenTCP announces on the TCP address laddr and returns a TCP

[dave_cheney.net, 2013/03/28 03:39:59]

please see tcpsock_plan9.go

-// listener.  The net must be "tcp", "tcp4", or "tcp6".  If laddr has
-// a port of 0, it means to listen on some available port.  The caller
-// can use Addr method on TCPListener to retrieve the chosen address.
+// listener.  Net must be "tcp", "tcp4", or "tcp6".  If laddr has a
+// port of 0, ListenTCP will choose an available port.  The caller can
+// use the Addr method of TCPListener to retrieve the chosen address.
 func ListenTCP(net string, laddr *TCPAddr) (*TCPListener, error) {
         switch net {
         case "tcp", "tcp4", "tcp6":
         default:
                 return nil, UnknownNetworkError(net)
         }
         if laddr == nil {
                 laddr = &TCPAddr{}
         }
         fd, err := internetSocket(net, laddr.toAddr(), nil, noDeadline, syscall.SOCK_STREAM, 0, "listen", sockaddrToTCP)
         if err != nil {
                 return nil, err
         }
         err = syscall.Listen(fd.sysfd, listenerBacklog)
         if err != nil {
                 closesocket(fd.sysfd)
                 return nil, &OpError{"listen", net, laddr, err}
         }
         return &TCPListener{fd}, nil
 }