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/basicsocket.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

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

diff --git a/ext/socket/basicsocket.c b/ext/socket/basicsocket.c
index aa99041664..b997043620 100644
--- a/ext/socket/basicsocket.c
+++ b/ext/socket/basicsocket.c
@@ -732,12 +732,14 @@ bsock_do_not_rev_lookup_set(VALUE self, VALUE val)
     return val;
 }
 
-/*
- * BasicSocket is the super class for the all socket classes.
- */
 void
 rsock_init_basicsocket(void)
 {
+    /*
+     * Document-class: BasicSocket < IO
+     *
+     * BasicSocket is the super class for all the Socket classes.
+     */
     rb_cBasicSocket = rb_define_class("BasicSocket", rb_cIO);
     rb_undef_method(rb_cBasicSocket, "initialize");
 
-- 
cgit v1.2.3