[#MODM-149] Fix PHPDoc @return types in various places

[MODM-149] Fix PHPDoc @return types in various places Created: 05/Jul/11 Updated: 05/Apr/12
Status:	Open
Project:	Doctrine MongoDB ODM
Component/s:	Document Manager
Affects Version/s:	1.0.0BETA3
Fix Version/s:	None

Type:

Documentation

Priority:

Critical

Reporter:

Dayson Pais

Assignee:

Jonathan H. Wage

Resolution:

Unresolved

Votes:

Labels:

None

Description

In certain PHPDoc blocks for functions, the @return type is not of the right type. This causes auto-completion issues in various IDEs (I'm using PhpStorm).

For example, in \Doctrine\ODM\MongoDB\DocumentManager on line #341 the ->createQueryBuilder($documentName = null) function.

/**

Create a new Query instance for a class.
*
@param string $documentName The document class name.
@return Document\ODM\MongoDB\Query <--------------------------- MUST BE Query\Builder !
*/
public function createQueryBuilder($documentName = null) { return new Query\Builder($this, $this->cmd, $documentName); }

Comments

Comment by Lee Davis [ 05/Apr/12 ]

This appears to be fixed in 1.0.0BETA4-DEV

Line 357 in Doctrine\ODM\MongoDB\DocumentManager...

/**

Create a new Query instance for a class.
*
@param string $documentName The document class name.
@return Query\Builder
*/
public function createQueryBuilder($documentName = null) { return new Query\Builder($this, $this->cmd, $documentName); }

Generated at Sun May 19 07:50:14 UTC 2013 using JIRA 5.2.7#850-sha1:b2af0c8dc8537b36121c6a579fabbdf79fc919e5.

[MODM-149] Fix PHPDoc @return types in various places Created: 05/Jul/11 Updated: 05/Apr/12