[前][次][番号順一覧][スレッド一覧]

ruby-changes:15130

From: akr <ko1@a...>
Date: Mon, 22 Mar 2010 09:49:19 +0900 (JST)
Subject: [ruby-changes:15130] Ruby:r27007 (trunk): update doc.

akr	2010-03-22 09:48:51 +0900 (Mon, 22 Mar 2010)

  New Revision: 27007

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=27007

  Log:
    update doc.

  Modified files:
    trunk/ext/socket/mkconstants.rb
    trunk/ext/socket/socket.c

Index: ext/socket/mkconstants.rb
===================================================================
--- ext/socket/mkconstants.rb	(revision 27006)
+++ ext/socket/mkconstants.rb	(revision 27007)
@@ -275,7 +275,13 @@
 <%= INTERN_DEFS.map {|vardef, gen_hash, decl, func| vardef }.join("\n") %>
 
 /*
- * Document-module: Socket::Constants
+ * Document-module: ::Socket::Constants
+ *
+ * Socket::Constants provides socket related constants.
+ * Following lists possible constants.
+ * If underlying platform doesn't define a constant,
+ * the corresponding Ruby constant is not defined.
+ *
  */
 static void
 init_constants(void)
Index: ext/socket/socket.c
===================================================================
--- ext/socket/socket.c	(revision 27006)
+++ ext/socket/socket.c	(revision 27007)
@@ -1784,10 +1784,11 @@
  *
  * Class +Socket+ provides access to the underlying operating system
  * socket implementations. It can be used to provide more operating system
- * specific functionality than the protocol-specific socket classes but at the
- * expense of greater complexity. In particular, the class handles addresses
- * using +struct+ sockaddr structures packed into Ruby strings, which can be
- * a joy to manipulate.
+ * specific functionality than the protocol-specific socket classes.
+ *
+ * The constants defined under Socket::Constants are also defined under Socket.
+ * For example, Socket::AF_INET is usable as well as Socket::Constants::AF_INET.
+ * See Socket::Constants for the list of constants.
  * 
  * === Exception Handling
  * Ruby's implementation of +Socket+ causes an exception to be raised

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]