From 86e01b1327d1629ebf63d86f55edf489d124156b Mon Sep 17 00:00:00 2001
From: soh_cah_toa <soh_cah_toa@cybercrud.net>
Date: Fri, 10 May 2013 23:19:58 -0400
Subject: [PATCH] Documented run_server() and add_rule().

---
 extensions/dns/dns.rb | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/extensions/dns/dns.rb b/extensions/dns/dns.rb
index b3ceaa642..3aaf19863 100644
--- a/extensions/dns/dns.rb
+++ b/extensions/dns/dns.rb
@@ -11,6 +11,10 @@ module DNS
 
     include Singleton
 
+    # Starts DNS server run-loop.
+    #
+    # @param address [String] interface address server should run on
+    # @param port [Integer] desired server port number
     def run_server(address, port)
       EventMachine::next_tick do
         RubyDNS::run_server(:listen => [[:udp, address, port]]) do
@@ -23,6 +27,11 @@ module DNS
       end
     end
 
+    # Adds a new DNS rule or "resource record". Does nothing if rule is already present.
+    #
+    # @param name [String] name of query
+    # @param type [String] query type (e.g. A, CNAME, MX, NS, etc.)
+    # @param value [String] response to send back to resolver
     def add_rule(name, type, value)
       catch(:match) do
         BeEF::Core::Models::DNS.each do |rule|