Browse Source

Copy and paste documentation about binary classes

Daniel Gempesaw 10 years ago
parent
commit
6004374916
3 changed files with 41 additions and 6 deletions
  1. 2 2
      lib/Selenium/Chrome.pm
  2. 19 2
      lib/Selenium/Firefox.pm
  3. 20 2
      lib/Selenium/PhantomJS.pm

+ 2 - 2
lib/Selenium/Chrome.pm

@@ -12,14 +12,14 @@ extends 'Selenium::Remote::Driver';
 =head1 DESCRIPTION
 =head1 DESCRIPTION
 
 
 This class allows you to use the ChromeDriver without needing the JRE
 This class allows you to use the ChromeDriver without needing the JRE
-or a selenium server running. If you refrain from passing the
+or a selenium server running. When you refrain from passing the
 C<remote_server_addr> and C<port> arguments, we will search for the
 C<remote_server_addr> and C<port> arguments, we will search for the
 chromedriver executable binary in your $PATH. We'll try to start the
 chromedriver executable binary in your $PATH. We'll try to start the
 binary connect to it, shutting it down at the end of the test.
 binary connect to it, shutting it down at the end of the test.
 
 
 If the chromedriver binary is not found, we'll fall back to the
 If the chromedriver binary is not found, we'll fall back to the
 default L<Selenium::Remote::Driver> behavior of assuming defaults of
 default L<Selenium::Remote::Driver> behavior of assuming defaults of
-127.0.0.1:4444.
+127.0.0.1:4444 after waiting a few seconds.
 
 
 If you specify a remote server address, or a port, we'll assume you
 If you specify a remote server address, or a port, we'll assume you
 know what you're doing and take no additional behavior.
 know what you're doing and take no additional behavior.

+ 19 - 2
lib/Selenium/Firefox.pm

@@ -9,9 +9,26 @@ with 'Selenium::BinaryModeBuilder';
 
 
 my $driver = Selenium::Firefox->new;
 my $driver = Selenium::Firefox->new;
 
 
-=cut
+=head1 DESCRIPTION
+
+This class allows you to use the FirefoxDriver without needing the JRE
+or a selenium server running. When you refrain from passing the
+C<remote_server_addr> and C<port> arguments, we will search for the
+Firefox executable in your $PATH. We'll try to start the binary
+connect to it, shutting it down at the end of the test.
+
+If the Firefox application is not found in the expected places, we'll
+fall back to the default L<Selenium::Remote::Driver> behavior of
+assuming defaults of 127.0.0.1:4444 after waiting a few seconds.
 
 
-use constant FIREFOX_PORT => 9090;
+If you specify a remote server address, or a port, we'll assume you
+know what you're doing and take no additional behavior.
+
+If you're curious whether your Selenium::Firefox instance is using a
+separate Firefox binary, or through the selenium server, you can check
+the C<binary_mode> attr after instantiation.
+
+=cut
 
 
 has '+browser_name' => (
 has '+browser_name' => (
     is => 'ro',
     is => 'ro',

+ 20 - 2
lib/Selenium/PhantomJS.pm

@@ -9,9 +9,27 @@ extends 'Selenium::Remote::Driver';
 
 
     my $driver = Selenium::PhantomJS->new;
     my $driver = Selenium::PhantomJS->new;
 
 
-=cut
+=head1 DESCRIPTION
+
+This class allows you to use PhantomJS through Ghostdriver without
+needing the JRE or a selenium server running. When you refrain from
+passing the C<remote_server_addr> and C<port> arguments, we will
+search for the phantomjs executable binary in your $PATH. We'll try
+to start the binary connect to it, shutting it down at the end of the
+test.
+
+If the binary is not found, we'll fall back to the default
+L<Selenium::Remote::Driver> behavior of assuming defaults of
+127.0.0.1:4444 after waiting a few seconds.
 
 
-use constant PHANTOMJS_PORT => 8910;
+If you specify a remote server address, or a port, we'll assume you
+know what you're doing and take no additional behavior.
+
+If you're curious whether your Selenium::PhantomJS instance is using a
+separate PhantomJS binary, or through the selenium server, you can check
+the C<binary_mode> attr after instantiation.
+
+=cut
 
 
 has '+browser_name' => (
 has '+browser_name' => (
     is => 'ro',
     is => 'ro',