Add some documentation to the ADSI functions

Author: OJ

lib/rex/post/meterpreter/extensions/extapi/adsi/adsi.rb

@@ -60,6 +60,16 @@ def domain_query(domain_name, filter, max_results, page_size, fields)
 
 protected
 
+  #
+  # Retrieve the results of the query from the response
+  #   packet that was returned from Meterpreter.
+  #
+  # @param response [Packet] Reference to the received
+  #   packet that was returned from Meterpreter.
+  #
+  # @return [Array[Array[[Hash]]] Collection of results from
+  #   the ADSI query.
+  #
   def extract_results(response)
     results = []
 
@@ -70,6 +80,15 @@ def extract_results(response)
     results
   end
 
+  #
+  # Extract a single row of results from a TLV group.
+  #
+  # @param tlv_container [Packet] Reference to the TLV
+  #   group to pull the values from.
+  #
+  # @return [Array[Hash]] Collection of values from
+  #   the single ADSI query result row.
+  #
   def extract_values(tlv_container)
     values = []
     tlv_container.get_tlvs(TLV_TYPE_ANY).each do |v|
@@ -78,6 +97,14 @@ def extract_values(tlv_container)
     values
   end
 
+  #
+  # Convert a single ADSI result value into a usable
+  #   value that also describes its type.
+  #
+  # @param v [TLV] The TLV item that contains the value.
+  #
+  # @return [Hash] The type/value pair from the TLV.
+  #
   def extract_value(v)
     value = {
       :type => :unknown

lib/rex/post/meterpreter/ui/console/command_dispatcher/extapi/adsi.rb

@@ -191,6 +191,14 @@ def cmd_adsi_domain_query(*args)
 
 protected
 
+  #
+  # Convert an ADSI result row to a table row so that it can
+  #   be rendered to screen appropriately.
+  #
+  # @param result [Array[Hash]] Array of type/value pairs.
+  #
+  # @return [Array[String]] Renderable view of the value.
+  #
   def to_table_row(result)
     values = []