From 38e4d877abee3c8e40edd932057e2bf16ad01e13 Mon Sep 17 00:00:00 2001
From: Patrick J Cherry <patrick@bytemark.co.uk>
Date: Fri, 16 Sep 2011 12:47:52 +0100
Subject: Big documentation update.

---
 lib/mauve/mauve_resolv.rb | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

(limited to 'lib/mauve/mauve_resolv.rb')

diff --git a/lib/mauve/mauve_resolv.rb b/lib/mauve/mauve_resolv.rb
index 6c97bef..c6460e3 100644
--- a/lib/mauve/mauve_resolv.rb
+++ b/lib/mauve/mauve_resolv.rb
@@ -1,12 +1,19 @@
 require 'resolv-replace'
 
-#
-#
-#
-
 module Mauve
+  #
+  # This is just a quick class to resolve a hostname to all its IPs, IPv6 and IPv4.
+  #
   class MauveResolv
+
     class << self
+
+      # Get all IPs for a host, both IPv6 and IPv4.  ResolvError and
+      # ResolvTimeout are both rescued.
+      #
+      # @param [String] host The hostname 
+      # @return [Array] Array of IP addresses, as Strings.
+      #
       def get_ips_for(host)
         record_types = %w(A AAAA)
         ips = []
@@ -25,6 +32,7 @@ module Mauve
         ips
       end
 
+      # @return [Log4r::Logger]
       def logger
         @logger ||= Log4r::Logger.new(self.to_s)
       end
-- 
cgit v1.2.1