add documentation

appium · Dec 23, 2017 · ec2ec43 · ec2ec43
1 parent c9c2a03
commit ec2ec43
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/lib/appium_lib_core/common/base/w3c_bridge.rb b/lib/appium_lib_core/common/base/w3c_bridge.rb
@@ -6,6 +6,19 @@ def commands(command)
           ::Appium::Core::Commands::COMMANDS_EXTEND_W3C[command]
         end
 
+        # Perform touch actions for W3C module. Generate `touch` pointer action here and users can use this via `driver.action`
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/KeyActions.html
+        #
+        # @private
+        # override
+        #
+        # @example
+        #
+        #     element = @driver.find_element(:id, "some id")
+        #     @driver.action.click(element).perform # The `click` is a part of `PointerActions`
+        #
         def action(async = false)
           ::Selenium::WebDriver::W3CActionBuilder.new self,
                                                       ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'touch'),