doctrine / mongodb-odm

lib/Doctrine/ODM/MongoDB/Aggregation/Builder.php

Doc Comments +2 added lines, -2 removed lines

@@ -383,7 +383,7 @@ 
      *
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/out/
      *
-     * @param string $collection
+     * @param string $from
      * @return Stage\Out
      */
     public function out($from)
@@ -549,7 +549,7 @@ 
     }
 
     /**
-     * @param Cursor $cursor
+     * @param \Traversable $cursor
      *
      * @return Iterator
      */

lib/Doctrine/ODM/MongoDB/Aggregation/Expr.php

Doc Comments +1 added lines, -10 removed lines

@@ -107,7 +107,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/add/
      * @param mixed|self $expression1
      * @param mixed|self $expression2
-     * @param mixed|self $expression3,... Additional expressions
      * @return $this
      */
     public function add($expression1, $expression2 /* , $expression3, ... */)
@@ -296,7 +295,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/concat/
      * @param mixed|self $expression1
      * @param mixed|self $expression2
-     * @param mixed|self $expression3,... Additional expressions
      * @return $this
      */
     public function concat($expression1, $expression2 /* , $expression3, ... */)
@@ -313,7 +311,6 @@ 
      * @see https://docs.mongodb.org/manual/reference/operator/aggregation/concatArrays/
      * @param mixed|self $array1
      * @param mixed|self $array2
-     * @param mixed|self $array3, ... Additional expressions
      * @return $this
      *
      * @since 1.3
@@ -1074,7 +1071,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/multiply/
      * @param mixed|self $expression1
      * @param mixed|self $expression2
-     * @param mixed|self $expression3,... Additional expressions
      * @return $this
      */
     public function multiply($expression1, $expression2 /* , $expression3, ... */)
@@ -1151,7 +1147,7 @@ 
      * @since 1.5
      * @param mixed|self $start An integer that specifies the start of the sequence. Can be any valid expression that resolves to an integer.
      * @param mixed|self $end An integer that specifies the exclusive upper limit of the sequence. Can be any valid expression that resolves to an integer.
-     * @param mixed|self $step Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
+     * @param integer $step Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
      * @return $this
      */
     public function range($start, $end, $step = 1)
@@ -1229,7 +1225,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/setEquals/
      * @param mixed|self $expression1
      * @param mixed|self $expression2
-     * @param mixed|self $expression3,...   Additional sets
      * @return $this
      */
     public function setEquals($expression1, $expression2 /* , $expression3, ... */)
@@ -1246,7 +1241,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/setIntersection/
      * @param mixed|self $expression1
      * @param mixed|self $expression2
-     * @param mixed|self $expression3,...   Additional sets
      * @return $this
      */
     public function setIntersection($expression1, $expression2 /* , $expression3, ... */)
@@ -1279,7 +1273,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/setUnion/
      * @param mixed|self $expression1
      * @param mixed|self $expression2
-     * @param mixed|self $expression3,...   Additional sets
      * @return $this
      */
     public function setUnion($expression1, $expression2 /* , $expression3, ... */)
@@ -1363,7 +1356,6 @@ 
      *
      * @see https://docs.mongodb.org/manual/reference/operator/aggregation/stdDevPop/
      * @param mixed|self $expression1
-     * @param mixed|self $expression2,... Additional samples
      * @return $this
      *
      * @since 1.3
@@ -1382,7 +1374,6 @@ 
      *
      * @see https://docs.mongodb.org/manual/reference/operator/aggregation/stdDevSamp/
      * @param mixed|self $expression1
-     * @param mixed|self $expression2,... Additional samples
      * @return $this
      *
      * @since 1.3

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/AbstractBucket.php

Doc Comments +3 added lines

@@ -90,6 +90,9 @@
      */
     abstract protected function getStageName();
 
+    /**
+     * @param Expr $expression
+     */
     private function convertExpression($expression)
     {
         if (is_array($expression)) {

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Match.php

Doc Comments +2 added lines, -3 removed lines

@@ -234,7 +234,7 @@ 
      *
      * @see Expr::geoWithin()
      * @see http://docs.mongodb.org/manual/reference/operator/geoWithin/
-     * @param array|Geometry $geometry
+     * @param Geometry $geometry
      * @return $this
      */
     public function geoWithin(Geometry $geometry)
@@ -320,7 +320,6 @@ 
      *
      * @see Expr::geoWithinPolygon()
      * @see http://docs.mongodb.org/manual/reference/operator/polygon/
-     * @param array $point,... Three or more point coordinate tuples
      * @return $this
      */
     public function geoWithinPolygon(/* array($x1, $y1), ... */)
@@ -493,7 +492,7 @@ 
      * @see Expr::mod()
      * @see http://docs.mongodb.org/manual/reference/operator/mod/
      * @param float|integer $divisor
-     * @param float|integer $remainder
+     * @param integer $remainder
      * @return $this
      */
     public function mod($divisor, $remainder = 0)

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Operator.php

Doc Comments +2 added lines, -9 removed lines

@@ -93,7 +93,6 @@ 
      * @see Expr::add
      * @param mixed|Expr $expression1
      * @param mixed|Expr $expression2
-     * @param mixed|Expr $expression3,... Additional expressions
      * @return $this
      */
     public function add($expression1, $expression2 /* , $expression3, ... */)
@@ -242,7 +241,6 @@ 
      * @see Expr::concat
      * @param mixed|Expr $expression1
      * @param mixed|Expr $expression2
-     * @param mixed|Expr $expression3,... Additional expressions
      * @return $this
      */
     public function concat($expression1, $expression2 /* , $expression3, ... */)
@@ -262,7 +260,6 @@ 
      * @see Expr::concatArrays
      * @param mixed|Expr $array1
      * @param mixed|Expr $array2
-     * @param mixed|Expr $array3, ... Additional expressions
      * @return $this
      *
      * @since 1.3
@@ -426,7 +423,7 @@ 
      *
      * @see http://docs.mongodb.org/manual/meta/aggregation-quick-reference/#aggregation-expressions
      * @see Expr::expression
-     * @param mixed|Expr $value
+     * @param boolean $value
      * @return $this
      */
     public function expression($value)
@@ -974,7 +971,6 @@ 
      * @see Expr::multiply
      * @param mixed|Expr $expression1
      * @param mixed|Expr $expression2
-     * @param mixed|Expr $expression3,... Additional expressions
      * @return $this
      */
     public function multiply($expression1, $expression2 /* , $expression3, ... */)
@@ -1050,7 +1046,7 @@ 
      * @since 1.5
      * @param mixed|Expr $start An integer that specifies the start of the sequence. Can be any valid expression that resolves to an integer.
      * @param mixed|Expr $end An integer that specifies the exclusive upper limit of the sequence. Can be any valid expression that resolves to an integer.
-     * @param mixed|Expr $step Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
+     * @param integer $step Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
      * @return $this
      */
     public function range($start, $end, $step = 1)
@@ -1143,7 +1139,6 @@ 
      * @see Expr::setEquals
      * @param mixed|Expr $expression1
      * @param mixed|Expr $expression2
-     * @param mixed|Expr $expression3,...   Additional sets
      * @return $this
      */
     public function setEquals($expression1, $expression2 /* , $expression3, ... */)
@@ -1163,7 +1158,6 @@ 
      * @see Expr::setIntersection
      * @param mixed|Expr $expression1
      * @param mixed|Expr $expression2
-     * @param mixed|Expr $expression3,...   Additional sets
      * @return $this
      */
     public function setIntersection($expression1, $expression2 /* , $expression3, ... */)
@@ -1203,7 +1197,6 @@ 
      * @see Expr::setUnion
      * @param mixed|Expr $expression1
      * @param mixed|Expr $expression2
-     * @param mixed|Expr $expression3,...   Additional sets
      * @return $this
      */
     public function setUnion($expression1, $expression2 /* , $expression3, ... */)

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Project.php

Doc Comments -6 removed lines

@@ -47,7 +47,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/avg/
      * @see Expr::avg
      * @param mixed|Expr $expression1
-     * @param mixed|Expr $expression2, ... Additional expressions
      * @return $this
      *
      * @since 1.3
@@ -114,7 +113,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/max/
      * @see Expr::max
      * @param mixed|Expr $expression1
-     * @param mixed|Expr $expression2, ... Additional expressions
      * @return $this
      *
      * @since 1.3
@@ -133,7 +131,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/min/
      * @see Expr::min
      * @param mixed|Expr $expression1
-     * @param mixed|Expr $expression2, ... Additional expressions
      * @return $this
      *
      * @since 1.3
@@ -153,7 +150,6 @@ 
      * @see https://docs.mongodb.org/manual/reference/operator/aggregation/stdDevPop/
      * @see Expr::stdDevPop
      * @param mixed|Expr $expression1
-     * @param mixed|Expr $expression2, ... Additional expressions
      * @return $this
      *
      * @since 1.3
@@ -173,7 +169,6 @@ 
      * @see https://docs.mongodb.org/manual/reference/operator/aggregation/stdDevSamp/
      * @see Expr::stdDevSamp
      * @param mixed|Expr $expression1
-     * @param mixed|Expr $expression2, ... Additional expressions
      * @return $this
      *
      * @since 1.3
@@ -193,7 +188,6 @@ 
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/sum/
      * @see Expr::sum
      * @param mixed|Expr $expression1
-     * @param mixed|Expr $expression2, ... Additional expressions
      * @return $this
      *
      * @since 1.3

lib/Doctrine/ODM/MongoDB/Query/Builder.php

Doc Comments +4 added lines, -6 removed lines

@@ -111,7 +111,7 @@ 
      * Construct a Builder
      *
      * @param DocumentManager $dm
-     * @param string[]|string|null $documentName (optional) an array of document names, the document name, or none
+     * @param string|null $documentName (optional) an array of document names, the document name, or none
      */
     public function __construct(DocumentManager $dm, $documentName = null)
     {
@@ -723,7 +723,6 @@ 
      *
      * @see Expr::geoWithinPolygon()
      * @see http://docs.mongodb.org/manual/reference/operator/polygon/
-     * @param array $point,... Three or more point coordinate tuples
      * @return $this
      */
     public function geoWithinPolygon(/* array($x1, $y1), ... */)
@@ -1115,7 +1114,7 @@ 
      * @see Expr::mod()
      * @see http://docs.mongodb.org/manual/reference/operator/mod/
      * @param float|integer $divisor
-     * @param float|integer $remainder
+     * @param integer $remainder
      * @return $this
      */
     public function mod($divisor, $remainder = 0)
@@ -1293,7 +1292,7 @@ 
      * If a custom callable is used, its signature should conform to the default
      * Closure defined in {@link ReferencePrimer::__construct()}.
      *
-     * @param boolean|callable $primer
+     * @param boolean $primer
      * @return $this
      * @throws \InvalidArgumentException If $primer is not boolean or callable
      */
@@ -1708,7 +1707,7 @@ 
      * field name (key) and order (value) pairs.
      *
      * @param array|string $fieldName Field name or array of field/order pairs
-     * @param int|string $order       Field order (if one field is specified)
+     * @param integer $order       Field order (if one field is specified)
      * @return $this
      */
     public function sort($fieldName, $order = 1)
@@ -1921,7 +1920,6 @@ 
      * @see Builder::geoWithinPolygon()
      * @see Expr::withinPolygon()
      * @see http://docs.mongodb.org/manual/reference/operator/polygon/
-     * @param array $point,... Three or more point coordinate tuples
      * @return $this
      */
     public function withinPolygon(/* array($x1, $y1), array($x2, $y2), ... */)

lib/Doctrine/ODM/MongoDB/Query/Expr.php

Doc Comments +1 added lines, -3 removed lines

@@ -605,7 +605,6 @@ 
      *
      * @see Builder::geoWithinPolygon()
      * @see http://docs.mongodb.org/manual/reference/operator/polygon/
-     * @param array $point,... Three or more point coordinate tuples
      * @return $this
      * @throws \InvalidArgumentException if less than three points are given
      */
@@ -846,7 +845,7 @@ 
      * @see Builder::mod()
      * @see http://docs.mongodb.org/manual/reference/operator/mod/
      * @param float|integer $divisor
-     * @param float|integer $remainder
+     * @param integer $remainder
      * @return $this
      */
     public function mod($divisor, $remainder = 0)
@@ -1499,7 +1498,6 @@ 
      * @deprecated 1.1 MongoDB 2.4 deprecated $within in favor of $geoWithin
      * @see Expr::geoWithinPolygon()
      * @see http://docs.mongodb.org/manual/reference/operator/polygon/
-     * @param array $point,... Three or more point coordinate tuples
      * @return $this
      * @throws \InvalidArgumentException if less than three points are given
      */

lib/Doctrine/ODM/MongoDB/Query/Query.php

Doc Comments -1 removed lines

@@ -383,7 +383,6 @@
      * Returns an array containing the specified keys and their values from the
      * query array, provided they exist and are not null.
      *
-     * @param string $key,... One or more option keys to be read
      * @return array
      */
     private function getQueryOptions(/* $key, ... */)