Skip to content
This repository was archived by the owner on May 26, 2022. It is now read-only.

Commit 582da84

Browse files
committed
Merge pull request #139 from box/fix_phpdoc
Fix PHPDoc to work with Augmented Types
2 parents f8aab6e + 8b666fc commit 582da84

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

src/Spout/Reader/CSV/Sheet.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
*/
1212
class Sheet implements SheetInterface
1313
{
14-
/** @var RowIterator To iterate over the CSV's rows */
14+
/** @var \Box\Spout\Reader\CSV\RowIterator To iterate over the CSV's rows */
1515
protected $rowIterator;
1616

1717
/**
@@ -28,7 +28,7 @@ public function __construct($filePointer, $fieldDelimiter, $fieldEnclosure, $enc
2828

2929
/**
3030
* @api
31-
* @return RowIterator
31+
* @return \Box\Spout\Reader\CSV\RowIterator
3232
*/
3333
public function getRowIterator()
3434
{

src/Spout/Reader/CSV/SheetIterator.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
*/
1313
class SheetIterator implements IteratorInterface
1414
{
15-
/** @var Sheet The CSV unique "sheet" */
15+
/** @var \Box\Spout\Reader\CSV\Sheet The CSV unique "sheet" */
1616
protected $sheet;
1717

1818
/** @var bool Whether the unique "sheet" has already been read */
@@ -67,7 +67,7 @@ public function next()
6767
* Return the current element
6868
* @link http://php.net/manual/en/iterator.current.php
6969
*
70-
* @return Sheet
70+
* @return \Box\Spout\Reader\CSV\Sheet
7171
*/
7272
public function current()
7373
{

src/Spout/Reader/ODS/Sheet.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
*/
1414
class Sheet implements SheetInterface
1515
{
16-
/** @var RowIterator To iterate over sheet's rows */
16+
/** @var \Box\Spout\Reader\ODS\RowIterator To iterate over sheet's rows */
1717
protected $rowIterator;
1818

1919
/** @var int ID of the sheet */
@@ -39,7 +39,7 @@ public function __construct($xmlReader, $sheetIndex, $sheetName)
3939

4040
/**
4141
* @api
42-
* @return RowIterator
42+
* @return \Box\Spout\Reader\ODS\RowIterator
4343
*/
4444
public function getRowIterator()
4545
{

src/Spout/Reader/ODS/SheetIterator.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ public function next()
102102
* Return the current element
103103
* @link http://php.net/manual/en/iterator.current.php
104104
*
105-
* @return Sheet
105+
* @return \Box\Spout\Reader\ODS\Sheet
106106
*/
107107
public function current()
108108
{

src/Spout/Reader/XLSX/Sheet.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
*/
1313
class Sheet implements SheetInterface
1414
{
15-
/** @var RowIterator To iterate over sheet's rows */
15+
/** @var \Box\Spout\Reader\XLSX\RowIterator To iterate over sheet's rows */
1616
protected $rowIterator;
1717

1818
/** @var int Index of the sheet, based on order of creation (zero-based) */
@@ -37,7 +37,7 @@ public function __construct($filePath, $sheetDataXMLFilePath, $sharedStringsHelp
3737

3838
/**
3939
* @api
40-
* @return RowIterator
40+
* @return \Box\Spout\Reader\XLSX\RowIterator
4141
*/
4242
public function getRowIterator()
4343
{

src/Spout/Reader/XLSX/SheetIterator.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*/
1515
class SheetIterator implements IteratorInterface
1616
{
17-
/** @var Sheet[] The list of sheet present in the file */
17+
/** @var \Box\Spout\Reader\XLSX\Sheet[] The list of sheet present in the file */
1818
protected $sheets;
1919

2020
/** @var int The index of the sheet being read (zero-based) */
@@ -79,7 +79,7 @@ public function next()
7979
* Return the current element
8080
* @link http://php.net/manual/en/iterator.current.php
8181
*
82-
* @return Sheet
82+
* @return \Box\Spout\Reader\XLSX\Sheet
8383
*/
8484
public function current()
8585
{

0 commit comments

Comments
 (0)