Remove @api annotation

This commit is contained in:
Adrien Loison committed 2017-11-05 02:23:26 +01:00
1 parent 3851e05f83
commit 727a90fd06
27 files changed
-72

No files matched your search

-4
View File
@@ -21,7 +21,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return \Box\Spout\Reader\CSV\RowIterator
*/
public function getRowIterator()
@@ -30,7 +29,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return int Index of the sheet
*/
public function getIndex()
@@ -39,7 +37,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return string Name of the sheet - empty string since CSV does not support that
*/
public function getName()
@@ -48,7 +45,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return bool Always TRUE as there is only one sheet
*/
public function isActive()
@@ -4,8 +4,6 @@ namespace Box\Spout\Reader\Exception;
/**
* Class IteratorNotRewindableException
*
* @api
*/
class IteratorNotRewindableException extends ReaderException
{
@@ -4,8 +4,6 @@ namespace Box\Spout\Reader\Exception;
/**
* Class NoSheetsFoundException
*
* @api
*/
class NoSheetsFoundException extends ReaderException
{
@@ -4,8 +4,6 @@ namespace Box\Spout\Reader\Exception;
/**
* Class ReaderNotOpenedException
*
* @api
*/
class ReaderNotOpenedException extends ReaderException
{
@@ -4,8 +4,6 @@ namespace Box\Spout\Reader\Exception;
/**
* Class SharedStringNotFoundException
*
* @api
*/
class SharedStringNotFoundException extends ReaderException
{
-4
View File
@@ -40,7 +40,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return \Box\Spout\Reader\ODS\RowIterator
*/
public function getRowIterator()
@@ -49,7 +48,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return int Index of the sheet, based on order in the workbook (zero-based)
*/
public function getIndex()
@@ -58,7 +56,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return string Name of the sheet
*/
public function getName()
@@ -67,7 +64,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return bool Whether the sheet was defined as active
*/
public function isActive()
-5
View File
@@ -75,7 +75,6 @@ abstract class ReaderAbstract implements ReaderInterface
/**
* Sets whether date/time values should be returned as PHP objects or be formatted as strings.
*
* @api
* @param bool $shouldFormatDates
* @return ReaderAbstract
*/
@@ -89,7 +88,6 @@ abstract class ReaderAbstract implements ReaderInterface
/**
* Sets whether empty rows should be returned or skipped.
*
* @api
* @param bool $shouldPreserveEmptyRows
* @return ReaderAbstract
*/
@@ -104,7 +102,6 @@ abstract class ReaderAbstract implements ReaderInterface
* Prepares the reader to read the given file. It also makes sure
* that the file exists and is readable.
*
* @api
* @param string $filePath Path of the file to be read
* @throws \Box\Spout\Common\Exception\IOException If the file at the given path does not exist, is not readable or is corrupted
* @return void
@@ -213,7 +210,6 @@ abstract class ReaderAbstract implements ReaderInterface
/**
* Returns an iterator to iterate over sheets.
*
* @api
* @throws \Box\Spout\Reader\Exception\ReaderNotOpenedException If called before opening the reader
* @return \Iterator To iterate over sheets
*/
@@ -229,7 +225,6 @@ abstract class ReaderAbstract implements ReaderInterface
/**
* Closes the reader, preventing any additional reading
*
* @api
* @return void
*/
public function close()
-1
View File
@@ -17,7 +17,6 @@ class ReaderFactory
/**
* This creates an instance of the appropriate reader, given the type of the file to be read
*
* @api
* @param string $readerType Type of the reader to instantiate
* @throws \Box\Spout\Common\Exception\UnsupportedTypeException
* @return ReaderInterface
-4
View File
@@ -37,7 +37,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return \Box\Spout\Reader\XLSX\RowIterator
*/
public function getRowIterator()
@@ -46,7 +45,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return int Index of the sheet, based on order in the workbook (zero-based)
*/
public function getIndex()
@@ -55,7 +53,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return string Name of the sheet
*/
public function getName()
@@ -64,7 +61,6 @@ class Sheet implements SheetInterface
}
/**
* @api
* @return bool Whether the sheet was defined as active
*/
public function isActive()