From 12979424515344460afb12002ce07b670bf7cd6f Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 15 Aug 2011 23:08:39 +0000
Subject: * ext/socket:  Make Socket documentation appear.  Add documentation
 for   Socket, TCPServer, SOCKSSocket.  Patch by Sylvain Daubert.   [Ruby 1.9
 - Feature #5182]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32977 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 ext/socket/sockssocket.c | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

(limited to 'ext/socket/sockssocket.c')

diff --git a/ext/socket/sockssocket.c b/ext/socket/sockssocket.c
index cbe8792271..48be4fcf99 100644
--- a/ext/socket/sockssocket.c
+++ b/ext/socket/sockssocket.c
@@ -11,6 +11,13 @@
 #include "rubysocket.h"
 
 #ifdef SOCKS
+/*
+ * call-seq:
+ *   SOCKSSocket.new(host, serv) => socket
+ *
+ * Opens a SOCKS connection to +host+ via the SOCKS server +serv+.
+ *
+ */
 static VALUE
 socks_init(VALUE sock, VALUE host, VALUE serv)
 {
@@ -25,6 +32,10 @@ socks_init(VALUE sock, VALUE host, VALUE serv)
 }
 
 #ifdef SOCKS5
+/*
+ * Closes the SOCKS connection.
+ *
+ */
 static VALUE
 socks_s_close(VALUE sock)
 {
@@ -40,15 +51,17 @@ socks_s_close(VALUE sock)
 #endif
 #endif
 
-/*
- * Document-class: ::SOCKSSocket < TCPSocket
- *
- * SOCKSSocket class
- */
 void
 rsock_init_sockssocket(void)
 {
 #ifdef SOCKS
+    /*
+     * Document-class: SOCKSSocket < TCPSocket
+     *
+     * SOCKS is an Internet protocol that routes packets between a client and
+     * a server through a proxy server.  SOCKS5, if supported, additionally
+     * provides authentication so only authorized users may access a server.
+     */
     rb_cSOCKSSocket = rb_define_class("SOCKSSocket", rb_cTCPSocket);
     rb_define_method(rb_cSOCKSSocket, "initialize", socks_init, 2);
 #ifdef SOCKS5
-- 
cgit v1.2.3