Merge branch 'docs/#1496-docblock-fixes'

Close #1496

lib/Doctrine/ORM/AbstractQuery.php

@@ -215,7 +215,7 @@ abstract class AbstractQuery
     /**
     * Obtain the name of the second level query cache region in which query results will be stored
     *
-    * @return The cache region name; NULL indicates the default region.
+    * @return string|null The cache region name; NULL indicates the default region.
     */
     public function getCacheRegion()
     {
@@ -398,7 +398,7 @@ abstract class AbstractQuery
      *
      * @param mixed $value
      *
-     * @return array
+     * @return array|string
      *
      * @throws \Doctrine\ORM\ORMInvalidArgumentException
      */

lib/Doctrine/ORM/QueryBuilder.php

@@ -183,7 +183,7 @@ class QueryBuilder
      *
      * @param boolean $cacheable
      *
-     * @return \Doctrine\ORM\AbstractQuery This query instance.
+     * @return self
      */
     public function setCacheable($cacheable)
     {
@@ -203,7 +203,7 @@ class QueryBuilder
     /**
      * @param string $cacheRegion
      *
-     * @return \Doctrine\ORM\AbstractQuery This query instance.
+     * @return self
      */
     public function setCacheRegion($cacheRegion)
     {
@@ -234,7 +234,8 @@ class QueryBuilder
      * Sets the life-time for this query into second level cache.
      *
      * @param integer $lifetime
-     * @return \Doctrine\ORM\AbstractQuery This query instance.
+     *
+     * @return self
      */
     public function setLifetime($lifetime)
     {
@@ -253,7 +254,8 @@ class QueryBuilder
 
     /**
      * @param integer $cacheMode
-     * @return \Doctrine\ORM\AbstractQuery This query instance.
+     *
+     * @return self
      */
     public function setCacheMode($cacheMode)
     {
@@ -525,7 +527,7 @@ class QueryBuilder
      * @param mixed          $value The parameter value.
      * @param string|null    $type  PDO::PARAM_* or \Doctrine\DBAL\Types\Type::* constant
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function setParameter($key, $value, $type = null)
     {
@@ -569,7 +571,7 @@ class QueryBuilder
      *
      * @param \Doctrine\Common\Collections\ArrayCollection|array $parameters The query parameters to set.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function setParameters($parameters)
     {
@@ -627,7 +629,7 @@ class QueryBuilder
      *
      * @param integer $firstResult The first result to return.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function setFirstResult($firstResult)
     {
@@ -652,7 +654,7 @@ class QueryBuilder
      *
      * @param integer $maxResults The maximum number of results to retrieve.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function setMaxResults($maxResults)
     {
@@ -682,7 +684,7 @@ class QueryBuilder
      * @param object|array $dqlPart     An Expr object.
      * @param bool         $append      Whether to append (true) or replace (false).
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function add($dqlPartName, $dqlPart, $append = false)
     {
@@ -745,7 +747,7 @@ class QueryBuilder
      *
      * @param mixed $select The selection expressions.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function select($select = null)
     {
@@ -772,7 +774,7 @@ class QueryBuilder
      *
      * @param bool $flag
      *
-     * @return QueryBuilder
+     * @return self
      */
     public function distinct($flag = true)
     {
@@ -794,7 +796,7 @@ class QueryBuilder
      *
      * @param mixed $select The selection expression.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function addSelect($select = null)
     {
@@ -823,7 +825,7 @@ class QueryBuilder
      * @param string $delete The class/type whose instances are subject to the deletion.
      * @param string $alias  The class/type alias used in the constructed query.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function delete($delete = null, $alias = null)
     {
@@ -850,7 +852,7 @@ class QueryBuilder
      * @param string $update The class/type whose instances are subject to the update.
      * @param string $alias  The class/type alias used in the constructed query.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function update($update = null, $alias = null)
     {
@@ -877,7 +879,7 @@ class QueryBuilder
      * @param string $alias   The alias of the class.
      * @param string $indexBy The index for the from.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function from($from, $alias, $indexBy = null)
     {
@@ -903,7 +905,7 @@ class QueryBuilder
      * @param string $alias   The root alias of the class.
      * @param string $indexBy The index for the from.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      *
      * @throws Query\QueryException
      */
@@ -949,7 +951,7 @@ class QueryBuilder
      * @param string|null $condition     The condition for the join.
      * @param string|null $indexBy       The index for the join.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function join($join, $alias, $conditionType = null, $condition = null, $indexBy = null)
     {
@@ -975,7 +977,7 @@ class QueryBuilder
      * @param string|null $condition     The condition for the join.
      * @param string|null $indexBy       The index for the join.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function innerJoin($join, $alias, $conditionType = null, $condition = null, $indexBy = null)
     {
@@ -1010,7 +1012,7 @@ class QueryBuilder
      * @param string|null $condition     The condition for the join.
      * @param string|null $indexBy       The index for the join.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function leftJoin($join, $alias, $conditionType = null, $condition = null, $indexBy = null)
     {
@@ -1038,7 +1040,7 @@ class QueryBuilder
      * @param string $key   The key/field to set.
      * @param string $value The value, expression, placeholder, etc.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function set($key, $value)
     {
@@ -1069,7 +1071,7 @@ class QueryBuilder
      *
      * @param mixed $predicates The restriction predicates.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function where($predicates)
     {
@@ -1094,7 +1096,7 @@ class QueryBuilder
      *
      * @param mixed $where The query restrictions.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      *
      * @see where()
      */
@@ -1127,7 +1129,7 @@ class QueryBuilder
      *
      * @param mixed $where The WHERE statement.
      *
-     * @return QueryBuilder
+     * @return self
      *
      * @see where()
      */
@@ -1159,7 +1161,7 @@ class QueryBuilder
      *
      * @param string $groupBy The grouping expression.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function groupBy($groupBy)
     {
@@ -1179,7 +1181,7 @@ class QueryBuilder
      *
      * @param string $groupBy The grouping expression.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function addGroupBy($groupBy)
     {
@@ -1192,7 +1194,7 @@ class QueryBuilder
      *
      * @param mixed $having The restriction over the groups.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function having($having)
     {
@@ -1209,7 +1211,7 @@ class QueryBuilder
      *
      * @param mixed $having The restriction to append.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function andHaving($having)
     {
@@ -1232,7 +1234,7 @@ class QueryBuilder
      *
      * @param mixed $having The restriction to add.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function orHaving($having)
     {
@@ -1256,7 +1258,7 @@ class QueryBuilder
      * @param string|Expr\OrderBy $sort  The ordering expression.
      * @param string              $order The ordering direction.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function orderBy($sort, $order = null)
     {
@@ -1271,7 +1273,7 @@ class QueryBuilder
      * @param string|Expr\OrderBy $sort  The ordering expression.
      * @param string              $order The ordering direction.
      *
-     * @return QueryBuilder This QueryBuilder instance.
+     * @return self
      */
     public function addOrderBy($sort, $order = null)
     {
@@ -1288,7 +1290,9 @@ class QueryBuilder
      * Overrides firstResult and maxResults if they're set.
      *
      * @param Criteria $criteria
-     * @return QueryBuilder
+     *
+     * @return self
+     *
      * @throws Query\QueryException
      */
     public function addCriteria(Criteria $criteria)
@@ -1449,7 +1453,7 @@ class QueryBuilder
      *
      * @param array|null $parts
      *
-     * @return QueryBuilder
+     * @return self
      */
     public function resetDQLParts($parts = null)
     {
@@ -1469,7 +1473,7 @@ class QueryBuilder
      *
      * @param string $part
      *
-     * @return QueryBuilder
+     * @return self
      */
     public function resetDQLPart($part)
     {