Merge pull request #139 from box/fix_phpdoc

Fix PHPDoc to work with Augmented Types
box · Nov 5, 2015 · 582da84 · 582da84
2 parents f8aab6e + 8b666fc
commit 582da84
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 11 deletions.
diff --git a/src/Spout/Reader/CSV/Sheet.php b/src/Spout/Reader/CSV/Sheet.php
@@ -11,7 +11,7 @@
  */
 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 @@ public function __construct($filePointer, $fieldDelimiter, $fieldEnclosure, $enc
 
     /**
      * @api
-     * @return RowIterator
+     * @return \Box\Spout\Reader\CSV\RowIterator
      */
     public function getRowIterator()
     {

diff --git a/src/Spout/Reader/CSV/SheetIterator.php b/src/Spout/Reader/CSV/SheetIterator.php
@@ -12,7 +12,7 @@
  */
 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 @@ public function next()
      * Return the current element
      * @link http://php.net/manual/en/iterator.current.php
      *
-     * @return Sheet
+     * @return \Box\Spout\Reader\CSV\Sheet
      */
     public function current()
     {

diff --git a/src/Spout/Reader/ODS/Sheet.php b/src/Spout/Reader/ODS/Sheet.php
@@ -13,7 +13,7 @@
  */
 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 @@ public function __construct($xmlReader, $sheetIndex, $sheetName)
 
     /**
      * @api
-     * @return RowIterator
+     * @return \Box\Spout\Reader\ODS\RowIterator
      */
     public function getRowIterator()
     {

diff --git a/src/Spout/Reader/ODS/SheetIterator.php b/src/Spout/Reader/ODS/SheetIterator.php
@@ -102,7 +102,7 @@ public function next()
      * Return the current element
      * @link http://php.net/manual/en/iterator.current.php
      *
-     * @return Sheet
+     * @return \Box\Spout\Reader\ODS\Sheet
      */
     public function current()
     {

diff --git a/src/Spout/Reader/XLSX/Sheet.php b/src/Spout/Reader/XLSX/Sheet.php
@@ -12,7 +12,7 @@
  */
 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 @@ public function __construct($filePath, $sheetDataXMLFilePath, $sharedStringsHelp
 
     /**
      * @api
-     * @return RowIterator
+     * @return \Box\Spout\Reader\XLSX\RowIterator
      */
     public function getRowIterator()
     {

diff --git a/src/Spout/Reader/XLSX/SheetIterator.php b/src/Spout/Reader/XLSX/SheetIterator.php
@@ -14,7 +14,7 @@
  */
 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 @@ public function next()
      * Return the current element
      * @link http://php.net/manual/en/iterator.current.php
      *
-     * @return Sheet
+     * @return \Box\Spout\Reader\XLSX\Sheet
      */
     public function current()
     {