Improve PHPDoc - missing @params, variable types, inconsistencies, typos etc.

Author: OndraM

lib/WebDriver.php

@@ -28,6 +28,7 @@ public function close();
   /**
    * Load a new web page in the current browser window.
    *
+   * @param string $url
    * @return WebDriver The current instance.
    */
   public function get($url);
@@ -91,6 +92,8 @@ public function takeScreenshot($save_as = null);
    *     WebDriverExpectedCondition::titleIs('WebDriver Page')
    *   );
    *
+   * @param int $timeout_in_second
+   * @param int $interval_in_millisecond
    * @return WebDriverWait
    */
   public function wait(

lib/WebDriverAlert.php

@@ -56,6 +56,7 @@ public function getText() {
   /**
    * Send keystrokes to javascript prompt() dialog
    *
+   * @param string $value
    * @return WebDriverAlert
    */
   public function sendKeys($value) {

lib/WebDriverBy.php

@@ -48,6 +48,7 @@ public function getValue() {
    * Locates elements whose class name contains the search value; compound class
    * names are not permitted.
    *
+   * @param string $class_name
    * @return WebDriverBy
    */
   public static function className($class_name) {
@@ -57,6 +58,7 @@ public static function className($class_name) {
   /**
    * Locates elements matching a CSS selector.
    *
+   * @param string $css_selector
    * @return WebDriverBy
    */
   public static function cssSelector($css_selector) {
@@ -66,6 +68,7 @@ public static function cssSelector($css_selector) {
   /**
    * Locates elements whose ID attribute matches the search value.
    *
+   * @param string $id
    * @return WebDriverBy
    */
   public static function id($id) {
@@ -74,6 +77,8 @@ public static function id($id) {
 
   /**
    * Locates elements whose NAME attribute matches the search value.
+   *
+   * @param string $name
    * @return WebDriverBy
    */
   public static function name($name) {
@@ -83,6 +88,7 @@ public static function name($name) {
   /**
    * Locates anchor elements whose visible text matches the search value.
    *
+   * @param string $link_text
    * @return WebDriverBy
    */
   public static function linkText($link_text) {
@@ -93,6 +99,7 @@ public static function linkText($link_text) {
    * Locates anchor elements whose visible text partially matches the search
    * value.
    *
+   * @param string $partial_link_text
    * @return WebDriverBy
    */
   public static function partialLinkText($partial_link_text) {
@@ -102,6 +109,7 @@ public static function partialLinkText($partial_link_text) {
   /**
    * Locates elements whose tag name matches the search value.
    *
+   * @param string $tag_name
    * @return WebDriverBy
    */
   public static function tagName($tag_name) {
@@ -111,6 +119,7 @@ public static function tagName($tag_name) {
   /**
    * Locates elements matching an XPath expression.
    *
+   * @param string $xpath
    * @return WebDriverBy
    */
   public static function xpath($xpath) {

lib/WebDriverCapabilities.php

@@ -21,6 +21,7 @@ interface WebDriverCapabilities {
   public function getBrowserName();
 
   /**
+   * @param string $name
    * @return mixed The value of a capability.
    */
   public function getCapability($name);
@@ -36,6 +37,7 @@ public function getPlatform();
   public function getVersion();
 
   /**
+   * @param string $capability_name
    * @return bool Whether the value is not null and not false.
    */
   public function is($capability_name);

lib/WebDriverCommandExecutor.php

@@ -19,6 +19,7 @@
 interface WebDriverCommandExecutor {
 
   /**
+   * @param WebDriverCommand $command
    * @return mixed
    */
   public function execute(WebDriverCommand $command);

lib/WebDriverElement.php

@@ -52,15 +52,15 @@ public function getCSSValue($css_property_name);
   /**
    * Get the location of element relative to the top-left corner of the page.
    *
-   * @return WebDriverLocation The location of the element.
+   * @return WebDriverPoint The location of the element.
    */
   public function getLocation();
 
   /**
    * Try scrolling the element into the view port and return the location of
    * element relative to the top-left corner of the page afterwards.
    *
-   * @return WebDriverLocation The location of the element.
+   * @return WebDriverPoint The location of the element.
    */
   public function getLocationOnScreenOnceScrolledIntoView();
 

lib/WebDriverExceptions.php

@@ -19,11 +19,18 @@ class WebDriverException extends Exception {
 
   private $results;
 
+  /**
+   * @param string $message
+   * @param mixed $results
+   */
   public function __construct($message, $results = null) {
     parent::__construct($message);
     $this->results = $results;
   }
 
+  /**
+   * @return mixed
+   */
   public function getResults() {
     return $this->results;
   }
@@ -32,6 +39,10 @@ public function getResults() {
    * Throw WebDriverExceptions.
    * For $status_code >= 0, they are errors defined in the json wired protocol.
    * For $status_code < 0, they are errors defined in php-webdriver.
+   *
+   * @param int $status_code
+   * @param string $message
+   * @param mixed $results
    */
   public static function throwException($status_code, $message, $results) {
     switch ($status_code) {
@@ -154,9 +165,13 @@ class UnrecognizedExceptionException extends WebDriverException {}
 
 class UnexpectedTagNameException extends WebDriverException {
 
+  /**
+   * @param string $expected_tag_name
+   * @param string $actual_tag_name
+   */
   public function __construct(
-      string $expected_tag_name,
-      string $actual_tag_name) {
+      $expected_tag_name,
+      $actual_tag_name) {
     parent::__construct(
       sprintf(
         "Element should have been \"%s\" but was \"%s\"",

lib/WebDriverExpectedCondition.php

@@ -40,7 +40,7 @@ protected function __construct($apply) {
   /**
    * An expectation for checking the title of a page.
    *
-   * @param string title The expected title, which must be an exact match.
+   * @param string $title The expected title, which must be an exact match.
    * @return WebDriverExpectedCondition<bool> True when the title matches,
    *         false otherwise.
    */
@@ -55,7 +55,7 @@ function ($driver) use ($title) {
   /**
    * An expectation for checking substring of a page Title.
    *
-   * @param string title The expected substring of Title.
+   * @param string $title The expected substring of Title.
    * @return WebDriverExpectedCondition<bool> True when in title,
    *         false otherwise.
    */
@@ -187,7 +187,7 @@ function ($driver) use ($by, $text) {
    * Expectation for checking if iFrame exists.
    * If iFrame exists switches driver's focus to the iFrame
    *
-   * @param string frame_locator The locator used to find the iFrame
+   * @param string $frame_locator The locator used to find the iFrame
    *   expected to be either the id or name value of the i/frame
    * @return WebDriverExpectedCondition<WebDriver> object focused on new frame
    *         when frame is found bool false otherwise
@@ -328,7 +328,7 @@ function ($driver) use ($condition) {
   /**
    * An expectation for checking if the given element is selected.
    *
-   * @param mixed element_or_by Either the element or the locator.
+   * @param mixed $element_or_by Either the element or the locator.
    * @return WebDriverExpectedCondition<bool> whether the element is selected.
    */
   public static function elementToBeSelected($element_or_by) {

lib/WebDriverKeys.php

@@ -86,7 +86,7 @@ class WebDriverKeys {
 
   /**
    * Encode input of `sendKeys()`.
-   * @params string|array $keys
+   * @param string|array $keys
    * @return array
    */
   public static function encode($keys) {

lib/WebDriverMouse.php

@@ -19,33 +19,41 @@
 interface WebDriverMouse {
 
   /**
+   * @param WebDriverCoordinates $where
    * @return WebDriverMouse
    */
   public function click(WebDriverCoordinates $where);
 
   /**
+   * @param WebDriverCoordinates $where
    * @return WebDriverMouse
    */
   public function contextClick(WebDriverCoordinates $where);
 
   /**
+   * @param WebDriverCoordinates $where
    * @return WebDriverMouse
    */
   public function doubleClick(WebDriverCoordinates $where);
 
   /**
+   * @param WebDriverCoordinates $where
    * @return WebDriverMouse
    */
   public function mouseDown(WebDriverCoordinates $where);
 
   /**
+   * @param WebDriverCoordinates $where
+   * @param int $x_offset
+   * @param int $y_offset
    * @return WebDriverMouse
    */
   public function mouseMove(WebDriverCoordinates $where,
                             $x_offset = null,
                             $y_offset = null);
 
   /**
+   * @param WebDriverCoordinates $where
    * @return WebDriverMouse
    */
   public function mouseUp(WebDriverCoordinates $where);