Move Example so RDoc picks it up.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@10674 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
lann · Aug 4, 2006 · e2c017a · e2c017a
1 parent 47cc055
commit e2c017a
Showing 1 changed file with 22 additions and 23 deletions.
diff --git a/lib/ipaddr.rb b/lib/ipaddr.rb
@@ -7,29 +7,9 @@
 # You can redistribute and/or modify it under the same terms as Ruby.
 #
 # $Id$
-#--
+#
 # TODO:
 #   - scope_id support
-#++
-#
-#== Example
-#
-#   require 'ipaddr'
-#   
-#   ipaddr1 = IPAddr.new "3ffe:505:2::1"
-#   
-#   p ipaddr1			#=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>
-#   
-#   p ipaddr1.to_s		#=> "3ffe:505:2::1"
-#   
-#   ipaddr2 = ipaddr1.mask(48)	#=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0000/ffff:ffff:ffff:0000:0000:0000:0000:0000>
-#   
-#   p ipaddr2.to_s		#=> "3ffe:505:2::"
-#   
-#   ipaddr3 = IPAddr.new "192.168.2.0/24"
-#   
-#   p ipaddr3			#=> #<IPAddr: IPv4:192.168.2.0/255.255.255.0>
-
 require 'socket'
 
 unless Socket.const_defined? "AF_INET6"
@@ -75,8 +55,27 @@ def getaddress(s)
   end
 end
 
-# IPAddr provides a set of methods to manipulate an IP address.  Both
-# IPv4 and IPv6 are supported.
+# IPAddr provides a set of methods to manipulate an IP address.  Both IPv4 and
+# IPv6 are supported.
+#
+# == Example
+#
+#   require 'ipaddr'
+#   
+#   ipaddr1 = IPAddr.new "3ffe:505:2::1"
+#   
+#   p ipaddr1			#=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>
+#   
+#   p ipaddr1.to_s		#=> "3ffe:505:2::1"
+#   
+#   ipaddr2 = ipaddr1.mask(48)	#=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0000/ffff:ffff:ffff:0000:0000:0000:0000:0000>
+#   
+#   p ipaddr2.to_s		#=> "3ffe:505:2::"
+#   
+#   ipaddr3 = IPAddr.new "192.168.2.0/24"
+#   
+#   p ipaddr3			#=> #<IPAddr: IPv4:192.168.2.0/255.255.255.0>
+
 class IPAddr
 
   IN4MASK = 0xffffffff