From e2c044e0fe6edf4a78b32e41a0248edc6446d552 Mon Sep 17 00:00:00 2001
From: Sebastian Martinez <sebastian@wyeworks.com>
Date: Fri, 13 May 2011 09:25:53 -0300
Subject: [PATCH] Add some docs to IPSocket

---
 lib/ipaddr.rb |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/lib/ipaddr.rb b/lib/ipaddr.rb
index 226a996..2186ad4 100644
--- a/lib/ipaddr.rb
+++ b/lib/ipaddr.rb
@@ -23,6 +23,7 @@ unless Socket.const_defined? "AF_INET6"
   end
 
   class << IPSocket
+    # Returns +true+ if addr is a valid IPv4 address.
     def valid_v4?(addr)
       if /\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/ =~ addr
         return $~.captures.all? {|i| i.to_i < 256}
@@ -30,6 +31,7 @@ unless Socket.const_defined? "AF_INET6"
       return false
     end
 
+    # Returns +true+ if addr is a valid IPv6 address.
     def valid_v6?(addr)
       # IPv6 (normal)
       return true if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*\Z/ =~ addr
@@ -43,6 +45,7 @@ unless Socket.const_defined? "AF_INET6"
       false
     end
 
+    # Returns +true+ if addr is either a valid IPv4 or IPv6 address.
     def valid?(addr)
       valid_v4?(addr) || valid_v6?(addr)
     end
-- 
1.7.4.2