socket.c: a rdoc patch from Daniel Berger <djberg96 at gmail.com>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@11039 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 8 insertions, 0 deletions

diff --git a/ext/socket/socket.c b/ext/socket/socket.c
index d5a3593fa7..acb8cdf7d4 100644
--- a/ext/socket/socket.c
+++ b/ext/socket/socket.c
@@ -1289,6 +1289,14 @@ init_inetsock(VALUE sock, VALUE remote_host, VALUE remote_serv,
 		     inetsock_cleanup, (VALUE)&arg);
 }
 
+/*
+ * call-seq:
+ *    TCPSocket.new(remote_host, remote_port, local_host=nil, local_port=nil)
+ *
+ * Opens a TCP connection to +remote_host+ on +remote_port+.  If +local_host+
+ * and +local_port+ are specified, then those parameters are used on the local
+ * end to establish the connection.
+ */
 static VALUE
 tcp_init(int argc, VALUE *argv, VALUE sock)
 {