Merge pull request #954 from mortenhauberg/fix-docblocks

Fix docblocks
ruflin · Oct 15, 2015 · 9bb2ef1 · 9bb2ef1
2 parents 6fe305a + efc269b
commit 9bb2ef1
Show file tree

Hide file tree

Showing 18 changed files with 45 additions and 27 deletions.
diff --git a/lib/Elastica/Aggregation/AbstractTermsAggregation.php b/lib/Elastica/Aggregation/AbstractTermsAggregation.php
@@ -2,7 +2,7 @@
 namespace Elastica\Aggregation;
 
 /**
- * Class AbstractTermsAggergation.
+ * Class AbstractTermsAggregation.
  */
 abstract class AbstractTermsAggregation extends AbstractSimpleAggregation
 {

diff --git a/lib/Elastica/Aggregation/DateHistogram.php b/lib/Elastica/Aggregation/DateHistogram.php
@@ -105,7 +105,7 @@ public function setPostOffset($offset)
     /**
      * Set offset option.
      *
-     * @param  string
+     * @param string
      *
      * @return $this
      */
@@ -127,11 +127,15 @@ public function setFormat($format)
     {
         return $this->setParam('format', $format);
     }
-    
+
     /**
      * Set extended bounds option.
      *
-     * @param  string
+     * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html#search-aggregations-bucket-histogram-aggregation-extended-bounds
+     *
+     * @param string $min see link for formatting options
+     *
+     * @param string $max see link for formatting options
      *
      * @return $this
      */

diff --git a/lib/Elastica/Bulk.php b/lib/Elastica/Bulk.php
@@ -194,7 +194,7 @@ public function addDocuments(array $documents, $opType = null)
     }
 
     /**
-     * @param \Elastica\Script $data
+     * @param \Elastica\Script $script
      * @param string           $opType
      *
      * @return $this
@@ -222,7 +222,7 @@ public function addScripts(array $scripts, $opType = null)
     }
 
     /**
-     * @param \Elastica\Script|\Elastica\Document\array $data
+     * @param \Elastica\Script|\Elastica\Document|array $data
      * @param string                                    $opType
      *
      * @return $this

diff --git a/lib/Elastica/Bulk/Action/IndexDocument.php b/lib/Elastica/Bulk/Action/IndexDocument.php
@@ -26,7 +26,7 @@ public function setDocument(Document $document)
     }
 
     /**
-     * @param \Elastica\AbstractUpdateAction $source
+     * @param \Elastica\AbstractUpdateAction $action
      *
      * @return array
      */

diff --git a/lib/Elastica/Bulk/ResponseSet.php b/lib/Elastica/Bulk/ResponseSet.php
@@ -99,8 +99,8 @@ public function current()
         }
     }
 
-    /**
-     *
+	/**
+     * @return void
      */
     public function next()
     {
@@ -124,7 +124,7 @@ public function valid()
     }
 
     /**
-     *
+     * @return void
      */
     public function rewind()
     {

diff --git a/lib/Elastica/Client.php b/lib/Elastica/Client.php
@@ -532,7 +532,7 @@ public function setConnections(array $connections)
      * @param array                  $ids     Document ids
      * @param string|\Elastica\Index $index   Index name
      * @param string|\Elastica\Type  $type    Type of documents
-     * @param string|false           $routing Optional routing key for all ids
+     * @param string|bool            $routing Optional routing key for all ids
      *
      * @throws \Elastica\Exception\InvalidException
      *

diff --git a/lib/Elastica/Filter/AbstractMulti.php b/lib/Elastica/Filter/AbstractMulti.php
@@ -15,8 +15,8 @@ abstract class AbstractMulti extends AbstractFilter
      */
     protected $_filters = array();
 
-    /**
-     * @param \Elastica\Filter\AbstractFilter $filters
+	/**
+     * @param array $filters
      */
     public function __construct(array $filters = array())
     {

diff --git a/lib/Elastica/Index.php b/lib/Elastica/Index.php
@@ -318,7 +318,7 @@ public function createSearch($query = '', $options = null)
      * @param string|array|\Elastica\Query $query   Array with all query data inside or a Elastica\Query object
      * @param int|array                    $options OPTIONAL Limit or associative array of options (option=>value)
      *
-     * @return \Elastica\ResultSet ResultSet with all results inside
+     * @return \Elastica\ResultSet with all results inside
      *
      * @see \Elastica\SearchableInterface::search
      */
@@ -452,7 +452,9 @@ public function clearCache()
     /**
      * Flushes the index to storage.
      *
-     * @return \Elastica\Response Response object
+     * @param bool $refresh
+     *
+     * @return Response Response object
      *
      * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html
      */

diff --git a/lib/Elastica/Query/FunctionScore.php b/lib/Elastica/Query/FunctionScore.php
@@ -114,7 +114,6 @@ public function addScriptScoreFunction(Script $script, AbstractFilter $filter =
      * @param string         $scale       a scale to define the rate of decay for this function
      * @param string         $offset      If defined, this function will only be computed for documents with a distance from the origin greater than this value
      * @param float          $decay       optionally defines how documents are scored at the distance given by the $scale parameter
-     * @param float          $scaleWeight optional factor by which to multiply the score at the value provided by the $scale parameter
      * @param float          $weight      optional factor by which to multiply the score at the value provided by the $scale parameter
      * @param AbstractFilter $filter      a filter associated with this function
      *

diff --git a/lib/Elastica/Query/Fuzzy.php b/lib/Elastica/Query/Fuzzy.php
@@ -70,6 +70,10 @@ public function setFieldOption($param, $value)
      * Deprecated method of setting a field.
      *
      * @deprecated
+     *
+     * @param $fieldName
+     * @param $args
+     * @return $this
      */
     public function addField($fieldName, $args)
     {

diff --git a/lib/Elastica/Query/MultiMatch.php b/lib/Elastica/Query/MultiMatch.php
@@ -131,7 +131,6 @@ public function setCutoffFrequency($cutoffFrequency)
     /**
      * Set type.
      *
-     * @param string $field
      * @param string $type
      *
      * @return $this

diff --git a/lib/Elastica/Rescore/Query.php b/lib/Elastica/Rescore/Query.php
@@ -15,7 +15,6 @@ class Query extends AbstractRescore
     /**
      * Constructor.
      *
-     * @param string|\Elastica\Query\AbstractQuery $rescoreQuery
      * @param string|\Elastica\Query\AbstractQuery $query
      */
     public function __construct($query = null)
@@ -50,7 +49,7 @@ public function toArray()
     /**
      * Sets rescoreQuery object.
      *
-     * @param string|\Elastica\Query|\Elastica\Query\AbstractQuery $query
+     * @param string|\Elastica\Query|\Elastica\Query\AbstractQuery $rescoreQuery
      *
      * @return $this
      */
@@ -82,7 +81,7 @@ public function setQueryWeight($weight)
     /**
      * Sets rescore_query_weight.
      *
-     * @param float $size
+     * @param float $weight
      *
      * @return $this
      */

diff --git a/lib/Elastica/SearchableInterface.php b/lib/Elastica/SearchableInterface.php
@@ -27,7 +27,9 @@ interface SearchableInterface
      *
      * @param string|array|\Elastica\Query $query Array with all query data inside or a Elastica\Query object
      *
-     * @return \Elastica\ResultSet ResultSet with all results inside
+     * @param null $options
+     *
+     * @return \Elastica\ResultSet with all results inside
      */
     public function search($query = '', $options = null);
 
@@ -43,7 +45,7 @@ public function search($query = '', $options = null);
     public function count($query = '');
 
     /**
-     * @param \Elastica\Query $query
+     * @param \Elastica\Query|string $query
      * @param array           $options
      *
      * @return \Elastica\Search

diff --git a/lib/Elastica/Suggest/Completion.php b/lib/Elastica/Suggest/Completion.php
@@ -2,7 +2,7 @@
 namespace Elastica\Suggest;
 
 /**
- * Comletion suggester.
+ * Completion suggester.
  *
  * @author Igor Denisenko <[email protected]>
  *

diff --git a/lib/Elastica/Transport/Guzzle.php b/lib/Elastica/Transport/Guzzle.php
@@ -142,6 +142,8 @@ protected function _getGuzzleClient($baseUrl, $persistent = true)
      * Builds the base url for the guzzle connection.
      *
      * @param \Elastica\Connection $connection
+     *
+     * @return string
      */
     protected function _getBaseUrl(Connection $connection)
     {
@@ -161,6 +163,8 @@ protected function _getBaseUrl(Connection $connection)
      * Builds the action path url for each request.
      *
      * @param \Elastica\Request $request
+     *
+     * @return string
      */
     protected function _getActionPath(Request $request)
     {

diff --git a/lib/Elastica/Transport/HttpAdapter.php b/lib/Elastica/Transport/HttpAdapter.php
@@ -26,6 +26,9 @@ class HttpAdapter extends AbstractTransport
 
     /**
      * Construct transport.
+     *
+     * @param Connection $connection
+     * @param HttpAdapterInterface $httpAdapter
      */
     public function __construct(Connection $connection = null, HttpAdapterInterface $httpAdapter)
     {

diff --git a/lib/Elastica/Type.php b/lib/Elastica/Type.php
@@ -342,7 +342,7 @@ public function createSearch($query = '', $options = null)
      * @param string|array|\Elastica\Query $query   Array with all query data inside or a Elastica\Query object
      * @param int|array                    $options OPTIONAL Limit or associative array of options (option=>value)
      *
-     * @return \Elastica\ResultSet ResultSet with all results inside
+     * @return \Elastica\ResultSet with all results inside
      *
      * @see \Elastica\SearchableInterface::search
      */
@@ -456,7 +456,7 @@ public function deleteById($id, array $options = array())
      * Deletes the given list of ids from this type.
      *
      * @param array        $ids
-     * @param string|false $routing Optional routing key for all ids
+     * @param string|bool $routing Optional routing key for all ids
      *
      * @return \Elastica\Response Response  object
      */

diff --git a/lib/Elastica/Type/AbstractType.php b/lib/Elastica/Type/AbstractType.php
@@ -131,7 +131,7 @@ public function create($recreate = false)
     }
 
     /**
-     * @param \Elastica\Query $query
+     * @param string|\Elastica\Query $query
      * @param array|int       $options
      *
      * @return \Elastica\Search
@@ -146,7 +146,9 @@ public function createSearch($query = '', $options = null)
      *
      * @param string|array|\Elastica\Query $query Array with all query data inside or a Elastica\Query object
      *
-     * @return \Elastica\ResultSet ResultSet with all results inside
+     * @param null $options
+     *
+     * @return \Elastica\ResultSet with all results inside
      *
      * @see \Elastica\SearchableInterface::search
      */
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,7 +26,7 @@ public function setDocument(Document $document) @@
         }
         /**
-         * @param \Elastica\AbstractUpdateAction $source
+         * @param \Elastica\AbstractUpdateAction $action
          *
          * @return array
          */
@@ Expand Down @@