lib/page_magic/drivers.rb in page_magic-1.0.0.alpha18 vs lib/page_magic/drivers.rb in page_magic-1.0.0.alpha19

@@ -5,14 +5,18 @@
   class Drivers
     def all
       @all ||= []
     end
 
+    # Make a driver available for selection when creating calling {PageMagic.session}
+    # @param [Driver] driver driver definition
     def register(driver)
       all << driver
     end
 
+    # Find a driver definition based on its registered name
+    # @param [Symbol] browser registered name of the required browser
     def find(browser)
       all.find { |driver| driver.support?(browser) }
     end
 
     # Loads drivers defined in files at the given path
@@ -25,9 +29,12 @@
         driver_name = File.basename(driver_file)[/(.*)\.rb$/, 1]
         register self.class.const_get(driver_name.classify)
       end
     end
 
+    # returns true if this driver instance is equal to the supplied object
+    # @param [Object] other subject of equality check
+    # @return [Boolean] true if the object is a match
     def ==(other)
       other.is_a?(Drivers) && all == other.all
     end
   end
 end