awetestlib 0.1.5 → 0.1.6

data/awetestlib.windows.gemspec

@@ -31,8 +31,9 @@ Gem::Specification.new do |s|
   s.add_dependency('selenium-webdriver')
   s.add_dependency('pry')
   s.add_dependency('rdoc', '~> 3.11')
+  s.add_dependency('yard')
 
-
+  s.has_rdoc = 'yard'
   s.require_paths = ["lib"]
   s.files = `git ls-files`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/awetestlib/regression/runner.rb

@@ -44,7 +44,11 @@ module Awetestlib
       ::PASS = '-PASS'
       ::FAIL = '-FAIL'
 
-      attr_accessor :browser, :browser_abbrev, :version, :env,
+      # @return [Watir::Browser] the browser referenced by the attribute browser
+      attr_accessor :browser
+      # @return [String] abbreviation for the targeted browser (e.g., IE, FF, GC)
+      attr_accessor :browser_abbrev
+      attr_accessor :version, :env,
                     :library, :script_type, :script_file,
                     :log_properties, :log_queue, :log_class,
                     :notify_queue, :notify_class, :notify_id,
@@ -160,6 +164,7 @@ module Awetestlib
         options.each_pair do |k, v|
           self.send("#{k}=", v)
         end
+        script_file = options[:script_file]
         load script_file
         setup_global_test_vars(options)
 

data/lib/awetestlib/regression/tables.rb

@@ -2,19 +2,44 @@ module Awetestlib
   module Regression
     module Tables
 
-      def get_index_for_column_head(panel, table_index, strg)
+      def get_index_for_column_head(panel, table_index, strg, desc = '')
+        table = panel.tables[table_index]
+        get_column_index(table, strg, desc, true)
+      end
+
+      def get_column_index(table, strg, desc = '', header = false)
+        msg = "Get index of "
+        msg << " header" if header
+        msg << " column containing #{strg}. "
+        msg << " #{desc}" if desc.length > 0
         rgx = Regexp.new(strg)
-        panel.tables[table_index].each do |row|
+        row_idx = 0
+        index   = -1
+        found   = false
+        table.each do |row|
+          row_idx += 1
           if row.text =~ rgx
-            index = 1
+            col_idx = 1
             row.each do |cell|
               if cell.text =~ rgx
-                return index
+                index = col_idx
+                found = true
+                break
               end
-              index += 1
+              col_idx += 1
             end
           end
+          break if found or header
+        end
+        if found
+          passed_to_log("#{msg} at index #{index}.")
+          index
+        else
+          failed_to_log("#{msg}")
+          nil
         end
+      rescue
+        failed_to_log("Unable to #{msg} '#{$!}'")
       end
 
       def get_index_of_last_row(table, pad = 2, every = 1)

data/lib/awetestlib/regression/user_input.rb

@@ -2,36 +2,28 @@ module Awetestlib
   module Regression
     module UserInput
 
-=begin rdoc
-  :category: A_rdoc_test
-Click a specific DOM element by one of its attributes and that attribute's value.
-
-_Parameters_::
-
-*browser* - a reference to the browser window or container element to be tested
-
-*element* - the kind of element to click. Must be one of the elements recognized by Watir.
-Some common values are :link, :button, :image, :div, :span.
-
-*how* - the element attribute used to identify the specific element. Valid values depend on the kind of element.
-Common values: :text, :id, :title, :name, :class, :href (:link only)
-
-*what* - a string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
-
-*desc* - a string containing a message or description intended to appear in the log and/or report output
-
-_Example_
-
-  # html for a link element:
-  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
-  click(browser, :link, :text, 'Pickaxe')
-
-=end
-
+      # @!group Core
+
+      # Click a specific DOM element identified by one of its attributes and that attribute's value.
+      #
+      # @example
+      #  # html for a link element:
+      #  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
+      #
+      #  click(browser, :link, :text, 'Pickaxe')
+      #
+      # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.
+      # @param [Symbol] element The kind of element to click. Must be one of the elements recognized by Watir.
+      #   Some common values are :link, :button, :image, :div, :span.
+      # @param [Symbol] how The element attribute used to identify the specific element.
+      #   Valid values depend on the kind of element.
+      #   Common values: :text, :id, :title, :name, :class, :href (:link only)
+      # @param [String|Regexp] what A string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
+      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
+      #
       def click(browser, element, how, what, desc = '')
         #debug_to_log("#{__method__}: #{element}, #{how}, #{what}")
-        msg = "Click #{element} :#{how}=>'#{what}'"
-        msg << ", '#{desc}'" if desc.length > 0
+        msg = build_message("Click #{element} :#{how}=>'#{what}'", desc)
         msg1 = "#{element}(#{how}, '#{what}')"
         begin
           case element
@@ -66,38 +58,180 @@ _Example_
         failed_to_log("Unable to #{msg}. '#{$!}'")
       end
 
-=begin rdoc
-  :category: A_rdoc_test
-Click a specific DOM element by one of its attributes and that attribute's value and
-do not wait for the browser to finish reloading.  Used when a modal popup or alert is expected. Allows the script
-to keep running so the popup can be handled.
+      # @!endgroup Core
 
-_Parameters_::
+      # @!group Click
 
-*browser* - a reference to the browser window to be tested
+      # Click a button element identified by the value of its _id_ attribute. A button is an HTML element with tag 'input' and type 'submit' or 'button'.
+      # @param [Watir::Browser, Watir::Container] browser A reference to the browser window or container element to be tested.
+      # @param [String|Regexp] what A string or a regular expression to be found in the specified attribute that uniquely identifies the element.
+      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
+      #
+      def click_button_by_id(browser, what, desc = '')
+        click(browser, :button, :id, what, desc)
+      end
 
-*element* - the kind of element to click. Must be one of the elements recognized by Watir.
-Some common values are :link, :button, :image, :div, :span.
+      # Click a button element identified by the value of its index within the container referred to by <b>+browser+</b>.
+      # @param [Watir::Browser, Watir::Container] browser A reference to the browser window or container element to be tested.
+      # @param [Fixnum] what An integer that indicates the index of the element within the container.
+      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
+      def click_link_by_index(browser, what, desc = '')
+        click(browser, :link, :index, what, desc)
+      end
 
-*how* - the element attribute used to identify the specific element. Valid values depend on the kind of element.
-Common values: :text, :id, :title, :name, :class, :href (:link only)
+      # Click a link element identified by the value of its _href_ attribute. Take care to escape characters in the url that are reserved by Regexp.
+      # @param (see #click_button_by_id)
+      def click_link_by_href(browser, what, desc = '')
+        click(browser, :link, :href, what, desc)
+      end
 
-*what* - a string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
+      alias click_href click_link_by_href
 
-*desc* - a string containing a message or description intended to appear in the log and/or report output
+      # Click a link element identified by the value of its _href_ attribute and do not wait for the browser to reach ready state.
+      # Take care to escape characters in the url that are reserved by Regexp.
+      # @param (see #click_button_by_id)
+      def click_link_no_wait_by_href(browser, what, desc = '')
+        click_no_wait(browser, :link, :href, what, desc)
+      end
 
-_Example_
+      # Click a button element identified by the value of its index within the container referred to by <b>+browser+</b>.
+      # @param (see #click_link_by_index)
+      def click_button_by_index(browser, what, desc = '')
+        click(browser, :button, :index, what, desc)
+      end
 
-  # html for a link element:
-  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
-  click_no_wait(browser, :link, :text, 'Pickaxe')
+      # Click a button element identified by the value of its _name_ attribute. A button is an HTML element with tag 'input' and type 'submit' or 'button'.
+      # @param (see #click_button_by_id)
+      def click_button_by_name(browser, what, desc = '')
+        click(browser, :button, :name, what, desc)
+      end
 
-=end
+      # Click a button element identified by the value of its _text_ attribute. A button is an HTML element with tag 'input' and type 'submit' or 'button'.
+      # @param (see #click_button_by_id)
+      def click_button_by_text(browser, what, desc = '')
+        click(browser, :button, :text, what, desc)
+      end
+
+      # Click a button element identified by the value of its _class_ attribute. A button is an HTML element with tag 'input' and type 'submit' or 'button'.
+      # @param (see #click_button_by_id)
+      def click_button_by_class(browser, what, desc = '')
+        click(browser, :button, :class, what, desc)
+      end
+
+      # Click a button element identified by the value of its _value_ attribute. A button is an HTML element with tag 'input' and type 'submit' or 'button'.
+      # @param (see #click_button_by_id)
+      def click_button_by_value(browser, what, desc = '')
+        click(browser, :button, :value, what, desc)
+      end
+
+      # Click a button element identified by the value of its _title_ attribute. A button is an HTML element with tag 'input' and type 'submit' or 'button'.
+      # @param (see #click_button_by_id)
+      def click_button_by_title(browser, what, desc = '')
+        click(browser, :button, :title, what, desc)
+      end
+
+      # Click a link element identified by the value of its _id_ attribute.
+      # @param (see #click_button_by_id)
+      def click_link_by_id(browser, what, desc = '')
+        click(browser, :link, :id, what, desc)
+      end
+
+      alias click_id click_link_by_id
+
+      # Click a link element identified by the value of its _name_ attribute.
+      # @param (see #click_button_by_id)
+      def click_link_by_name(browser, what, desc = '')
+        click(browser, :link, :name, what, desc)
+      end
+
+      alias click_name click_link_by_name
+
+      # Click a file_field element identified by the value of its _id_ attribute.
+      # @param (see #click_button_by_id)
+      def click_file_field_by_id(browser, what, desc = '')
+        click(browser, :file_field, :id, what, desc)
+      end
+
+      # Click an image element identified by the value of its _id_ attribute.
+      # @param (see #click_button_by_id)
+      def click_img_by_alt(browser, what, desc = '')
+        click(browser, :image, :alt, what, desc)
+      end
+
+      # Click an image element identified by the value of its _title_ attribute.
+      # @param (see #click_button_by_id)
+      def click_img_by_title(browser, what, desc = '')
+        click(browser, :image, :title, what, desc)
+      end
+
+      # Click an image element identified by the value of its _src_ attribute.
+      # Take care to escape characters in the source url that are reserved by Regexp.
+      # @param (see #click_button_by_id)
+      def click_img_by_src(browser, what, desc = '')
+        click(browser, :image, :src, what, desc)
+      end
+
+      # Click a link element identified by the value of its _value_ attribute.
+      # @param (see #click_button_by_id)
+      def click_link_by_value(browser, what, desc = '')
+        click(browser, :link, :value, what, desc)
+      end
 
+      # Click a link element identified by the value in its text (innerHTML).
+      # @param (see #click_button_by_id)
+      def click_link_by_text(browser, what, desc = '')
+        click(browser, :link, :text, what, desc)
+      end
+
+      alias click_link click_link_by_text
+      alias click_text click_link_by_text
+      alias click_js_button click_link_by_text
+
+      # Click a link element identified by the value of its _class_ attribute.
+      # @param (see #click_button_by_id)
+      def click_link_by_class(browser, what, desc = '')
+        click(browser, :link, :class, what, desc)
+      end
+
+      alias click_class click_link_by_class
+
+      # Click a span element identified by the value in its text (innerHTML).
+      # @param (see #click_button_by_id)
+      def click_span_by_text(browser, what, desc = '')
+        click(browser, :span, :text, what)
+      end
+
+      alias click_span_with_text click_span_by_text
+
+      # Click a link element identified by the value of its _title_ attribute.
+      # @param (see #click_button_by_id)
+      def click_link_by_title(browser, what, desc = '')
+        click(browser, :link, :title, what, desc)
+      end
+
+      alias click_title click_link_by_title
+
+      # @!endgroup Click
+
+      # @!group Core
+
+      # Click a specific DOM element by one of its attributes and that attribute's value and
+      # do not wait for the browser to finish reloading.  Used when a modal popup or alert is expected. Allows the script
+      # to keep running so the popup can be handled.
+      #
+      # @example
+      #  # html for a link element:
+      #  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
+      #
+      #  click_no_wait(browser, :link, :text, 'Pickaxe')
+      #
+      # @see #click
+      #
+      # @param (see #click)
+      #
       def click_no_wait(browser, element, how, what, desc = '')
         debug_to_log("#{__method__}: #{element}, #{how}, #{what}")
-        msg = "Click no wait #{element} :#{how}=>'#{what}'"
-        msg << ", '#{desc}'" if desc.length > 0
+        msg = build_message("Click no wait #{element} :#{how}=>'#{what}'", desc)
         msg1 = "#{element}(#{how}, '#{what}'"
         begin
           case element
@@ -139,197 +273,172 @@ _Example_
         sleep_for(1)
       end
 
-    # :category: User Input
-      def click_button_by_id(browser, strg, desc = '')
-        click(browser, :button, :id, strg, desc)
-      end
+      # @!endgroup Core
 
-    # :category: User Input
-      def click_link_by_index(browser, strg, desc = '')
-        click(browser, :link, :index, strg, desc)
-      end
+      alias click_href_no_wait click_link_no_wait_by_href
 
-    # :category: User Input
-      def click_link_by_href(browser, strg, desc = '')
-        click(browser, :link, :href, strg, desc)
-      end
+      # @!group Click No Wait
 
-      alias click_href click_link_by_href
-    # :category: User Input
-      def click_link_no_wait_by_href(browser, strg, desc = '')
-        click_no_wait(browser, :link, :href, strg, desc)
+      # Click a button element identified by the value of its _id_ attribute
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_button_no_wait_by_id(browser, what, desc = '')
+        click_no_wait(browser, :button, :id, what, desc)
       end
 
-      alias click_href_no_wait click_link_no_wait_by_href
-    # :category: User Input
-      def click_button_by_index(browser, index, desc = '')
-        click(browser, :button, :index, index, desc)
+      alias click_button_by_id_no_wait click_button_no_wait_by_id
+
+      # Click a button element identified by the value of its _name_ attribute
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_button_no_wait_by_name(browser, what, desc = '')
+        click_no_wait(browser, :button, :name, what, desc)
       end
 
-    # :category: User Input
-      def click_button_by_name(browser, strg, desc = '')
-        click(browser, :button, :name, strg, desc)
+      # Click a button element identified by the value of its _class_ attribute
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_button_no_wait_by_class(browser, what, desc = '')
+        click_no_wait(browser, :button, :class, what, desc)
       end
 
-    # :category: User Input
-      def click_button_by_text(browser, strg, desc = '')
-        click(browser, :button, :text, strg, desc)
+      alias click_button_by_class_no_wait click_button_no_wait_by_class
+
+      # Click a link element identified by the value of its _id_ attribute
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_link_no_wait_by_id(browser, what, desc = '')
+        click_no_wait(browser, :link, :id, what, desc)
       end
 
-    # :category: User Input
-      def click_button_by_class(browser, strg, desc = '')
-        click(browser, :button, :class, strg, desc)
+      alias click_no_wait_id click_link_no_wait_by_id
+      alias click_no_wait_by_id click_link_no_wait_by_id
+      alias click_id_no_wait click_link_no_wait_by_id
+      alias click_no_wait_link_by_id click_link_no_wait_by_id
+
+      # Click an image element identified by the value of its _alt_ attribute
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_img_no_wait_by_alt(browser, what, desc = '')
+        click_no_wait(browser, :image, :alt, what, desc)
       end
 
-    # :category: User Input
-      def click_button_no_wait_by_id(browser, strg, desc = '')
-        click_no_wait(browser, :button, :id, strg, desc)
+      alias click_img_by_alt_no_wait click_img_no_wait_by_alt
+
+      # Click a button element identified by the value in its text (innerHTML)
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_button_no_wait_by_text(browser, what, desc = '')
+        click_no_wait(browser, :button, :text, what, desc)
       end
 
-      alias click_button_by_id_no_wait click_button_no_wait_by_id
-    # :category: User Input
-      def click_button_no_wait_by_name(browser, strg, desc = '')
-        click_no_wait(browser, :button, :name, strg, desc)
+      # Click a button element identified by the value of its _value_ attribute
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_button_no_wait_by_value(browser, what, desc = '')
+        click_no_wait(browser, :button, :value, what, desc)
       end
 
-    # :category: User Input
-      def click_button_no_wait_by_class(browser, strg, desc = '')
-        click_no_wait(browser, :button, :class, strg, desc)
+      # Click a button element identified by the value of its _name_ attribute
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_link_by_name_no_wait(browser, what, desc = '')
+        click_no_wait(browser, :link, :name, what, desc)
       end
 
-      alias click_button_by_class_no_wait click_button_no_wait_by_class
-    # :category: User Input
-      def click_button_by_value(browser, strg, desc = '')
-        click(browser, :button, :value, strg, desc)
+      alias click_no_wait_name click_link_by_name_no_wait
+      alias click_name_no_wait click_link_by_name_no_wait
+
+      # Click a link element identified by the value in its text (innerHTML)
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_link_by_text_no_wait(browser, what, desc = '')
+        click_no_wait(browser, :link, :text, what, desc)
       end
 
-    # :category: User Input
-      def click_button_by_title(browser, strg, desc = '')
-        click(browser, :button, :title, strg, desc)
+      alias click_no_wait_text click_link_by_text_no_wait
+      alias click_text_no_wait click_link_by_text_no_wait
+
+      # Click a link element identified by the value of its _title_ attribute
+      # and do not wait for the browser to reach ready state.
+      # @param (see #click_button_by_id)
+      def click_title_no_wait(browser, what, desc = '')
+        click_no_wait(browser, :link, :title, what, desc)
       end
 
-    # :category: User Input
-      def click_button_by_xpath_and_id(browser, strg, desc = '')
-        msg = "Click button by xpath and id '#{strg}' #{desc}"
-        if browser.button(:xpath, "//a[@id = '#{strg}']").click
+      # @!endgroup Click No Wait
+
+      # @!group Xpath
+
+      # Click a button element identified by the value of its _id_ attribute using the xpath functionality in Watir.
+      # A button is an HTML element with tag 'input' and type 'submit' or 'button'.
+      # @note Normally used only when the element is not located by other methods.
+      # @param (see #click_button_by_id)
+      def click_button_by_xpath_and_id(browser, what, desc = '')
+        msg = "Click button by xpath and id '#{what}' #{desc}"
+        if browser.button(:xpath, "//a[@id = '#{what}']").click
           passed_to_log(msg)
           true
         else
           failed_to_log(msg)
         end
       rescue
-        failed_to_log("Unable to click button by xpath and id '#{strg}' #{desc} '#{$!}' (#{__LINE__})")
+        failed_to_log("Unable to click button by xpath and id '#{what}' #{desc} '#{$!}' (#{__LINE__})")
       end
 
       alias click_button_by_xpath click_button_by_xpath_and_id
 
-=begin rdoc
-  :category: A_rdoc_test
-Click a link identified by the value in its id attribute.  Calls click()
-
-_Parameters_::
-
-*browser* - a reference to the browser window to be tested
-
-*strg* - a string or a regular expression to be found in the id  attribute that uniquely identifies the element.
-
-*desc* - a string containing a message or description intended to appear in the log and/or report output
-
-
-_Example_
-
-  # html for a link element:
-  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
-  click_link_by_text(browser, 'Pickaxe', 'Open the page for the Pickaxe book')
-
-=end
-
-      def click_link_by_id(browser, strg, desc = '')
-        click(browser, :link, :id, strg, desc)
-      end
-
-    # :category: A_rdoc_test
-      alias click_id click_link_by_id
-
-    # :category: User Input
-      def click_link_by_name(browser, strg, desc = '')
-        click(browser, :link, :name, strg, desc)
-      end
-
-      alias click_name click_link_by_name
-    # :category: User Input
-      def click_link_by_xpath_and_id(browser, strg, desc = '')
-        msg = "Click link by xpath and id '#{strg}' #{desc}"
-        if browser.link(:xpath, "//a[@id = '#{strg}']").click
+      # Click a link element identified by the value of its _id_ attribute using the xpath functionality in Watir.
+      # @note Normally used only when the element is not located by other methods.
+      # @param (see #click_button_by_id)
+      def click_link_by_xpath_and_id(browser, what, desc = '')
+        msg = "Click link by xpath and id '#{what}' #{desc}"
+        if browser.link(:xpath, "//a[@id = '#{what}']").click
           passed_to_log(msg)
           true
         else
           failed_to_log(msg)
         end
       rescue
-        failed_to_log("Unable click on link by xpath and id '#{strg}' #{desc} '#{$!}' (#{__LINE__})")
+        failed_to_log("Unable to #{msg} '#{$!}' (#{__LINE__})")
       end
 
       alias click_link_by_xpath click_link_by_xpath_and_id
 
-    # :category: User Input
-      def click_link_no_wait_by_id(browser, strg, desc = '')
-        click_no_wait(browser, :link, :id, strg, desc)
-      end
-
-      alias click_no_wait_id click_link_no_wait_by_id
-      alias click_no_wait_by_id click_link_no_wait_by_id
-      alias click_id_no_wait click_link_no_wait_by_id
-      alias click_no_wait_link_by_id click_link_no_wait_by_id
-
-    # :category: User Input
-      def click_file_field_by_id(browser, strg, desc = '')
-        click(browser, :file_field, :id, strg, desc)
-      end
-
-    # :category: User Input
-      def click_img_by_alt(browser, strg, desc = '')
-        click(browser, :image, :alt, strg, desc)
-      end
-
-    # :category: User Input
-      def click_img_by_title(browser, strg, desc = '')
-        click(browser, :image, :title, strg, desc)
-      end
-
-    # :category: User Input
-      def click_img_by_xpath_and_name(browser, strg, desc = '')
-        msg = "Click image by xpath where name='#{strg}' #{desc}"
-        if browser.link(:xpath, "//input[@name = '#{strg}']").click
+      # Click a link element identified by the value of its _id_ attribute using the xpath functionality in Watir.
+      # @note Normally used only when the element is not located by other methods.
+      # @param (see #click_button_by_id)
+      def click_img_by_xpath_and_name(browser, what, desc = '')
+        msg = "Click image by xpath where name='#{what}' #{desc}"
+        if browser.link(:xpath, "//input[@name = '#{what}']").click
           passed_to_log(msg)
           true
         else
           failed_to_log(msg)
         end
       rescue
-        failed_to_log("Unable to click image by xpath where name='#{strg}' #{desc} '#{$!}'")
+        failed_to_log("Unable to click image by xpath where name='#{what}' #{desc} '#{$!}'")
       end
 
       alias click_img_by_xpath click_img_by_xpath_and_name
       alias click_image_by_xpath click_img_by_xpath_and_name
       alias click_image_by_xpath_and_name click_img_by_xpath_and_name
 
-    # :category: User Input
-      def click_img_no_wait_by_alt(browser, strg, desc = '')
-        click_no_wait(browser, :image, :alt, strg, desc)
-      end
+      # @!endgroup Xpath
 
-      alias click_img_by_alt_no_wait click_img_no_wait_by_alt
-    # :category: User Input
-      def click_img_by_src(browser, strg, desc = '')
-        click(browser, :image, :src, strg, desc)
-      end
+      # @!group Core
 
-    # :category: User Input
-      def click_img_by_src_and_index(browser, strg, index, desc = '')
-        msg = "Click image by src='#{strg}' and index=#{index}"
+      # Click an image element identified by the value of its _src_ attribute and its index
+      # within the array of image elements with src containing <b>+what+</b> and
+      # within the container referred to by <b>+browser+</b>.
+      # @param [Watir::Browser, Watir::Container] browser A reference to the browser window or container element to be tested.
+      # @param [String|Regexp] what A string or a regular expression to be found in the specified attribute that uniquely identifies the element.
+      # @param [Fixnum] index An integer that indicates the index of the element within the array of image elements with src containing <b>+what+</b>.
+      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
+      def click_img_by_src_and_index(browser, what, index, desc = '')
+        msg = "Click image by src='#{what}' and index=#{index}"
         msg << " #{desc}" if desc.length > 0
-        browser.image(:src => strg, :index => index).click
+        browser.image(:src => what, :index => index).click
         if validate(browser, @myName, __LINE__)
           passed_to_log(msg)
           true
@@ -338,206 +447,122 @@ _Example_
         failed_to_log("Unable to #{msg} '#{$!}'")
       end
 
-    # :category: User Input
-      def click_link_by_value(browser, strg, desc = '')
-        click(browser, :link, :value, strg, desc)
-      end
-
-=begin rdoc
-  :category: A_rdoc_test
-Click a link identified by the value in its text attribute.  Calls click()
-
-_Parameters_::
-
-*browser* - a reference to the browser window to be tested
-
-*strg* - a string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
-
-*desc* - a string containing a message or description intended to appear in the log and/or report output
-
-
-_Example_
-
-  # html for a link element:
-  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
-  click_link_by_text(browser, 'Pickaxe', 'Open the page for the Pickaxe book')
-
-=end
-
-      def click_link_by_text(browser, strg, desc = '')
-        click(browser, :link, :text, strg, desc)
-      end
-
-      alias click_link click_link_by_text
-    # :category: A_rdoc_test
-      alias click_text click_link_by_text
-      alias click_js_button click_link_by_text
-
-    # :category: User Input
-      def click_link_by_class(browser, strg, desc = '')
-        click(browser, :link, :class, strg, desc)
-      end
-
-      alias click_class click_link_by_class
-
-    # :category: User Input
-      def click_button_no_wait_by_text(browser, strg, desc = '')
-        click_no_wait(browser, :button, :text, strg, desc)
-      end
-
-    # :category: User Input
-      def click_button_no_wait_by_value(browser, strg, desc = '')
-        click_no_wait(browser, :button, :value, strg, desc)
-      end
-
-    # :category: User Input
-      def click_link_by_name_no_wait(browser, strg, desc = '')
-        click_no_wait(browser, :link, :name, strg, desc)
-      end
-
-      alias click_no_wait_name click_link_by_name_no_wait
-      alias click_name_no_wait click_link_by_name_no_wait
-
-    # :category: User Input
-      def click_link_by_text_no_wait(browser, strg, desc = '')
-        click_no_wait(browser, :link, :text, strg, desc)
-      end
-
-      alias click_no_wait_text click_link_by_text_no_wait
-      alias click_text_no_wait click_link_by_text_no_wait
-
-    # :category: User Input
-      def click_span_by_text(browser, strg, desc = '')
-        if not desc and not strg.match(/Save|Open|Close|Submit|Cancel/)
-          desc = 'to navigate to selection'
-        end
-        msg = "Click span containing text '#{strg}'."
-        msg << " #{desc}" if desc.length > 0
-        if validate(browser, @myName, __LINE__)
-          passed_to_log("#{msg}")
-        end
-      rescue
-        failed_to_log("Unable to #{msg}: '#{$!}'")
-      end
-
-    # TODO no logging yet.  slow.# :category: User Input
-      def click_span_with_text(browser, trgt, desc = '')
-        msg = "Find and click span containing text '#{trgt}'."
-        msg << " #{desc}" if desc.length > 0
-        spans = browser.spans
-        x     = 0
-        spans.each do |span|
-          x += 1
-          debug_to_log("Span #{x}: #{span.text}")
-          aText = span.text
-          if aText and aText.size > 0
-            if aText =~ /#{trgt}/
-              break
-            end
-          end
-        end
-        spans[x].click
-      end
-
-    # :category: User Input
-      def click_link_by_title(browser, strg, desc = '')
-        click(browser, :link, :title, strg, desc)
-      end
-
-      alias click_title click_link_by_title
-    # :category: User Input
-      def click_title_no_wait(browser, strg, desc = '')
-        click_no_wait(browser, :link, :title, strg, desc)
-      end
-
-    # :category: User Input
-      def click_table_row_with_text_by_id(browser, ptrn, strg, column = nil)
-        msg   = "id=#{ptrn} row with text='#{strg}"
-        table = get_table_by_id(browser, /#{ptrn}/)
+      # @!endgroup Core
+
+      # @!group Core
+
+      # Click the first row which contains a particular string in a table identified by attribute and value.
+      # A specific column in the table can also be specified.
+      #
+      # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.
+      # @param [Symbol] how The element attribute used to identify the specific element.
+      #   Valid values depend on the kind of element.
+      #   Common values: :text, :id, :title, :name, :class, :href (:link only)
+      # @param [String|Regexp] what A string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
+      # @param [String] text Full text string to be found in the table row.
+      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
+      # @param [Fixnum] column Integer indicating the column to search for the text string.
+      # If not supplied all columns will be checked.
+      #
+      def click_table_row_with_text(browser, how, what, text, desc = '', column = nil)
+        msg = build_message("Click row with text #{text} in table :#{how}=>'#{what}.", desc)
+        table = get_table(browser, how, what, desc)
         if table
-          index = get_index_of_row_with_text(table, strg, column)
+          index = get_index_of_row_with_text(table, text, column)
           if index
             table[index].click
             if validate(browser, @myName, __LINE__)
-              passed_to_log("Click #{msg} row index=#{index}.")
+              passed_to_log(msg)
               index
             end
           else
-            failed_to_log("Table #{msg} not found to click.")
+            failed_to_log("#{msg} Row not found.")
           end
         else
-          failed_to_log("Table id=#{ptrn} not found.")
+          failed_to_log("#{msg} Table not found.")
         end
       rescue
-        failed_to_log("Unable to click table #{msg}: '#{$!}' (#{__LINE__}) ")
+        failed_to_log("Unable to #{msg}: '#{$!}'")
       end
 
-    # :category: User Input
-      def click_table_row_with_text_by_index(browser, idx, strg, column = nil)
-        msg   = "index=#{idx} row with text='#{strg}"
-        table = get_table_by_index(browser, idx)
+      # Double click the first row which contains a particular string in a table identified by attribute and value.
+      # A specific column in the table can also be specified.
+      # Uses fire_event method in Watir to send 'onDblClick' event.
+      #
+      # @param (see #click_table_row_with_text)
+      #
+      def double_click_table_row_with_text(browser, how, what, text, desc = '', column = nil)
+        msg = build_message("Double click row with text #{text} in table :#{how}=>'#{what}.", desc)
+        table = get_table(browser, how, what, desc)
         if table
-          index = get_index_of_row_with_text(table, strg, column)
+          index = get_index_of_row_with_text(table, text, column)
           if index
-            table[index].click
+            table[index].fire_event('ondblclick')
             if validate(browser, @myName, __LINE__)
-              passed_to_log("Click #{msg} row index=#{index}.")
+              passed_to_log(msg)
               index
             end
           else
-            failed_to_log("Table #{msg} not found to click.")
+            failed_to_log("#{msg} Row not found.")
           end
         else
-          failed_to_log("Table id=#{ptrn} not found.")
+          failed_to_log("#{msg} Table not found.")
         end
       rescue
-        failed_to_log("Unable to click table #{msg}: '#{$!}' (#{__LINE__}) ")
+        failed_to_log("Unable to #{msg}: '#{$!}'")
       end
 
-      def double_click_table_row_with_text_by_id(browser, ptrn, strg, column = nil)
-        msg   = "id=#{ptrn} row with text='#{strg}"
-        table = get_table_by_id(browser, /#{ptrn}/)
-        if table
-          index = get_index_of_row_with_text(table, strg, column)
-          if index
-            table[index].fire_event('ondblclick')
-            if validate(browser, @myName, __LINE__)
-              passed_to_log("Double click #{msg} row index=#{index}.")
-              index
-            end
-          else
-            failed_to_log("Table #{msg} not found to double click.")
-          end
-        else
-          failed_to_log("Table id=#{ptrn} not found.")
-        end
-      rescue
-        failed_to_log("Unable to double click table #{msg}: '#{$!}' (#{__LINE__}) ")
+      # @!endgroup Core
+
+      # @!group Tables
+
+      # Click the first row which contains a particular string in a table identified by the value in its _id_ attribute.
+      # A specific column in the table can also be specified.
+      #
+      # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.
+      # @param [String|Regexp] what A string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
+      # @param [String] text Full text string to be found in the table row.
+      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
+      # @param [Fixnum] column Integer indicating the column to search for the text string.
+      # If not supplied all columns will be checked.
+      #
+      def click_table_row_with_text_by_id(browser, what, text, desc = '', column = nil)
+        click_table_row_with_text(browser, :id, what, text, desc, column)
       end
 
-      def double_click_table_row_with_text_by_index(browser, idx, strg, column = nil)
-        msg   = "index=#{idx} row with text='#{strg}"
-        table = get_table_by_index(browser, idx)
-        if table
-          index = get_index_of_row_with_text(table, strg, column)
-          if index
-            row = table[index]
-            table[index].fire_event('ondblclick')
-            row.fire_event('ondblclick')
-            if validate(browser, @myName, __LINE__)
-              passed_to_log("Double click #{msg} row index=#{index}.")
-              index
-            end
-          else
-            failed_to_log("Table #{msg} not found to double click.")
-          end
-        else
-          failed_to_log("Table id=#{ptrn} not found.")
-        end
-      rescue
-        failed_to_log("Unable to double click table #{msg}: '#{$!}' (#{__LINE__}) ")
+      # Click the first row which contains a particular string in a table identified by its index
+      # in the array of tables contained in <b>+browser+</b>.
+      # A specific column in the table can also be specified.
+      #
+      # @param (see #click_table_row_with_text_by_id)
+      #
+      def click_table_row_with_text_by_index(browser, what, text, desc = '', column = nil)
+        click_table_row_with_text(browser, :id, what, text, desc, column)
+      end
+
+      # Double click the first row which contains a particular string in a table identified by the value in its _id_ attribute.
+      # A specific column in the table can also be specified.
+      #
+      # @param (see #click_table_row_with_text_by_id)
+      #
+      def double_click_table_row_with_text_by_id(browser, what, text, desc = '', column = nil)
+        double_click_table_row_with_text(browser, :id, what, text, desc, column)
+      end
+
+      # Double click the first row which contains a particular string in a table identified by its index
+      # in the array of tables contained in <b>+browser+</b>.
+      # A specific column in the table can also be specified.
+      #
+      # @param (see #click_table_row_with_text_by_id)
+      #
+      def double_click_table_row_with_text_by_index(browser, idx, what, column = nil)
+        double_click_table_row_with_text(browser, :index, what, text, desc, column)
       end
 
+      # @!endgroup Tables
+
+      # @!group Core
+
       def click_popup_button(title, button, waitTime= 9, user_input=nil)
         #TODO: is winclicker still viable/available?
         wc = WinClicker.new
@@ -565,240 +590,94 @@ _Example_
         #    end
       end
 
-      def select_option(browser, how, what, which, value, desc = '')
-        msg  = "Select option #{which}='#{value}' from list #{how}=#{what}. #{desc}"
-        list = browser.select_list(how, what)
-        case which
-          when :text
-            list.select(value)
-          when :value
-            list.select_value(value)
-          when :index
-            all = list.getAllContents
-            txt = all[value]
-            list.select(txt)
-          else
-            na = "#{__method__} cannot support select by '#{which}'. (#{msg})"
-            debug_to_log(na, __LINE__, true)
-            raise na
-        end
-        passed_to_log(msg)
-      rescue
-        failed_to_log("#Unable to #{msg}': '#{$!}'")
-      end
-
-      def select_option_from_list(list, what, what_strg, desc = '')
+      def select_option_from_list(list, which, value, desc = '', nofail = false)
+        msg = build_message("Select :#{which}=>'#{value}", desc)
         ok  = true
-        msg = "#{__method__.to_s.titleize} "
         if list
-          msg << "list id=#{list.id}: "
-          case what
+          case which
             when :text
-              list.select(what_strg) #TODO: regex?
+              list.select(value) #TODO: regex?
             when :value
-              list.select_value(what_strg) #TODO: regex?
+              list.select_value(value) #TODO: regex?
             when :index
-              list.select(list.getAllContents[what_strg.to_i])
+              list.select(list.getAllContents[value.to_i])
             else
-              msg << "select by #{what} not supported. #{desc} (#{__LINE__})"
-              failed_to_log(msg)
+              failed_to_log("#{msg}  Select by #{which} not supported.")
               ok = false
           end
           if ok
-            msg << "#{what}='#{what_strg}' selected. #{desc}"
             passed_to_log(msg)
             true
+          else
+            if nofail
+              passed_to_log("#{msg} Option not found. No Fail specified.")
+              true
+            else
+              failed_to_log("#{msg} Option not found.")
+            end
           end
         else
-          failed_to_log("#{__method__.to_s.titleize} list not found. #{desc} (#{__LINE__})")
+          failed_to_log("#{msg} Select list not found.")
         end
       rescue
-        failed_to_log("#{__method__.to_s.titleize}: #{what}='#{what_strg}' could not be selected: '#{$!}'. #{desc} (#{__LINE__})")
+        failed_to_log("Unable to #{msg} '#{$!}'")
       end
 
-=begin rdoc
-  :category: A_rdoc_test
-Select an option from a specific drop down list.  The drop down (select list) is id
-
-_Parameters_::
-
-*browser* - a reference to the browser window to be tested
-
-*how* - the element attribute used to identify the specific element. Valid values depend on the kind of element.
-Common values: :text, :id, :title, :name, :class, :href (:link only)
-
-*what* - a string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
-
-*desc* - a string containing a message or description intended to appear in the log and/or report output
-
-_Example_
+      def select_option(browser, how, what, which, value, desc = '', nofail = false)
+        list = browser.select_list(how, what)
+        msg = build_message(" from list with :#{how}=>'#{what}", desc)
+        select_option_from_list(list, which, value, msg, nofail)
+      end
 
-  # html for a link element:
-  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
-  click_no_wait(browser, :link, :text, 'Pickaxe')
+      # @!endgroup Core
 
-=end
+      # @!group Select
 
-      def select_option_by_id_and_option_text(browser, strg, option, nofail=false, desc = '')
-        msg = "Select list id=#{strg} option text='#{option}' selected."
-        msg << " #{desc}" if desc.length > 0
-        list = browser.select_list(:id, strg)
-        list.select(option)
-        #      browser.select_list(:id, strg).select(option)   #(browser.select_list(:id, strg).getAllContents[option])
-        if validate(browser, @myName, __LINE__)
-          passed_to_log(msg)
-          true
-        end
-      rescue
-        if !nofail
-          failed_to_log("#{msg} '#{$!}'")
-        end
+      def select_option_by_id_and_option_text(browser, what, option, nofail = false, desc = '')
+        select_option(browser, :id, what, :text, option, desc, nofail)
       end
 
       alias select_option_by_id select_option_by_id_and_option_text
       alias select_option_by_id_and_text select_option_by_id_and_option_text
 
-      def select_option_by_name_and_option_text(browser, strg, option, desc = '')
-        msg = "Select list name=#{strg} option text='#{option}' selected."
-        msg << " #{desc}" if desc.length > 0
-        begin
-          list = browser.select_list(:name, strg)
-        rescue => e
-          if not rescue_me(e, __method__, "#{__LINE__}: select_list(:name,'#{strg}')", "#{browser.class}")
-            raise e
-          end
-        end
-        begin
-          list.select(option)
-        rescue => e
-          if not rescue_me(e, __method__, "#{__LINE__}: select_list#select('#{option}')", "#{browser.class}")
-            raise e
-          end
-        end
-        if validate(browser, @myName, __LINE__)
-          passed_to_log(msg)
-          true
-        end
-      rescue
-        failed_to_log("#{msg} '#{$!}'")
+      def select_option_by_name_and_option_text(browser, what, option, desc = '')
+        select_option(browser, :name, what, :text, option, desc)
       end
 
       alias select_option_by_name select_option_by_name_and_option_text
 
-      def select_option_by_title_and_option_text(browser, strg, option, desc = '')
-        msg = "Select list name=#{strg} option text='#{option}' selected."
-        msg << " #{desc}" if desc.length > 0
-        browser.select_list(:title, strg).select(option)
-        if validate(browser, @myName, __LINE__)
-          passed_to_log(msg)
-        end
-      rescue
-        failed_to_log("#{msg} '#{$!}'")
+      def select_option_by_title_and_option_text(browser, what, option, desc = '')
+        select_option(browser, :title, what, :text, option, desc)
       end
 
-      def select_option_by_class_and_option_text(browser, strg, option, desc = '')
-        msg = "Select list class=#{strg} option text='#{option}' selected."
-        msg << " #{desc}" if desc.length > 0
-        browser.select_list(:class, strg).select(option)
-        if validate(browser, @myName, __LINE__)
-          passed_to_log(msg)
-          true
-        end
-      rescue
-        failed_to_log("#{msg} '#{$!}'")
+      def select_option_by_class_and_option_text(browser, what, option, desc = '')
+        select_option(browser, :class, what, :text, option, desc)
       end
 
-      def select_option_by_name_and_option_value(browser, strg, option, desc = '')
-        msg = "Select list name=#{strg} option value='#{option}' selected."
-        msg << " #{desc}" if desc.length > 0
-        begin
-          list = browser.select_list(:name, strg)
-        rescue => e
-          if not rescue_me(e, __method__, "#{__LINE__}: select_list(:name,'#{strg}')", "#{browser.class}")
-            raise e
-          end
-        end
-        begin
-          list.select_value(option)
-        rescue => e
-          if not rescue_me(e, __method__, "#{__LINE__}: select_list#select_value('#{option}')", "#{browser.class}")
-            raise e
-          end
-        end
-        if validate(browser, @myName, __LINE__)
-          passed_to_log(msg)
-          true
-        end
-      rescue
-        failed_to_log("#{msg} '#{$!}'")
+      def select_option_by_name_and_option_value(browser, what, option, desc = '')
+        select_option(browser, :name, what, :value, option, desc)
       end
 
-      def select_option_by_id_and_option_value(browser, strg, option, desc = '')
-        msg = "Select list name=#{strg} option value='#{option}' selected."
-        msg << " #{desc}" if desc.length > 0
-        begin
-          list = browser.select_list(:id, strg)
-        rescue => e
-          if not rescue_me(e, __method__, "#{__LINE__}: select_list(:text,'#{strg}')", "#{browser.class}")
-            raise e
-          end
-        end
-        sleep(0.5) unless @targetBrowser.abbrev == 'IE'
-        begin
-          list.select_value(option)
-        rescue => e
-          if not rescue_me(e, __method__, "#{__LINE__}: select_list#select_value('#{option}')", "#{browser.class}")
-            raise e
-          end
-        end
-        if validate(browser, @myName, __LINE__)
-          passed_to_log(msg)
-          true
-        end
-      rescue
-        failed_to_log("#{msg} '#{$!}'")
+      def select_option_by_id_and_option_value(browser, what, option, desc = '')
+        select_option(browser, :id, what, :value, option, desc)
       end
 
-      def select_option_by_id_and_index(browser, strg, idx, desc = '')
-        msg = "Select list id=#{strg} index='#{idx}' selected."
-        msg << " #{desc}" if desc.length > 0
-        list = browser.select_list(:id, strg)
-        all  = list.getAllContents
-        txt  = all[idx]
-        browser.select_list(:id, strg).set(browser.select_list(:id, strg).getAllContents[idx])
-        if validate(browser, @myName, __LINE__)
-          passed_to_log(msg)
-          true
-        end
-      rescue
-        failed_to_log("#{msg} '#{$!}'")
+      def select_option_by_id_and_index(browser, what, option, desc = '')
+        select_option(browser, :id, what, :index, option, desc)
       end
 
-      def select_option_by_name_and_index(browser, strg, idx)
-      # TODO add check that both list and option exist
-        msg = "Select list name=#{strg} index='#{idx}' selected."
-        msg << " #{desc}" if desc.length > 0
-        browser.select_list(:name, strg).set(browser.select_list(:name, strg).getAllContents[idx])
-        if validate(browser, @myName, __LINE__)
-          passed_to_log(msg)
-          true
-        end
-      rescue
-        failed_to_log("#{msg} '#{$!}'")
+      def select_option_by_name_and_index(browser, what, option, desc = '')
+        select_option(browser, :name, what, :index, option, desc)
       end
 
-      def select_option_by_xpath_and_index(browser, strg, idx)
-        msg = "Select list xpath=#{strg} index='#{idx}' selected."
-        msg << " #{desc}" if desc.length > 0
-        browser.select_list(:xpath, strg).set(browser.select_list(:xpath, strg).getAllContents[idx])
-        if validate(browser, nil, __LINE__)
-          passed_to_log(msg)
-          true
-        end
-      rescue
-        failed_to_log("#{msg} '#{$!}'")
+      def select_option_by_xpath_and_index(browser, what, option, desc = '')
+        select_option(browser, :xpath, what, :index, option, desc)
       end
 
+      # @!endgroup Select
+
+      # @!group Core
+
       def set(browser, element, how, what, value = nil, desc = '')
         msg = "Set #{element} #{how}=>'#{what}' "
         msg << ", :value=>#{value} " if value
@@ -819,28 +698,50 @@ _Example_
         failed_to_log("#{msg} '#{$!}'")
       end
 
+      def set_file_field(browser, how, what, filespec, desc = '')
+        msg = "Set file field #{how}=>#{what} to '#{filespec}."
+        msg << " #{desc}" if desc.length > 0
+        ff = browser.file_field(how, what)
+        if ff
+          ff.set filespec
+          sleep_for(8)
+          if validate(browser, @myName, __LINE__)
+            passed_to_log(msg)
+            true
+          end
+        else
+          failed_to_log("#{msg} File field not found.")
+        end
+      rescue
+        failed_to_log("Unable to #{msg} '#{$!}'")
+      end
+
+      # @!endgroup Core
+
+      # @!group Set
+
       def set_checkbox(browser, how, what, value, desc = '')
         set(browser, :checkbox, how, what, value, desc)
       end
 
-      def set_checkbox_by_class(browser, strg, value = nil, desc = '')
-        set(browser, :checkbox, :class, strg, value, desc)
+      def set_checkbox_by_class(browser, what, value = nil, desc = '')
+        set(browser, :checkbox, :class, what, value, desc)
       end
 
-      def set_checkbox_by_id(browser, strg, value = nil, desc = '')
-        set(browser, :checkbox, :id, strg, value, desc)
+      def set_checkbox_by_id(browser, what, value = nil, desc = '')
+        set(browser, :checkbox, :id, what, value, desc)
       end
 
-      def set_checkbox_by_name(browser, strg, value = nil, desc = '')
-        set(browser, :checkbox, :name, strg, value, desc)
+      def set_checkbox_by_name(browser, what, value = nil, desc = '')
+        set(browser, :checkbox, :name, what, value, desc)
       end
 
-      def set_checkbox_by_title(browser, strg, value = nil, desc = '')
-        set(browser, :checkbox, :title, strg, value, desc)
+      def set_checkbox_by_title(browser, what, value = nil, desc = '')
+        set(browser, :checkbox, :title, what, value, desc)
       end
 
-      def set_checkbox_by_value(browser, strg, desc = '')
-        set(browser, :checkbox, :value, strg, nil, desc)
+      def set_checkbox_by_value(browser, what, desc = '')
+        set(browser, :checkbox, :value, what, nil, desc)
       end
 
       def set_radio(browser, how, what, value = nil, desc = '')
@@ -859,28 +760,28 @@ _Example_
         failed_to_log("#{msg} '#{$!}'")
       end
 
-      def set_radio_by_class(browser, strg, value = nil, desc = '')
-        set(browser, :radio, :class, strg, value, desc)
+      def set_radio_by_class(browser, what, value = nil, desc = '')
+        set(browser, :radio, :class, what, value, desc)
       end
 
-      def set_radio_by_id(browser, strg, value = nil, desc = '')
-        set(browser, :radio, :id, strg, value, desc)
+      def set_radio_by_id(browser, what, value = nil, desc = '')
+        set(browser, :radio, :id, what, value, desc)
       end
 
       def set_radio_by_index(browser, index, desc = '')
         set(browser, :radio, :index, index, value, desc)
       end
 
-      def set_radio_by_name(browser, strg, value = nil, desc = '')
-        set(browser, :radio, :name, strg, value, desc)
+      def set_radio_by_name(browser, what, value = nil, desc = '')
+        set(browser, :radio, :name, what, value, desc)
       end
 
-      def set_radio_by_title(browser, strg, value = nil, desc = '')
-        set(browser, :radio, :title, strg, value, desc)
+      def set_radio_by_title(browser, what, value = nil, desc = '')
+        set(browser, :radio, :title, what, value, desc)
       end
 
-      def set_radio_by_value(browser, strg, desc = '')
-        set(browser, :radio, :value, strg, nil, desc)
+      def set_radio_by_value(browser, what, desc = '')
+        set(browser, :radio, :value, what, nil, desc)
       end
 
       def set_radio_no_wait_by_index(browser, index, desc = '')
@@ -913,10 +814,22 @@ _Example_
         set_radio_two_attributes(browser, :value, value, :index, index, desc)
       end
 
-      def set_radio_by_name_and_value(browser, strg, value, desc = '')
-        set_radio(browser, :name, strg, value, desc)
+      def set_radio_by_name_and_value(browser, what, value, desc = '')
+        set_radio(browser, :name, what, value, desc)
+      end
+
+      def set_file_field_by_name(browser, what, path, desc = '')
+        set_file_field(browser, :name, what, path, desc)
       end
 
+      def set_file_field_by_id(browser, what, path, desc = '')
+        set_file_field(browser, :id, what, path, desc)
+      end
+
+      # @!endgroup Set
+
+      # @!group Core
+
       def clear(browser, element, how, what, value = nil, desc = '')
         msg = "Clear #{element} #{how}=>'#{what}' "
         msg << ", value=>#{value} " if value
@@ -939,22 +852,28 @@ _Example_
         failed_to_log("#{msg} '#{$!}'")
       end
 
+      # @!endgroup Core
+
+      # @!group Clear
+
       def clear_checkbox(browser, how, what, value = nil, desc = '')
         clear(browser, :checkbox, how, what, value, desc)
       end
 
-      def clear_checkbox_by_name(browser, strg, value = nil, desc = '')
-        clear(browser, :checkbox, :name, strg, value, desc)
+      def clear_checkbox_by_name(browser, what, value = nil, desc = '')
+        clear(browser, :checkbox, :name, what, value, desc)
       end
 
-      def clear_checkbox_by_id(browser, strg, value = nil, desc = '')
-        clear(browser, :checkbox, :id, strg, value, desc)
+      def clear_checkbox_by_id(browser, what, value = nil, desc = '')
+        clear(browser, :checkbox, :id, what, value, desc)
       end
 
       def clear_radio(browser, how, what, value = nil, desc = '')
         clear(browser, :radio, how, what, value, desc)
       end
 
+      # @!endgroup Clear
+
     # Set skip_value_check = true when string is altered by application and/or
     # this method will be followed by validate_text
       def clear_textfield(browser, how, which, skip_value_check = false)
@@ -981,32 +900,6 @@ _Example_
         failed_to_log("Textfield id='#{id}' could not be cleared: '#{$!}'. (#{__LINE__})")
       end
 
-      def set_file_field(browser, how, what, filespec, desc = '')
-        msg = "Set file field #{how}=>#{what} to '#{filespec}."
-        msg << " #{desc}" if desc.length > 0
-        ff = browser.file_field(how, what)
-        if ff
-          ff.set filespec
-          sleep_for(8)
-          if validate(browser, @myName, __LINE__)
-            passed_to_log(msg)
-            true
-          end
-        else
-          failed_to_log("#{msg} File field not found.")
-        end
-      rescue
-        failed_to_log("Unable to #{msg} '#{$!}'")
-      end
-
-      def set_file_field_by_name(browser, strg, path, desc = '')
-        set_file_field(browser, :name, strg, path, desc)
-      end
-
-      def set_file_field_by_id(browser, strg, path, desc = '')
-        set_file_field(browser, :id, strg, path, desc)
-      end
-
 =begin rdoc
   :category: A_rdoc_test
 Enter a string into a text field element identified by an attribute type and a value.
@@ -1098,7 +991,7 @@ _Example_
 
 =begin rdoc
   :category: A_rdoc_test
-Enter a string into a text field element identified by the value in its id attribute.
+Enter a string into a text field element identifiedelement identified by the value in its id attribute.
 
 _Parameters_::
 
@@ -1128,8 +1021,8 @@ _Example_
         set_text_field(browser, :title, title, value, desc, skip_value_check)
       end
 
-      def set_textfield_by_class(browser, strg, value, desc = '', skip_value_check = false)
-        set_text_field(browser, :class, strg, value, desc, skip_value_check)
+      def set_textfield_by_class(browser, what, value, desc = '', skip_value_check = false)
+        set_text_field(browser, :class, what, value, desc, skip_value_check)
       end
 
 =begin rdoc
@@ -1169,34 +1062,26 @@ _Example_
         failed_to_log("Unable to '#{msg}': '#{$!}'")
       end
 
-=begin rdoc
-  :category: A_rdoc_test
-Allows a generic way to fire browser or javascript events on page elements.
-Raises UnknownObjectException if the object is not found or ObjectDisabledException if the object is currently disabled.
-_Parameters_::
-
-*browser* - a reference to the browser window to be tested
-
-*element* - the kind of element to click. Must be one of the elements recognized by Watir.
-Some common values are :link, :button, :image, :div, :span.
-
-*how* - the element attribute used to identify the specific element. Valid values depend on the kind of element.
-Common values: :text, :id, :title, :name, :class, :href (:link only)
-
-*what* - a string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
-
-*event* - a string indicating the event to be triggered, e.g., 'onMouseOver', 'onClick', and etc.
-
-*desc* - a string containing a message or description intended to appear in the log and/or report output
-
-_Example_
-
-  # html for a link element:
-  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
-  fire_event(browser, :link, :text, 'Pickaxe', 'onMouseOver')
-
-=end
-
+      # @!group Core
+
+      # Fire an event on a specific DOM element identified by one of its attributes and that attribute's value.
+      #
+      # @example
+      #  # html for a link element:
+      #  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
+      #
+      #  fire_event(browser, :link, :text, 'Pickaxe', 'onMouseOver')
+      #
+      # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.
+      # @param [Symbol] element The kind of element to click. Must be one of the elements recognized by Watir.
+      #   Some common values are :link, :button, :image, :div, :span.
+      # @param [Symbol] how The element attribute used to identify the specific element.
+      #   Valid values depend on the kind of element.
+      #   Common values: :text, :id, :title, :name, :class, :href (:link only)
+      # @param [String|Regexp] what A string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
+      # @param [String] event A string identifying the event to be fired.
+      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
+      #
       def fire_event(browser, element, how, what, event, desc = '')
         msg  = "#{element.to_s.titlecase}: #{how}=>'#{what}' event:'#{event}'"
         msg1 = "#{element.to_s.titlecase}(#{how}, '#{what}')"
@@ -1227,28 +1112,60 @@ _Example_
       rescue
         failed_to_log("Unable to fire event: #{msg}. '#{$!}' #{desc}")
       end
-
-      def fire_event_on_link_by_text(browser, strg, event = 'onclick', desc = '')
-        fire_event(browser, :link, :text, strg, event, desc)
+      
+      # @!endgroup Core
+      
+      # @!group Fire Event
+
+      # Fire an event on a link element identified by the value in its text (innerHTML)
+      #
+      # @example
+      #  # html for a link element:
+      #  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
+      #
+      #  fire_event_on_link_by_text(browser, 'Pickaxe', 'onMouseOver')
+      #
+      # @param [Watir::Browser] browser A reference to the browser window or container element to be tested.
+      # @param [String|Regexp] what A string or a regular expression to be found in the *how* attribute that uniquely identifies the element.
+      # @param [String] event A string identifying the event to be fired.
+      # @param [String] desc Contains a message or description intended to appear in the log and/or report output
+      #
+      def fire_event_on_link_by_text(browser, what, event, desc = '')
+        fire_event(browser, :link, :text, what, event, desc)
       end
 
       alias fire_event_text fire_event_on_link_by_text
       alias fire_event_by_text fire_event_on_link_by_text
 
-      def fire_event_on_link_by_id(browser, strg, event = 'onclick', desc = '')
-        fire_event(browser, :link, :id, strg, event, desc)
+      # Fire an event on a link element identified by the value in its _id_ attribute.
+      #
+      # @example
+      #  # html for a link element:
+      #  # <a href="http://pragmaticprogrammer.com/titles/ruby/" id="one" name="book">Pickaxe</a>
+      #
+      #  fire_event_on_link_by_id(browser, 'one', 'onMouseOver')
+      #
+      # @param (see #fire_event_on_link_by_text)
+      #
+      def fire_event_on_link_by_id(browser, what, event, desc = '')
+        fire_event(browser, :link, :id, what, event, desc)
       end
 
       alias fire_event_id fire_event_on_link_by_id
       alias fire_event_by_id fire_event_on_link_by_id
 
-      def fire_event_on_image_by_src(browser, strg, event = 'onclick', desc = '')
-        fire_event(browser, :img, :src, strg, event, desc)
+      # Fire an event on a image element identified by the value in its _src_ attribute.
+      # Take care to escape characters in the source url that are reserved by Regexp.
+      # @param (see #fire_event_on_link_by_text)
+      #
+      def fire_event_on_image_by_src(browser, what, event, desc = '')
+        fire_event(browser, :img, :src, what, event, desc)
       end
 
       alias fire_event_src fire_event_on_image_by_src
       alias fire_event_image_by_src fire_event_on_image_by_src
 
+      # @!endgroup Fire Event
 
     end
   end