Skip to content

Commit 6f5c827

Browse files
titusfortnertitusfortner
committed
[rb] fix api documentation warnings
1 parent 7848221 commit 6f5c827

4 files changed

Lines changed: 20 additions & 21 deletions

File tree

‎rb/lib/selenium/webdriver/chrome/options.rb‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -52,22 +52,22 @@ class Options < WebDriver::Options
5252
# options = Selenium::WebDriver::Chrome::Options.new(args: ['start-maximized', 'user-data-dir=/tmp/temp_profile'])
5353
# driver = Selenium::WebDriver.for(:chrome, capabilities: options)
5454
#
55-
# @param [Profile] :profile An instance of a Chrome::Profile Class
56-
# @param [Array] :encoded_extensions List of extensions that do not need to be Base64 encoded
55+
# @param [Profile] profile An instance of a Chrome::Profile Class
5756
# @param [Hash] opts the pre-defined options to create the Chrome::Options with
58-
# @option opts [Array<String>] :args List of command-line arguments to use when starting Chrome
59-
# @option opts [String] :binary Path to the Chrome executable to use
60-
# @option opts [Hash] :prefs A hash with each entry consisting of the name of the preference and its value
61-
# @option opts [Array<String>] :extensions A list of paths to (.crx) Chrome extensions to install on startup
62-
# @option opts [Hash] :options A hash for raw options
63-
# @option opts [Hash] :emulation A hash for raw emulation options
64-
# @option opts [Hash] :local_state A hash for the Local State file in the user data folder
65-
# @option opts [Boolean] :detach whether browser is closed when the driver is sent the quit command
66-
# @option opts [String] :debugger_address address of a Chrome debugger server to connect to
67-
# @option opts [Array<String>] :exclude_switches command line switches to exclude
68-
# @option opts [String] :minidump_path Directory to store Chrome minidumps (linux only)
69-
# @option opts [Hash] :perf_logging_prefs A hash for performance logging preferences
70-
# @option opts [Array<String>] :window_types A list of window types to appear in the list of window handles
57+
# @option opts [Array] encoded_extensions List of extensions that do not need to be Base64 encoded
58+
# @option opts [Array<String>] args List of command-line arguments to use when starting Chrome
59+
# @option opts [String] binary Path to the Chrome executable to use
60+
# @option opts [Hash] prefs A hash with each entry consisting of the name of the preference and its value
61+
# @option opts [Array<String>] extensions A list of paths to (.crx) Chrome extensions to install on startup
62+
# @option opts [Hash] options A hash for raw options
63+
# @option opts [Hash] emulation A hash for raw emulation options
64+
# @option opts [Hash] local_state A hash for the Local State file in the user data folder
65+
# @option opts [Boolean] detach whether browser is closed when the driver is sent the quit command
66+
# @option opts [String] debugger_address address of a Chrome debugger server to connect to
67+
# @option opts [Array<String>] exclude_switches command line switches to exclude
68+
# @option opts [String] minidump_path Directory to store Chrome minidumps (linux only)
69+
# @option opts [Hash] perf_logging_prefs A hash for performance logging preferences
70+
# @option opts [Array<String>] window_types A list of window types to appear in the list of window handles
7171
#
7272

7373
def initialize(profile: nil, **opts)
@@ -112,7 +112,7 @@ def add_extension(path)
112112
# options = Selenium::WebDriver::Chrome::Options.new
113113
# options.extensions = extensions
114114
#
115-
# @param [Array<String>] :extensions A list of paths to (.crx) Chrome extensions to install on startup
115+
# @param [Array<String>] extensions A list of paths to (.crx) Chrome extensions to install on startup
116116
#
117117

118118
def extensions=(extensions)

‎rb/lib/selenium/webdriver/common/driver_extensions/has_context.rb‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ module HasContext
2727
# a `with` statement. The state of the context on the server is
2828
# saved before entering the block, and restored upon exiting it.
2929
#
30-
# @param [String] name which permission to set
31-
# @param [String] value what to set the permission to
30+
# @param [String] value which context gets set (either 'chrome' or 'content')
3231
#
3332

3433
def context=(value)

‎rb/lib/selenium/webdriver/common/driver_extensions/has_pinned_scripts.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def pin_script(script)
6262
#
6363
# Unpins script making it undefined for the subsequent calls.
6464
#
65-
# @param [DevTools::PinnedScript]
65+
# @param [DevTools::PinnedScript] script
6666
#
6767

6868
def unpin_script(script)

‎rb/lib/selenium/webdriver/remote/bridge.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ class Bridge
3030

3131
#
3232
# Initializes the bridge with the given server URL
33-
# @param [String, URI] :url url for the remote server
34-
# @param [Object] :http_client an HTTP client instance that implements the same protocol as Http::Default
33+
# @param [String, URI] url url for the remote server
34+
# @param [Object] http_client an HTTP client instance that implements the same protocol as Http::Default
3535
# @api private
3636
#
3737

0 commit comments

Comments
 (0)