ruflin / Elastica

lib/Elastica/Node/Info.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      * node is running on
      * Example 2: get('os', 'mem') returns an array with all mem infos
      *
-     * @return mixed Data array entry or null if not found
+     * @return string Data array entry or null if not found
      */
     public function get()
     {

lib/Elastica/Aggregation/Children.php

Doc Comments -1 removed lines

@@ -12,7 +12,6 @@
     /**
      * Set the type for this aggregation.
      *
-     * @param string $field the child type the buckets in the parent space should be mapped to
      *
      * @return $this
      */

lib/Elastica/Multi/Search.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
     }
 
     /**
-     * @return array|\Elastica\Search[]
+     * @return BaseSearch[]
      */
     public function getSearches()
     {

lib/Elastica/Query.php

Doc Comments +1 added lines, -1 removed lines

@@ -435,7 +435,7 @@
     /**
      * Sets post_filter argument for the query. The filter is applied after the query has executed.
      *
-     * @param array|\Elastica\Query\AbstractQuery $filter
+     * @param AbstractQuery $filter
      *
      * @return $this
      *

lib/Elastica/Suggest/AbstractSuggest.php

Doc Comments -2 removed lines

@@ -41,7 +41,6 @@ 
     /**
      * Suggest prefix must be set either globally or per suggestion.
      *
-     * @param string $text
      *
      * @return $this
      */
@@ -53,7 +52,6 @@ 
     /**
      * Suggest regex must be set either globally or per suggestion.
      *
-     * @param string $text
      *
      * @return $this
      */

lib/Elastica/Document.php

Doc Comments +3 added lines, -3 removed lines

@@ -35,10 +35,10 @@
     /**
      * Creates a new document.
      *
-     * @param int|string   $id    OPTIONAL $id Id is create if empty
+     * @param string   $id    OPTIONAL $id Id is create if empty
      * @param array|string $data  OPTIONAL Data array
-     * @param Type|string  $type  OPTIONAL Type name
-     * @param Index|string $index OPTIONAL Index name
+     * @param string  $type  OPTIONAL Type name
+     * @param Index $index OPTIONAL Index name
      */
     public function __construct($id = '', $data = [], $type = '', $index = '')
     {

lib/Elastica/Transport/AbstractTransport.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
      *
      * @param string $query
      *
-     * @return mixed
+     * @return string
      */
     public function sanityzeQueryStringBool($query)
     {

lib/Elastica/Suggest/Term.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
      * - jaro_winkler
      * - ngram
      *
-     * @param string $distanceAlgrorithm
+     * @param string $distanceAlgorithm
      *
      * @return $this
      */

lib/Elastica/Transport/NullTransport.php

Doc Comments +2 added lines, -3 removed lines

@@ -26,9 +26,8 @@ 
     /**
      * Set response object the transport returns.
      *
-     * @param \Elastica\Response $response
      *
-     * @return $this
+     * @return Response
      */
     public function getResponse()
     {
@@ -40,7 +39,7 @@ 
      *
      * @param \Elastica\Response $response
      *
-     * @return $this
+     * @return Response
      */
     public function setResponse(Response $response)
     {