add some comments in examples for drivers (#767)

Author: KazuCocoa

lib/appium_lib/common/multi_touch.rb

@@ -17,7 +17,7 @@ module Appium
   #   multi_touch_action.perform
   #
   #   # with an arbitrary driver
-  #   driver = Appium::Driver.new(opts, false).start_driver
+  #   driver = Appium::Driver.new(opts, false).start_driver # return an Appium::Core::Base::Driver instance
   #   multi_touch_action = MultiTouch.new(driver)
   #   multi_touch_action.add action_1
   #   multi_touch_action.add action_2

lib/appium_lib/common/touch_actions.rb

@@ -23,7 +23,7 @@ module Appium
   #
   # @example
   #
-  #   driver =  Appium::Driver.new(opts, false).start_driver
+  #   driver =  Appium::Driver.new(opts, false).start_driver # return an Appium::Core::Base::Driver instance
   #   action = TouchAction.new(driver).press(x: 45, y: 100).wait(5).release
   #   action.perform
   #   action = TouchAction.new(driver).swipe(....)

lib/appium_lib/driver.rb

@@ -91,7 +91,8 @@ class Driver
     #              wait_timeout: 30
     #            }
     #          }
-    #   Appium::Driver.new(opts, true).start_driver
+    #   appium_driver = Appium::Driver.new(opts, true)
+    #   appium_driver.start_driver
     #
     #   # Start Android driver with global scope
     #   opts = {
@@ -104,7 +105,8 @@ class Driver
     #              wait_interval: 1
     #            }
     #          }
-    #   Appium::Driver.new(opts, true).start_driver
+    #   appium_driver = Appium::Driver.new(opts, true)
+    #   appium_driver.start_driver
     #
     #   # Start iOS driver without global scope
     #   opts = {
@@ -116,7 +118,8 @@ class Driver
     #              wait_timeout: 30
     #            }
     #          }
-    #   Appium::Driver.new(opts, false).start_driver
+    #   appium_driver = Appium::Driver.new(opts, false)
+    #   appium_driver.start_driver
     #
     #   # Start iOS driver without global scope
     #   opts = {
@@ -129,7 +132,8 @@ class Driver
     #            },
     #            global_driver: false
     #          }
-    #   Appium::Driver.new(opts).start_driver
+    #   appium_driver = Appium::Driver.new(opts)
+    #   appium_driver.start_driver
     #
     # @param opts [Object] A hash containing various options.
     # @param global_driver [Bool] A bool require global driver before initialize.
@@ -489,7 +493,8 @@ def window_size
     #              wait_timeout: 30
     #            }
     #          }
-    #   Appium::Driver.new(opts).start_driver
+    #   appium_driver = Appium::Driver.new(opts) #=> return an Appium::Driver instance
+    #   appium_driver.start_driver #=> return an Appium::Core::Base::Driver
     #
     # @option http_client_ops [Hash] :http_client Custom HTTP Client
     # @option http_client_ops [Hash] :open_timeout Custom open timeout for http client.
@@ -591,13 +596,15 @@ def execute_script(script, *args)
     # @example
     #
     #   @driver = Appium::Driver.new(opts, false)
+    #   @driver.start_driver
     #   @driver.find_elements :predicate, yyy
     #
     # If you call `Appium.promote_appium_methods`, you can call `find_elements` directly.
     #
     # @example
     #
     #   @driver = Appium::Driver.new(opts, false)
+    #   @driver.start_driver
     #   @driver.find_elements :predicate, yyy
     #
     # If you call `Appium.promote_appium_methods`, you can call `find_elements` directly.
@@ -613,6 +620,7 @@ def find_elements(*args)
     # @example
     #
     #   @driver = Appium::Driver.new(opts, false)
+    #   @driver.start_driver
     #   @driver.find_element :accessibility_id, zzz
     #
     # If you call `Appium.promote_appium_methods`, you can call `find_element` directly.