Skip to content

Commit 20b5cdb

Browse files
committed
[rb] add yardoc details for new driver extensions
1 parent fc05f3a commit 20b5cdb

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

rb/lib/selenium/webdriver/common/driver_extensions/has_casting.rb

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,52 @@ module WebDriver
2222
module DriverExtensions
2323
module HasCasting
2424

25+
#
26+
# What devices ("sinks") are available to be cast to.
27+
#
28+
# @return [Array] list of sinks available for casting with id and name values
29+
#
30+
2531
def cast_sinks
2632
@bridge.cast_sinks
2733
end
2834

35+
#
36+
# Sets a specific sink, using its name, as a Cast session receiver target.
37+
#
38+
# @param [String] name the sink to use as the target
39+
#
40+
2941
def cast_sink_to_use=(name)
3042
@bridge.cast_sink_to_use = name
3143
end
3244

45+
#
46+
# Starts a tab mirroring session on a specific receiver target.
47+
#
48+
# @param [String] name the sink to use as the target
49+
#
50+
3351
def start_cast_tab_mirroring(name)
3452
@bridge.start_cast_tab_mirroring(name)
3553
end
3654

55+
#
56+
# Gets error messages when there is any issue in a Cast session.
57+
#
58+
# @return [String] the error message
59+
#
60+
3761
def cast_issue_message
3862
@bridge.cast_issue_message
3963
end
4064

65+
#
66+
# Stops the existing Cast session on a specific receiver target.
67+
#
68+
# @param [String] name the sink to stop the Cast session
69+
#
70+
4171
def stop_casting(name)
4272
@bridge.stop_casting(name)
4373
end

rb/lib/selenium/webdriver/common/driver_extensions/has_launching.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ module WebDriver
2222
module DriverExtensions
2323
module HasLaunching
2424

25+
#
26+
# Launches Chromium app specified by id.
27+
#
28+
# @param [String] id
29+
#
30+
2531
def launch_app(id)
2632
@bridge.launch_app(id)
2733
end

0 commit comments

Comments
 (0)