Update documentation for appium 1.0

Author: bootstraponline

lib/appium_lib/android/element/alert.rb

@@ -1,6 +1,6 @@
 module Appium
   module Android
-    # Tap the alert button identified by value.
+    # Click the first alert button that contains value or by index.
     # @param value [Integer, String] either an integer index of the button or the button's name
     # @return [void]
     def alert_click value

lib/appium_lib/android/element/button.rb

@@ -32,9 +32,10 @@ def _button_contains_string value
 
     public
 
-    # Find a button by text and optionally number.
-    # @param value [String, Integer] the value to exactly match. If int then the button at that index is returned.
-    # @return [Button] the button found with text and matching number
+    # Find the first button that contains value or by index.
+    # @param value [String, Integer] the value to exactly match.
+    # If int then the button at that index is returned.
+    # @return [Button]
     def button value
       # Don't use ele_index because that only works on one element type.
       # Android needs to combine button and image button to match iOS.
@@ -48,37 +49,40 @@ def button value
       xpath _button_contains_string value
     end
 
+    # Find all buttons containing value
+    # @param value [String] the value to search for
+    # @return [Array<Button>]
     def buttons value
      xpaths _button_contains_string value
     end
 
-    # Get the first button element.
+    # Find the first button.
     # @return [Button]
     def first_button
       xpath _button_visible_string
     end
 
-    # Get the last button element.
+    # Find the last button.
     # @return [Button]
     def last_button
        xpath _button_visible_string index: 'last()'
     end
 
-    # Get the first button element that exactly matches text.
+    # Find the first button that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [Button]
     def button_exact value
       xpath _button_exact_string value
     end
 
-    # Get all button elements that exactly match text.
+    # Find all buttons that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<Button>]
     def buttons_exact value
       xpaths _button_exact_string value
     end
 
-    # Get an array of button elements.
+    # Find all buttons.
     # @return [Array<Button>]
     def e_buttons
       xpaths _button_visible_string

lib/appium_lib/android/element/generic.rb

@@ -1,23 +1,35 @@
 module Appium
   module Android
 
+    # Find the first element containing value
+    # @param value [String] the value to search for
+    # @return [Element]
     def find value
       xpath_visible_contains '*', value
     end
 
+    # Find all elements containing value
+    # @param value [String] the value to search for
+    # @return [Array<Element>]
     def finds value
       xpaths_visible_contains '*', value
     end
 
+    # Find the first element exactly matching value
+    # @param value [String] the value to search for
+    # @return [Element]
     def find_exact value
       xpath_visible_exact '*', value
     end
 
+    # Find all elements exactly matching value
+    # @param value [String] the value to search for
+    # @return [Array<Element>]
     def finds_exact value
       xpaths_visible_exact '*', value
     end
 
-    # Scroll to an element containing target text or description.
+    # Scroll to the first element containing target text or description.
     # @param text [String] the text to search for in the text value and content description
     # @return [Element] the element scrolled to
     def scroll_to text
@@ -30,7 +42,7 @@ def scroll_to text
       complex_find mode: 'scroll', selectors: args
     end
 
-    # Scroll to an element with the exact target text or description.
+    # Scroll to the first element with the exact target text or description.
     # @param text [String] the text to search for in the text value and content description
     # @return [Element] the element scrolled to
     def scroll_to_exact text

lib/appium_lib/android/element/text.rb

@@ -3,46 +3,50 @@ module Appium
   module Android
     TextView = 'android.widget.TextView'
 
-    # Get the first element that includes text.
-    # @param value [String, Integer] the value to find. If int then the text at that index is returned.
-    # @return [Text]
+    # Find the first TextView that contains value or by index.
+    # @param value [String, Integer] the value to find.
+    # If int then the TextView at that index is returned.
+    # @return [TextView]
     def s_text value
       return ele_index TextView, value if value.is_a? Numeric
       xpath_visible_contains TextView, value
     end
 
+    # Find all TextViews containing value.
+    # @param value [String] the value to search for
+    # @return [Array<TextView>]
     def s_texts value
       xpaths_visible_contains TextView, value
     end
 
-    # Get the first text element.
-    # @return [Text]
+    # Find the first TextView.
+    # @return [TextView]
     def first_s_text
       first_ele TextView
     end
 
-    # Get the last text element
-    # @return [Text]
+    # Find the last TextView.
+    # @return [TextView]
     def last_s_text
       last_ele TextView
     end
 
-    # Get the first textfield that matches text.
-    # @param value [String] the value that the tag must match
-    # @return [Text]
+    # Find the first TextView that exactly matches value.
+    # @param value [String] the value to match exactly
+    # @return [TextView]
     def s_text_exact value
       xpath_visible_exact TextView, value
     end
 
-    # Get all static textfields that matches text.
-    # @param value [String] the value that the tag must match
-    # @return [Array<Text>]
+    # Find all TextViews that exactly match value.
+    # @param value [String] the value to match exactly
+    # @return [Array<TextView>]
     def s_texts_exact value
       xpaths_visible_exact TextView, value
     end
 
-    # Get an array of text elements.
-    # @return [Array<Text>]
+    # Find all TextViews.
+    # @return [Array<TextView>]
     def e_s_texts
       tags TextView
     end

lib/appium_lib/android/element/textfield.rb

@@ -2,43 +2,50 @@ module Appium
   module Android
     EditText = 'android.widget.EditText'
 
-    # Get the first textfield that matches text.
-    # @param value [String, Integer] the text to match exactly. If int then the textfield at that index is returned.
-    # @return [Textfield]
+    # Find the first EditText that contains value or by index.
+    # @param value [String, Integer] the text to match exactly.
+    # If int then the EditText at that index is returned.
+    # @return [EditText]
     def textfield value
       return ele_index EditText, value if value.is_a? Numeric
       xpath_visible_contains EditText, value
     end
 
+    # Find all EditTexts containing value.
+    # @param value [String] the value to search for
+    # @return [Array<EditText>]
     def textfields value
       xpaths_visible_contains EditText, value
     end
 
-    # Get the first textfield element.
-    # @return [Textfield]
+    # Find the first EditText.
+    # @return [EditText]
     def first_textfield
       first_ele EditText
     end
 
-    # Get the last textfield element.
-    # @return [Textfield]
+    # Find the last EditText.
+    # @return [EditText]
     def last_textfield
       last_ele EditText
     end
 
-    # Get the first textfield that exactly matches text.
-    # @param value [String] the value the textfield must exactly match
-    # @return [Textfield]
+    # Find the first EditText that exactly matches value.
+    # @param value [String] the value to match exactly
+    # @return [EditText]
     def textfield_exact value
       xpath_visible_exact EditText, value
     end
 
+    # Find all EditTexts that exactly match value.
+    # @param value [String] the value to match exactly
+    # @return [Array<EditText>]
     def textfields_exact value
       xpaths_visible_exact EditText, value
     end
 
-    # Get an array of textfield elements.
-    # @return [Array<Textfield>]
+    # Find all EditTexts.
+    # @return [Array<EditText>]
     def e_textfields
       tags EditText
     end