lib/watir-webdriver/collections/element_collection.rb in watir-webdriver-0.0.1.dev4 vs lib/watir-webdriver/collections/element_collection.rb in watir-webdriver-0.0.1.dev5

@@ -5,36 +5,56 @@
 
     def initialize(parent, element_class)
       @parent, @element_class = parent, element_class
     end
 
+    #
+    # @yieldparam [Watir::BaseElement] element Iterate through the elements in this collection.
+    #
+
     def each(&blk)
       to_a.each(&blk)
     end
 
+    #
+    # @return [Fixnum] The number of elements in this collection.
+    #
+
     def length
       elements.length
     end
     alias_method :size, :length
 
+    #
+    # Get the element at the given index.
+    # Note that this is 0-indexed and not compatible with older Watir implementations.
+    #
+    # Also note that because of Watir's lazy loading, this will return an Element
+    # instance even if the index is out of bounds.
+    #
+    # @param [Fixnum] n Index of wanted element, 0-indexed
+    # @return [Watir::BaseElement] Returns an instance of a Watir::BaseElement subclass
+    #
+
+
     def [](idx)
       to_a[idx] || @element_class.new(@parent, :index, idx)
     end
 
     #
     # First element of this collection
     #
-    # @return Watir::BaseElement
+    # @return [Watir::BaseElement] Returns an instance of a Watir::BaseElement subclass
     #
 
     def first
       to_a[0] || @element_class.new(@parent, :index, 0)
     end
 
     #
     # Last element of the collection
     #
-    # @return Watir::BaseElement
+    # @return [Watir::BaseElement] Returns an instance of a Watir::BaseElement subclass
     #
 
     def last
       to_a[-1] || @element_class.new(@parent, :index, -1)
     end