Fixing bad PHPDocs for methods.

library/Solarium/Core/Client/Client.php

@@ -750,8 +750,8 @@ class Client extends Configurable
     /**
      * Execute a query
      *
-     * @param QueryInterface
-     * @param Endpoint|string|null
+     * @param QueryInterface       $query
+     * @param Endpoint|string|null $endpoint
      * @return ResultInterface
      */
     public function execute(QueryInterface $query, $endpoint = null)
@@ -819,8 +819,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\Ping\Query $query
-     * @param Endpoint|string|null
+     * @param QueryInterface|\Solarium\QueryType\Ping\Query $query
+     * @param Endpoint|string|null                          $endpoint
      * @return \Solarium\QueryType\Ping\Result
      */
     public function ping(QueryInterface $query, $endpoint = null)
@@ -845,8 +845,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\Update\Query\Query $query
-     * @param Endpoint|string|null
+     * @param QueryInterface|\Solarium\QueryType\Update\Query\Query $query
+     * @param Endpoint|string|null                                  $endpoint
      * @return \Solarium\QueryType\Update\Result
      */
     public function update(QueryInterface $query, $endpoint = null)
@@ -870,8 +870,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\Select\Query\Query $query
-     * @param Endpoint|string|null
+     * @param QueryInterface|\Solarium\QueryType\Select\Query\Query $query
+     * @param Endpoint|string|null                                  $endpoint
      * @return \Solarium\QueryType\Select\Result\Result
      */
     public function select(QueryInterface $query, $endpoint = null)
@@ -895,8 +895,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\MoreLikeThis\Query $query
-     * @param Endpoint
+     * @param QueryInterface|\Solarium\QueryType\MoreLikeThis\Query $query
+     * @param Endpoint|string|null                                  $endpoint
      * @return \Solarium\QueryType\MoreLikeThis\Result
      */
     public function moreLikeThis(QueryInterface $query, $endpoint = null)
@@ -910,8 +910,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\Analysis\Query\Document|\Solarium\QueryType\Analysis\Query\Field $query
-     * @param Endpoint
+     * @param QueryInterface|\Solarium\QueryType\Analysis\Query\Document|\Solarium\QueryType\Analysis\Query\Field $query
+     * @param Endpoint|string|null                                                                                $endpoint
      * @return \Solarium\QueryType\Analysis\Result\Document|\Solarium\QueryType\Analysis\Result\Field
      */
     public function analyze(QueryInterface $query, $endpoint = null)
@@ -925,8 +925,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\Terms\Query $query
-     * @param Endpoint|string|null
+     * @param QueryInterface|\Solarium\QueryType\Terms\Query $query
+     * @param Endpoint|string|null                           $endpoint
      * @return \Solarium\QueryType\Terms\Result
      */
     public function terms(QueryInterface $query, $endpoint = null)
@@ -940,8 +940,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\Suggester\Query $query
-     * @param Endpoint|string|null
+     * @param QueryInterface|\Solarium\QueryType\Suggester\Query $query
+     * @param Endpoint|string|null                               $endpoint
      * @return \Solarium\QueryType\Suggester\Result\Result
      */
     public function suggester(QueryInterface $query, $endpoint = null)
@@ -955,8 +955,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\Extract\Query $query
-     * @param Endpoint|string|null
+     * @param QueryInterface|\Solarium\QueryType\Extract\Query $query
+     * @param Endpoint|string|null                             $endpoint
      * @return \Solarium\QueryType\Extract\Result
      */
     public function extract(QueryInterface $query, $endpoint = null)
@@ -970,8 +970,8 @@ class Client extends Configurable
      * @internal This is a convenience method that forwards the query to the
      *  execute method, thus allowing for an easy to use and clean API.
      *
-     * @param \Solarium\QueryType\RealtimeGet\Query $query
-     * @param Endpoint|string|null
+     * @param QueryInterface|\Solarium\QueryType\RealtimeGet\Query $query
+     * @param Endpoint|string|null                                 $endpoint
      * @return \Solarium\QueryType\RealtimeGet\Result
      */
     public function realtimeGet(QueryInterface $query, $endpoint = null)

library/Solarium/Core/Configurable.php

@@ -67,7 +67,6 @@ class Configurable implements ConfigurableInterface
      *
      * @throws InvalidArgumentException
      * @param  array|\Zend_Config       $options
-     * @return void
      */
     public function __construct($options = null)
     {

library/Solarium/Core/ConfigurableInterface.php

@@ -59,7 +59,6 @@ interface ConfigurableInterface
      *
      * @throws InvalidArgumentException
      * @param  array|\Zend_Config       $options
-     * @return void
      */
     public function __construct($options = null);
 

library/Solarium/Core/Event/PostCreateQuery.php

@@ -65,7 +65,7 @@ class PostCreateQuery extends Event
      * Event constructor
      *
      * @param string         $type
-     * @param array          $query
+     * @param array          $options
      * @param QueryInterface $query
      */
     public function __construct($type, $options, QueryInterface $query)

library/Solarium/Core/Event/PostCreateRequest.php

@@ -61,6 +61,7 @@ class PostCreateRequest extends Event
      * Event constructor
      *
      * @param QueryInterface $query
+     * @param Request        $request
      */
     public function __construct(QueryInterface $query, Request $request)
     {

library/Solarium/Core/Event/PreCreateQuery.php

@@ -65,7 +65,7 @@ class PreCreateQuery extends Event
      * Event constructor
      *
      * @param string     $type
-     * @param array|null $query
+     * @param array|null $options
      */
     public function __construct($type, $options)
     {

library/Solarium/Core/Query/Helper.php

@@ -458,8 +458,8 @@ class Helper
      *
      * @see http://wiki.apache.org/solr/CommonQueryParameters#Caching_of_filters
      *
-     * @param boolean $useCache
-     * @param float|null $weight
+     * @param boolean    $useCache
+     * @param float|null $cost
      * @return string
      */
     public function cacheControl($useCache, $cost = null)

library/Solarium/Core/Query/RequestBuilder.php

@@ -50,7 +50,7 @@ abstract class RequestBuilder implements RequestBuilderInterface
     /**
      * Build request for a select query
      *
-     * @param  Query   $query
+     * @param  QueryInterface|Query $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/Core/Query/Result/Result.php

@@ -90,7 +90,6 @@ class Result implements ResultInterface
      * @param  Client        $client
      * @param  Query         $query
      * @param  Response      $response
-     * @return void
      */
     public function __construct($client, $query, $response)
     {

library/Solarium/Plugin/BufferedAdd/Event/PreCommit.php

@@ -74,7 +74,11 @@ class PreCommit extends Event
     /**
      * Event constructor
      *
-     * @param array $buffer
+     * @param array   $buffer
+     * @param boolean $overwrite
+     * @param boolean $softCommit
+     * @param boolean $waitSearcher
+     * @param boolean $expungeDeletes
      */
     public function __construct($buffer, $overwrite, $softCommit, $waitSearcher, $expungeDeletes)
     {

library/Solarium/QueryType/Analysis/RequestBuilder/Document.php

@@ -51,7 +51,7 @@ class Document extends BaseRequestBuilder
     /**
      * Build request for an analysis document query
      *
-     * @param  QueryDocument $query
+     * @param  QueryInterface|QueryDocument $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/Analysis/RequestBuilder/Field.php

@@ -50,7 +50,7 @@ class Field extends RequestBuilder
     /**
      * Build request for an analysis field query
      *
-     * @param  QueryField $query
+     * @param  QueryInterface|QueryField $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/Analysis/RequestBuilder/RequestBuilder.php

@@ -52,7 +52,7 @@ class RequestBuilder extends BaseRequestBuilder
     /**
      * Build request for an analysis query
      *
-     * @param  Query   $query
+     * @param  QueryInterface|Query   $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/MoreLikeThis/RequestBuilder.php

@@ -53,7 +53,7 @@ class RequestBuilder extends SelectRequestBuilder
     /**
      * Build request for a MoreLikeThis query
      *
-     * @param  Query   $query
+     * @param  QueryInterface|Query $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/Ping/RequestBuilder.php

@@ -50,7 +50,7 @@ class RequestBuilder extends BaseRequestBuilder
     /**
      * Build request for a ping query
      *
-     * @param  Query   $query
+     * @param  QueryInterface|Query $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/RealtimeGet/RequestBuilder.php

@@ -50,7 +50,7 @@ class RequestBuilder extends BaseRequestBuilder
     /**
      * Build request for a ping query
      *
-     * @param  Query   $query
+     * @param  QueryInterface|Query   $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/Select/Query/Component/Component.php

@@ -77,7 +77,8 @@ abstract class Component extends Configurable
     /**
      * Set parent query instance
      *
-     * @return self Provides fluent interface
+     * @param  Query $instance
+     * @return self  Provides fluent interface
      */
     public function setQueryInstance(Query $instance)
     {

library/Solarium/QueryType/Select/Query/Component/Highlighting/Highlighting.php

@@ -787,7 +787,7 @@ class Highlighting extends Component
     /**
      * Get MultiValuedSeparatorChar option
      *
-     * @return $separator
+     * @return string
      */
     public function getMultiValuedSeparatorChar()
     {

library/Solarium/QueryType/Select/Query/FilterQuery.php

@@ -209,7 +209,7 @@ class FilterQuery extends Configurable
      *
      * This overwrites any existing tags
      *
-     * @param  array $filterQueries
+     * @param  array $tags
      * @return self  Provides fluent interface
      */
     public function setTags($tags)

library/Solarium/QueryType/Select/Query/Query.php

@@ -802,8 +802,8 @@ class Query extends BaseQuery
      *
      * @throws OutOfBoundsException
      * @param  string               $key      Use one of the constants
-     * @param  string               $autoload Class to autoload if component needs to be created
-     * @param  array                $config   Configuration to use for autoload
+     * @param  string|boolean       $autoload Class to autoload if component needs to be created
+     * @param  array|null           $config   Configuration to use for autoload
      * @return object|null
      */
     public function getComponent($key, $autoload = false, $config = null)

library/Solarium/QueryType/Select/RequestBuilder/RequestBuilder.php

@@ -51,7 +51,7 @@ class RequestBuilder extends BaseRequestBuilder
     /**
      * Build request for a select query
      *
-     * @param  SelectQuery $query
+     * @param  QueryInterface|SelectQuery $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/Select/Result/Debug/DocumentSet.php

@@ -54,8 +54,7 @@ class DocumentSet implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $docs
-     * @return void
+     * @param array $docs
      */
     public function __construct($docs)
     {

library/Solarium/QueryType/Select/Result/Debug/Timing.php

@@ -61,9 +61,8 @@ class Timing implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  float $time
-     * @param  array $phases
-     * @return void
+     * @param float $time
+     * @param array $phases
      */
     public function __construct($time, $phases)
     {

library/Solarium/QueryType/Select/Result/Debug/TimingPhase.php

@@ -68,10 +68,9 @@ class TimingPhase implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  string $name
-     * @param  float  $time
-     * @param  array  $timings
-     * @return void
+     * @param string $name
+     * @param float  $time
+     * @param array  $timings
      */
     public function __construct($name, $time, $timings)
     {

library/Solarium/QueryType/Select/Result/Facet/Field.php

@@ -58,8 +58,7 @@ class Field implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $values
-     * @return void
+     * @param array $values
      */
     public function __construct($values)
     {

library/Solarium/QueryType/Select/Result/Facet/Pivot/Pivot.php

@@ -55,8 +55,7 @@ class Pivot implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $data
-     * @return void
+     * @param array $data
      */
     public function __construct($data)
     {

library/Solarium/QueryType/Select/Result/Facet/Pivot/PivotItem.php

@@ -69,8 +69,7 @@ class PivotItem extends Pivot
     /**
      * Constructor
      *
-     * @param  array $data
-     * @return void
+     * @param array $data
      */
     public function __construct($data)
     {

library/Solarium/QueryType/Select/Result/Facet/Query.php

@@ -57,8 +57,7 @@ class Query
     /**
      * Constructor
      *
-     * @param  mixed $value
-     * @return void
+     * @param mixed $value
      */
     public function __construct($value)
     {

library/Solarium/QueryType/Select/Result/Facet/Range.php

@@ -96,14 +96,13 @@ class Range extends Field
     /**
      * Constructor
      *
-     * @param  array $values
-     * @param  int   $before
-     * @param  int   $after
-     * @param  int   $between
-     * @param  int   $start
-     * @param  int   $end
-     * @param  int   $gap
-     * @return void
+     * @param array $values
+     * @param int   $before
+     * @param int   $after
+     * @param int   $between
+     * @param int   $start
+     * @param int   $end
+     * @param int   $gap
      */
     public function __construct($values, $before, $after, $between, $start, $end, $gap)
     {

library/Solarium/QueryType/Select/Result/FacetSet.php

@@ -54,8 +54,7 @@ class FacetSet implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $facets
-     * @return void
+     * @param array $facets
      */
     public function __construct($facets)
     {

library/Solarium/QueryType/Select/Result/Grouping/FieldGroup.php

@@ -70,10 +70,9 @@ class FieldGroup implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  int   $matches
-     * @param  int   $numberOfGroups
-     * @param  array $groups
-     * @return void
+     * @param int   $matches
+     * @param int   $numberOfGroups
+     * @param array $groups
      */
     public function __construct($matches, $numberOfGroups, $groups)
     {

library/Solarium/QueryType/Select/Result/Grouping/QueryGroup.php

@@ -84,12 +84,11 @@ class QueryGroup implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  int   $matches
-     * @param  int   $numFound
-     * @param  int   $start
-     * @param  float $maximumScore
-     * @param  array $documents
-     * @return void
+     * @param int   $matches
+     * @param int   $numFound
+     * @param int   $start
+     * @param float $maximumScore
+     * @param array $documents
      */
     public function __construct($matches, $numFound, $start, $maximumScore, $documents)
     {

library/Solarium/QueryType/Select/Result/Grouping/Result.php

@@ -56,8 +56,7 @@ class Result implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $groups
-     * @return void
+     * @param array $groups
      */
     public function __construct($groups)
     {

library/Solarium/QueryType/Select/Result/Grouping/ValueGroup.php

@@ -77,11 +77,10 @@ class ValueGroup implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  string $value
-     * @param  int    $numFound
-     * @param  int    $start
-     * @param  array  $documents
-     * @return void
+     * @param string $value
+     * @param int    $numFound
+     * @param int    $start
+     * @param array  $documents
      */
     public function __construct($value, $numFound, $start, $documents)
     {

library/Solarium/QueryType/Select/Result/Highlighting/Highlighting.php

@@ -55,8 +55,7 @@ class Highlighting implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $results
-     * @return void
+     * @param array $results
      */
     public function __construct($results)
     {

library/Solarium/QueryType/Select/Result/Highlighting/Result.php

@@ -54,8 +54,7 @@ class Result implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $fields
-     * @return void
+     * @param array $fields
      */
     public function __construct($fields)
     {

library/Solarium/QueryType/Select/Result/MoreLikeThis/MoreLikeThis.php

@@ -55,8 +55,7 @@ class MoreLikeThis implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $results
-     * @return void
+     * @param array $results
      */
     public function __construct($results)
     {

library/Solarium/QueryType/Select/Result/MoreLikeThis/Result.php

@@ -71,10 +71,9 @@ class Result implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  int   $numFound
-     * @param  float $maxScore
-     * @param  array $documents
-     * @return void
+     * @param int   $numFound
+     * @param float $maxScore
+     * @param array $documents
      */
     public function __construct($numFound, $maxScore, $documents)
     {

library/Solarium/QueryType/Select/Result/Spellcheck/Result.php

@@ -70,10 +70,9 @@ class Result implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array   $suggestions
-     * @param  array   $collations
-     * @param  boolean $correctlySpelled
-     * @return void
+     * @param array   $suggestions
+     * @param array   $collations
+     * @param boolean $correctlySpelled
      */
     public function __construct($suggestions, $collations, $correctlySpelled)
     {

library/Solarium/QueryType/Select/Result/Stats/FacetValue.php

@@ -61,9 +61,8 @@ class FacetValue
     /**
      * Constructor
      *
-     * @param  string $value
-     * @param  array  $stats
-     * @return void
+     * @param string $value
+     * @param array  $stats
      */
     public function __construct($value, $stats)
     {

library/Solarium/QueryType/Select/Result/Stats/Result.php

@@ -61,9 +61,8 @@ class Result
     /**
      * Constructor
      *
-     * @param  string $field
-     * @param  array  $stats
-     * @return void
+     * @param string $field
+     * @param array  $stats
      */
     public function __construct($field, $stats)
     {

library/Solarium/QueryType/Select/Result/Stats/Stats.php

@@ -55,8 +55,7 @@ class Stats implements \IteratorAggregate, \Countable
     /**
      * Constructor
      *
-     * @param  array $results
-     * @return void
+     * @param array $results
      */
     public function __construct($results)
     {

library/Solarium/QueryType/Suggester/RequestBuilder.php

@@ -50,7 +50,7 @@ class RequestBuilder extends BaseRequestBuilder
     /**
      * Build request for a Suggester query
      *
-     * @param  Query   $query
+     * @param  QueryInterface|Query   $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/Terms/RequestBuilder.php

@@ -53,7 +53,7 @@ class RequestBuilder extends BaseRequestBuilder
     /**
      * Build request for a Terms query
      *
-     * @param  Query   $query
+     * @param  QueryInterface|Query   $query
      * @return Request
      */
     public function build(QueryInterface $query)

library/Solarium/QueryType/Update/RequestBuilder.php

@@ -53,7 +53,7 @@ class RequestBuilder extends BaseRequestBuilder
     /**
      * Build request for an update query
      *
-     * @param  UpdateQuery $query
+     * @param  QueryInterface|UpdateQuery $query
      * @return Request
      */
     public function build(QueryInterface $query)