Merge pull request #139 from box/fix_phpdoc

Fix PHPDoc to work with Augmented Types
This commit is contained in:
Adrien Loison 2015-11-05 15:52:56 -08:00
commit 582da8403d
6 changed files with 11 additions and 11 deletions

View File

@ -11,7 +11,7 @@ use Box\Spout\Reader\SheetInterface;
*/
class Sheet implements SheetInterface
{
/** @var RowIterator To iterate over the CSV's rows */
/** @var \Box\Spout\Reader\CSV\RowIterator To iterate over the CSV's rows */
protected $rowIterator;
/**
@ -28,7 +28,7 @@ class Sheet implements SheetInterface
/**
* @api
* @return RowIterator
* @return \Box\Spout\Reader\CSV\RowIterator
*/
public function getRowIterator()
{

View File

@ -12,7 +12,7 @@ use Box\Spout\Reader\IteratorInterface;
*/
class SheetIterator implements IteratorInterface
{
/** @var Sheet The CSV unique "sheet" */
/** @var \Box\Spout\Reader\CSV\Sheet The CSV unique "sheet" */
protected $sheet;
/** @var bool Whether the unique "sheet" has already been read */
@ -67,7 +67,7 @@ class SheetIterator implements IteratorInterface
* Return the current element
* @link http://php.net/manual/en/iterator.current.php
*
* @return Sheet
* @return \Box\Spout\Reader\CSV\Sheet
*/
public function current()
{

View File

@ -13,7 +13,7 @@ use Box\Spout\Reader\Wrapper\XMLReader;
*/
class Sheet implements SheetInterface
{
/** @var RowIterator To iterate over sheet's rows */
/** @var \Box\Spout\Reader\ODS\RowIterator To iterate over sheet's rows */
protected $rowIterator;
/** @var int ID of the sheet */
@ -39,7 +39,7 @@ class Sheet implements SheetInterface
/**
* @api
* @return RowIterator
* @return \Box\Spout\Reader\ODS\RowIterator
*/
public function getRowIterator()
{

View File

@ -102,7 +102,7 @@ class SheetIterator implements IteratorInterface
* Return the current element
* @link http://php.net/manual/en/iterator.current.php
*
* @return Sheet
* @return \Box\Spout\Reader\ODS\Sheet
*/
public function current()
{

View File

@ -12,7 +12,7 @@ use Box\Spout\Reader\SheetInterface;
*/
class Sheet implements SheetInterface
{
/** @var RowIterator To iterate over sheet's rows */
/** @var \Box\Spout\Reader\XLSX\RowIterator To iterate over sheet's rows */
protected $rowIterator;
/** @var int Index of the sheet, based on order of creation (zero-based) */
@ -37,7 +37,7 @@ class Sheet implements SheetInterface
/**
* @api
* @return RowIterator
* @return \Box\Spout\Reader\XLSX\RowIterator
*/
public function getRowIterator()
{

View File

@ -14,7 +14,7 @@ use Box\Spout\Reader\Exception\NoSheetsFoundException;
*/
class SheetIterator implements IteratorInterface
{
/** @var Sheet[] The list of sheet present in the file */
/** @var \Box\Spout\Reader\XLSX\Sheet[] The list of sheet present in the file */
protected $sheets;
/** @var int The index of the sheet being read (zero-based) */
@ -79,7 +79,7 @@ class SheetIterator implements IteratorInterface
* Return the current element
* @link http://php.net/manual/en/iterator.current.php
*
* @return Sheet
* @return \Box\Spout\Reader\XLSX\Sheet
*/
public function current()
{