Skip to content

Commit 9271c78

Browse files
committed
chore: correct yardocs
1 parent 231bf50 commit 9271c78

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

lib/appium_lib_core/common/base/driver.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -547,10 +547,10 @@ def pull_folder(path)
547547
# http://developer.android.com/reference/android/view/KeyEvent.html
548548
# @param [Integer] key The key to press. The values which have +KEYCODE_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
549549
# e.g.: KEYCODE_HOME is +3+ or +0x00000003+
550-
# @param [[Integer]] metastate The state the metakeys should be in when pressing the key. Default is empty Array.
550+
# @param [Array<Integer>] metastate The state the metakeys should be in when pressing the key. Default is empty Array.
551551
# Metastate have +META_+ prefix in https://developer.android.com/reference/android/view/KeyEvent.html
552552
# e.g.: META_SHIFT_ON is +1+ or +0x00000001+
553-
# @param [[Integer]] flags Native Android flag value. Several flags can be combined into a single key event.
553+
# @param [Array<Integer>] flags Native Android flag value. Several flags can be combined into a single key event.
554554
# Default is empty Array. Can set multiple flags as Array.
555555
# Flags have +FLAG_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
556556
# e.g.: FLAG_CANCELED is +32+ or +0x00000020+
@@ -571,10 +571,10 @@ def press_keycode(key, metastate: [], flags: [])
571571
# http://developer.android.com/reference/android/view/KeyEvent.html
572572
# @param [Integer] key The key to long press. The values which have +KEYCODE_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
573573
# e.g.: KEYCODE_HOME is +3+ or +0x00000003+
574-
# @param [[Integer]] metastate The state the metakeys should be in when pressing the key. Default is empty Array.
574+
# @param [Array<Integer>] metastate The state the metakeys should be in when pressing the key. Default is empty Array.
575575
# Metastate have +META_+ prefix in https://developer.android.com/reference/android/view/KeyEvent.html
576576
# e.g.: META_SHIFT_ON is +1+ or +0x00000001+
577-
# @param [[Integer]] flags Native Android flag value. Several flags can be combined into a single key event.
577+
# @param [Array<Integer>] flags Native Android flag value. Several flags can be combined into a single key event.
578578
# Default is empty Array. Can set multiple flags as Array.
579579
# Flags have +FLAG_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
580580
# e.g.: FLAG_CANCELED is +32+ or +0x00000020+

lib/appium_lib_core/common/log.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ def initialize(bridge)
1919
@bridge = bridge
2020
end
2121

22-
# @param [String|Hash] type You can get particular type's logs.
23-
# @return [[Selenium::WebDriver::LogEntry]] A list of logs data.
22+
# @param [String, Hash] type You can get particular type's logs.
23+
# @return [Array<Selenium::WebDriver::LogEntry>] A list of logs data.
2424
#
2525
# @example
2626
#
@@ -33,7 +33,7 @@ def get(type)
3333

3434
# Get a list of available log types
3535
#
36-
# @return [[Hash]] A list of available log types.
36+
# @return [Array<Hash>] A list of available log types.
3737
# @example
3838
#
3939
# @driver.logs.available_types # [:syslog, :crashlog, :performance]
@@ -74,7 +74,7 @@ def event=(log_event)
7474
# @since Appium 1.16.0
7575
# Returns events with filtering with 'type'. Defaults to all available events.
7676
#
77-
# @param [String] type The type of events to get
77+
# @param [String, Array<String>] type The type of events to get
7878
# @return [Hash]
7979
#
8080
# @example

lib/appium_lib_core/common/ws/websocket.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def ping(message, &callback)
8484
# Accepts either a String or an Array of byte-sized integers and sends a text or binary message over the connection
8585
# to the other peer; binary data must be encoded as an Array.
8686
#
87-
# @param [String|Array] message A message to send a text or binary message over the connection
87+
# @param [String, Array] message A message to send a text or binary message over the connection
8888
#
8989
# @example
9090
# ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")

0 commit comments

Comments
 (0)