Browse Source

Fix #383: correct ordering of constructor params in S::R::D POD

George S. Baugh 7 years ago
parent
commit
cbe27e0518
3 changed files with 33 additions and 29 deletions
  1. 4 0
      Changes
  2. 1 1
      dist.ini
  3. 28 28
      lib/Selenium/Remote/Driver.pm

+ 4 - 0
Changes

@@ -1,5 +1,9 @@
 Revision history for Selenium-Remote-Driver
 
+1.28   ??-??-???? TEODESIAN
+        [BUG FIXES]
+        - Fix incorrect documentation of constructor fields.
+
 1.27   03-25-2018 TEODESIAN
         [BUG FIXES]
         - Fix incorrect passing of capabilities to geckodriver which caused exceptions on instantiaion.

+ 1 - 1
dist.ini

@@ -1,5 +1,5 @@
 name = Selenium-Remote-Driver
-version = 1.27
+version = 1.28
 author = George S. Baugh <george@troglodyne.net>
 author = Aditya Ivaturi <ivaturi@gmail.com>
 author = Daniel Gempesaw <gempesaw@gmail.com>

+ 28 - 28
lib/Selenium/Remote/Driver.pm

@@ -278,8 +278,6 @@ Desired capabilities - HASH - Following options are accepted:
 
 =item B<firefox_profile>    - Profile    - Use Selenium::Firefox::Profile to create a Firefox profile for the browser to use.  Optionally can pass a base64'd zip data of a profile directory if you don't like Selenium::Firefox::Profile.
 
-=item B<proxy>              - HASH       - Proxy configuration with the following keys:
-
 =item B<javascript>         - <boolean> - Whether or not to use Javascript.  You probably won't disable this, as you would be using L<WWW::Mechanize> instead.  Default: True
 
 =item B<auto_close>         - <boolean> - Whether to automatically close the browser session on the server when the object goes out of scope. Default: False.
@@ -288,32 +286,6 @@ Desired capabilities - HASH - Following options are accepted:
 
 =item B<session_id>         - <string> - Provide a Session ID to highjack a browser session on the remote server.  Useful for micro-optimizers.  Default: undef
 
-=over 4
-
-=item B<proxyType> - <string> - REQUIRED, Possible values are:
-
-    direct     - A direct connection - no proxy in use,
-    manual     - Manual proxy settings configured, e.g. setting a proxy for HTTP, a proxy for FTP, etc,
-    pac        - Proxy autoconfiguration from a URL,
-    autodetect - proxy autodetection, probably with WPAD,
-    system     - Use system settings
-
-=item B<proxyAutoconfigUrl> - <string> - REQUIRED if proxyType is 'pac', ignored otherwise. Expected format: http://hostname.com:1234/pacfile or file:///path/to/pacfile
-
-=item B<ftpProxy>           - <string> - OPTIONAL, ignored if proxyType is not 'manual'. Expected format: hostname.com:1234
-
-=item B<httpProxy>          - <string> - OPTIONAL, ignored if proxyType is not 'manual'. Expected format: hostname.com:1234
-
-=item B<sslProxy>           - <string> - OPTIONAL, ignored if proxyType is not 'manual'. Expected format: hostname.com:1234
-
-=item B<socksProxy>         - <string> - OPTIONAL, ignored if proxyType is not 'manual'. Expected format: hostname.com:1234.  WebDriver 3 only.
-
-=item B<socksVersion>       - <int>    - OPTIONAL, ignored if proxyType is not 'manual'. WebDriver 3 only.
-
-=item B<noProxy>            - <ARRAY>  - OPTIONAL, list of URLs to bypass the proxy for. WebDriver3 only.
-
-=back
-
 =item B<pageLoadStrategy>   - STRING   - OPTIONAL, 'normal|eager|none'. default 'normal'. WebDriver3 only.
 
 =item B<extra_capabilities> - HASH     - Any other extra capabilities.  Accepted keys will vary by browser.  If firefox_profile is passed, the args (or profile) key will be overwritten, depending on how it was passed.
@@ -342,6 +314,34 @@ not part of the browser-related desired capabilities.
 
 =item B<ua>                - LWP::UserAgent instance - if you wish to use a specific $ua, like from Test::LWP::UserAgent
 
+=item B<proxy>              - HASH       - Proxy configuration with the following keys:
+
+=over 4
+
+=item B<proxyType> - <string> - REQUIRED, Possible values are:
+
+    direct     - A direct connection - no proxy in use,
+    manual     - Manual proxy settings configured, e.g. setting a proxy for HTTP, a proxy for FTP, etc,
+    pac        - Proxy autoconfiguration from a URL,
+    autodetect - proxy autodetection, probably with WPAD,
+    system     - Use system settings
+
+=item B<proxyAutoconfigUrl> - <string> - REQUIRED if proxyType is 'pac', ignored otherwise. Expected format: http://hostname.com:1234/pacfile or file:///path/to/pacfile
+
+=item B<ftpProxy>           - <string> - OPTIONAL, ignored if proxyType is not 'manual'. Expected format: hostname.com:1234
+
+=item B<httpProxy>          - <string> - OPTIONAL, ignored if proxyType is not 'manual'. Expected format: hostname.com:1234
+
+=item B<sslProxy>           - <string> - OPTIONAL, ignored if proxyType is not 'manual'. Expected format: hostname.com:1234
+
+=item B<socksProxy>         - <string> - OPTIONAL, ignored if proxyType is not 'manual'. Expected format: hostname.com:1234.  WebDriver 3 only.
+
+=item B<socksVersion>       - <int>    - OPTIONAL, ignored if proxyType is not 'manual'. WebDriver 3 only.
+
+=item B<noProxy>            - <ARRAY>  - OPTIONAL, list of URLs to bypass the proxy for. WebDriver3 only.
+
+=back
+
 =back
 
 Output: