Fixed docblocks

Author: Swader

src/Api/Article.php

@@ -14,7 +14,7 @@ class Article extends Api
 
     /**
      * @see Swader\Diffbot\Entity\Article::getSentiment()
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setSentiment($bool)

src/Api/Crawl.php

@@ -137,7 +137,7 @@ public function setUrlCrawlPatterns(array $pattern = null)
      * The use of a urlCrawlRegEx will allow Crawlbot to spider outside of the
      * seed domain; it will follow all matching URLs regardless of domain.
      *
-     * @param $regex
+     * @param string $regex
      * @return $this
      */
     public function setUrlCrawlRegEx($regex)
@@ -172,7 +172,7 @@ public function setUrlProcessPatterns(array $pattern = null)
      * Specify a regular expression to limit pages processed to those URLs that
      * match your expression. This will override any urlProcessPattern value.
      *
-     * @param $regex
+     * @param string $regex
      * @return $this
      */
     public function setUrlProcessRegEx($regex)
@@ -262,7 +262,7 @@ public function setMaxToProcess($input = 100000)
      * X-Crawl-Status in the headers, and the full JSON response in the
      * POST body.
      *
-     * @param $string
+     * @param string $string
      * @return $this
      * @throws InvalidArgumentException
      */
@@ -309,11 +309,12 @@ public function setCrawlDelay($input = 0.25)
      *
      * @param int|float $input
      * @return $this
+     * @throws \InvalidArgumentException
      */
     public function setRepeat($input)
     {
         if (!is_numeric($input) || !$input) {
-            throw new InvalidArgumentException('Only positive numbers allowed.');
+            throw new \InvalidArgumentException('Only positive numbers allowed.');
         }
         $this->otherOptions['repeat'] = (float)$input;
 

src/Api/Discussion.php

@@ -32,7 +32,7 @@ public function setMaxPages($max = 1)
 
     /**
      * @see Swader\Diffbot\Entity\Discussion::getSentiment()
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setSentiment($bool)

src/Api/Image.php

@@ -15,7 +15,7 @@ class Image extends Api
     /**
      * Tells the API call to return the mentions field
      * @see https://www.diffbot.com/dev/docs/image/
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setMentions($bool)
@@ -27,7 +27,7 @@ public function setMentions($bool)
     /**
      * Sets the API call to return the faces field
      * @see https://www.diffbot.com/dev/docs/image/
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setFaces($bool)
@@ -39,7 +39,7 @@ public function setFaces($bool)
     /**
      * Sets the API call to return the ocr field.
      * @see https://www.diffbot.com/dev/docs/image/
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setOcr($bool)

src/Api/Product.php

@@ -27,7 +27,7 @@ public function setDiscussion($bool = true)
 
     /**
      * @see Swader\Diffbot\Entity\Product::getColors()
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setColors($bool)
@@ -39,7 +39,7 @@ public function setColors($bool)
 
     /**
      * @see Swader\Diffbot\Entity\Product::getSize()
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setSize($bool)
@@ -51,7 +51,7 @@ public function setSize($bool)
 
     /**
      * @see Swader\Diffbot\Entity\Product::isAvailable()
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setAvailability($bool)

src/Api/Search.php

@@ -5,6 +5,7 @@
 use Swader\Diffbot\Abstracts\Api;
 use Swader\Diffbot\Entity\SearchInfo;
 use Swader\Diffbot\Traits\DiffbotAware;
+use Swader\Diffbot\Entity\EntityIterator;
 
 /**
  * Class Search
@@ -32,7 +33,7 @@ class Search extends Api
     /**
      * Search query.
      * @see https://www.diffbot.com/dev/docs/search/#query
-     * @param string $q
+     * @param string string $q
      */
     public function __construct($q)
     {
@@ -129,7 +130,7 @@ public function buildUrl()
      *
      * @todo: remove error avoidance when issue 12 is fixed: https://github.com/Swader/diffbot-php-client/issues/12
      * @param bool $info
-     * @return \Swader\Diffbot\Entity\EntityIterator|SearchInfo
+     * @return EntityIterator|SearchInfo
      */
     public function call($info = false)
     {

src/Traits/StandardApi.php

@@ -11,7 +11,7 @@ trait StandardApi {
 
     /**
      * Makes the API call return the links field, common to all standard API types
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setLinks($bool)
@@ -22,7 +22,7 @@ public function setLinks($bool)
 
     /**
      * Makes the API call return the meta field, common to all standard API types
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setMeta($bool)
@@ -33,7 +33,7 @@ public function setMeta($bool)
 
     /**
      * Makes the API call return the querystring field, common to all standard API types
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setQuerystring($bool)
@@ -44,12 +44,12 @@ public function setQuerystring($bool)
 
     /**
      * Makes the API call return the breadcrumb field, common to all standard API types
-     * @param $bool
+     * @param bool|mixed $bool
      * @return $this
      */
     public function setBreadcrumb($bool)
     {
         $this->fieldSettings['breadcrumb'] = (bool)$bool;
         return $this;
     }
-}
+}