Merge pull request php-webdriver#1045 from OndraM/feature/test-modernize

Add typehints where safe, remove superfluous phpdoc

Author: OndraM

.php-cs-fixer.dist.php

@@ -62,6 +62,11 @@
         'no_leading_import_slash' => true,
         'no_leading_namespace_whitespace' => true,
         'no_singleline_whitespace_before_semicolons' => true,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'remove_inheritdoc' => true,
+            'allow_unused_params' => true, // Used in RemoteWebDriver::createBySessionID to maintain BC
+        ],
         'no_trailing_comma_in_singleline' => true,
         'no_unreachable_default_argument_value' => true,
         'no_unused_imports' => true,
@@ -96,8 +101,11 @@
         'phpdoc_scalar' => true,
         'phpdoc_single_line_var_spacing' => true,
         'phpdoc_trim' => true,
+        //'phpdoc_to_param_type' => true,
+        //'phpdoc_to_return_type' => true,
         'phpdoc_types' => true,
         'phpdoc_var_annotation_correct_order' => true,
+        //'pow_to_exponentiation' => true,
         'psr_autoloading' => true,
         'random_api_migration' => true,
         'self_accessor' => true,
@@ -118,6 +126,7 @@
         'trim_array_spaces' => true,
         'unary_operator_spaces' => true,
         'visibility_required' => ['elements' => ['method', 'property', 'const']],
+        //'void_return' => true,
         'whitespace_after_comma_in_array' => true,
         'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
     ])

lib/Chrome/ChromeOptions.php

@@ -65,7 +65,6 @@ public function setBinary($path)
     }
 
     /**
-     * @param array $arguments
      * @return ChromeOptions
      */
     public function addArguments(array $arguments)
@@ -79,7 +78,6 @@ public function addArguments(array $arguments)
      * Add a Chrome extension to install on browser startup. Each path should be
      * a packed Chrome extension.
      *
-     * @param array $paths
      * @return ChromeOptions
      */
     public function addExtensions(array $paths)

lib/Exception/Internal/RuntimeException.php

@@ -15,10 +15,6 @@ public static function forError(string $message): self
         return new self($message);
     }
 
-    /**
-     * @param Process $process
-     * @return RuntimeException
-     */
     public static function forDriverError(Process $process): self
     {
         return new self(

lib/Firefox/FirefoxOptions.php

@@ -97,7 +97,6 @@ public function setPreference($name, $value)
 
     /**
      * @see https://github.com/php-webdriver/php-webdriver/wiki/Firefox#firefox-profile
-     * @param FirefoxProfile $profile
      * @return self
      */
     public function setProfile(FirefoxProfile $profile)

lib/Interactions/Internal/WebDriverCoordinates.php

@@ -29,8 +29,6 @@ class WebDriverCoordinates
 
     /**
      * @param null $on_screen
-     * @param callable $in_view_port
-     * @param callable $on_page
      * @param string $auxiliary
      */
     public function __construct($on_screen, callable $in_view_port, callable $on_page, $auxiliary)

lib/Interactions/Internal/WebDriverKeysRelatedAction.php

@@ -24,11 +24,6 @@ abstract class WebDriverKeysRelatedAction
      */
     protected $locationProvider;
 
-    /**
-     * @param WebDriverKeyboard $keyboard
-     * @param WebDriverMouse $mouse
-     * @param WebDriverLocatable $location_provider
-     */
     public function __construct(
         WebDriverKeyboard $keyboard,
         WebDriverMouse $mouse,

lib/Interactions/Internal/WebDriverMouseAction.php

@@ -19,10 +19,6 @@ class WebDriverMouseAction
      */
     protected $locationProvider;
 
-    /**
-     * @param WebDriverMouse $mouse
-     * @param WebDriverLocatable|null $location_provider
-     */
     public function __construct(WebDriverMouse $mouse, WebDriverLocatable $location_provider = null)
     {
         $this->mouse = $mouse;

lib/Interactions/Internal/WebDriverMoveToOffsetAction.php

@@ -18,8 +18,6 @@ class WebDriverMoveToOffsetAction extends WebDriverMouseAction implements WebDri
     private $yOffset;
 
     /**
-     * @param WebDriverMouse $mouse
-     * @param WebDriverLocatable|null $location_provider
      * @param int|null $x_offset
      * @param int|null $y_offset
      */

lib/Interactions/Internal/WebDriverSendKeysAction.php

@@ -15,9 +15,6 @@ class WebDriverSendKeysAction extends WebDriverKeysRelatedAction implements WebD
     private $keys = '';
 
     /**
-     * @param WebDriverKeyboard $keyboard
-     * @param WebDriverMouse $mouse
-     * @param WebDriverLocatable $location_provider
      * @param string $keys
      */
     public function __construct(

lib/Interactions/Touch/WebDriverDownAction.php

@@ -16,7 +16,6 @@ class WebDriverDownAction extends WebDriverTouchAction implements WebDriverActio
     private $y;
 
     /**
-     * @param WebDriverTouchScreen $touch_screen
      * @param int $x
      * @param int $y
      */