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

ruby-changes:19642

From: drbrain <ko1@a...>
Date: Sun, 22 May 2011 11:22:02 +0900 (JST)
Subject: [ruby-changes:19642] drbrain:r31686 (trunk): * lib/ipaddr.rb: Improve documentation. Patch by Sandor Szucs.

drbrain	2011-05-22 11:21:56 +0900 (Sun, 22 May 2011)

  New Revision: 31686

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

  Log:
    * lib/ipaddr.rb:  Improve documentation.  Patch by Sandor Szucs.
      [Ruby 1.9 - Bug #4753]

  Modified files:
    trunk/ChangeLog
    trunk/lib/ipaddr.rb

Index: ChangeLog
===================================================================
--- ChangeLog	(revision 31685)
+++ ChangeLog	(revision 31686)
@@ -1,3 +1,8 @@
+Sun May 22 11:21:41 2011  Eric Hodel  <drbrain@s...>
+
+	* lib/ipaddr.rb:  Improve documentation.  Patch by Sandor Szucs.
+	  [Ruby 1.9 - Bug #4753]
+
 Sun May 22 11:14:40 2011  Eric Hodel  <drbrain@s...>
 
 	* lib/forwardable.rb:  Document def_delegator.  Patch by Sandor Szucs.
Index: lib/ipaddr.rb
===================================================================
--- lib/ipaddr.rb	(revision 31685)
+++ lib/ipaddr.rb	(revision 31686)
@@ -19,6 +19,7 @@
 
 unless Socket.const_defined? "AF_INET6"
   class Socket < BasicSocket
+    # IPv6 protocol family
     AF_INET6 = Object.new
   end
 
@@ -51,6 +52,14 @@
     end
 
     alias getaddress_orig getaddress
+
+    # Returns a +String+ based representation of a valid DNS hostname,
+    # IPv4 or IPv6 address.
+    # 
+    #   IPSocket.getaddress 'localhost'         #=> "::1"
+    #   IPSocket.getaddress 'broadcasthost'     #=> "255.255.255.255"
+    #   IPSocket.getaddress 'www.ruby-lang.org' #=> "221.186.184.68"
+    #   IPSocket.getaddress 'www.ccc.de'        #=> "2a00:1328:e102:ccc0::122"
     def getaddress(s)
       if valid?(s)
         s
@@ -86,8 +95,11 @@
 
 class IPAddr
 
+  # 32 bit mask for IPv4
   IN4MASK = 0xffffffff
+  # 128 bit mask for IPv4
   IN6MASK = 0xffffffffffffffffffffffffffffffff
+  # Formatstring for IPv6
   IN6FORMAT = (["%.4x"] * 8).join(':')
 
   # Returns the address family of this IP address.
@@ -377,6 +389,9 @@
 
   protected
 
+  # Set +@addr+, the internal stored ip address, to given +addr+. The
+  # parameter +addr+ is validated using the first +family+ member,
+  # which is +Socket::AF_INET+ or +Socket::AF_INET6+.
   def set(addr, *family)
     case family[0] ? family[0] : @family
     when Socket::AF_INET
@@ -397,6 +412,7 @@
     return self
   end
 
+  # Set current netmask to given mask. 
   def mask!(mask)
     if mask.kind_of?(String)
       if mask =~ /^\d+$/

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

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