doc: clarify factory methods for net.Socket
authorKevin Simper <kevin.simper@gmail.com>
Sun, 3 Aug 2014 00:27:02 +0000 (02:27 +0200)
committerTimothy J Fontaine <tjfontaine@gmail.com>
Wed, 6 Aug 2014 21:46:18 +0000 (14:46 -0700)
doc/api/net.markdown

index 7d23b68..f7f044d 100644 (file)
@@ -53,9 +53,13 @@ Use `nc` to connect to a UNIX domain socket server:
 ## net.connect(options, [connectionListener])
 ## net.createConnection(options, [connectionListener])
 
-Constructs a new socket object and opens the socket to the given location.
+A factory method, which returns a new ['net.Socket'](#net_class_net_socket)
+and connects to the supplied address and port.
+
 When the socket is established, the ['connect'][] event will be emitted.
 
+Has the same events as ['net.Socket'](#net_class_net_socket).
+
 For TCP sockets, `options` argument should be an object which specifies:
 
   - `port`: Port the client should connect to (Required).
@@ -106,6 +110,8 @@ Creates a TCP connection to `port` on `host`. If `host` is omitted,
 The `connectListener` parameter will be added as an listener for the
 ['connect'][] event.
 
+Is a factory method which returns a new ['net.Socket'](#net_class_net_socket).
+
 ## net.connect(path, [connectListener])
 ## net.createConnection(path, [connectListener])
 
@@ -113,6 +119,8 @@ Creates unix socket connection to `path`.
 The `connectListener` parameter will be added as an listener for the
 ['connect'][] event.
 
+A factory method which returns a new ['net.Socket'](#net_class_net_socket).
+
 ## Class: net.Server
 
 This class is used to create a TCP or UNIX server.