diff --git a/src/Spout/Common/Exception/EncodingConversionException.php b/src/Spout/Common/Exception/EncodingConversionException.php index aae1e4c..098d064 100644 --- a/src/Spout/Common/Exception/EncodingConversionException.php +++ b/src/Spout/Common/Exception/EncodingConversionException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Common\Exception; /** * Class EncodingConversionException - * - * @api */ class EncodingConversionException extends SpoutException { diff --git a/src/Spout/Common/Exception/IOException.php b/src/Spout/Common/Exception/IOException.php index 1bd269b..3ccae4c 100644 --- a/src/Spout/Common/Exception/IOException.php +++ b/src/Spout/Common/Exception/IOException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Common\Exception; /** * Class IOException - * - * @api */ class IOException extends SpoutException { diff --git a/src/Spout/Common/Exception/InvalidArgumentException.php b/src/Spout/Common/Exception/InvalidArgumentException.php index 6b79a57..5fadc25 100644 --- a/src/Spout/Common/Exception/InvalidArgumentException.php +++ b/src/Spout/Common/Exception/InvalidArgumentException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Common\Exception; /** * Class InvalidArgumentException - * - * @api */ class InvalidArgumentException extends SpoutException { diff --git a/src/Spout/Common/Exception/UnsupportedTypeException.php b/src/Spout/Common/Exception/UnsupportedTypeException.php index 1281dcd..1fd59e0 100644 --- a/src/Spout/Common/Exception/UnsupportedTypeException.php +++ b/src/Spout/Common/Exception/UnsupportedTypeException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Common\Exception; /** * Class UnsupportedTypeException - * - * @api */ class UnsupportedTypeException extends SpoutException { diff --git a/src/Spout/Common/Type.php b/src/Spout/Common/Type.php index 5e9b75e..24c0718 100644 --- a/src/Spout/Common/Type.php +++ b/src/Spout/Common/Type.php @@ -5,8 +5,6 @@ namespace Box\Spout\Common; /** * Class Type * This class references the supported types - * - * @api */ abstract class Type { diff --git a/src/Spout/Reader/CSV/Sheet.php b/src/Spout/Reader/CSV/Sheet.php index 3453ffb..aa175d2 100644 --- a/src/Spout/Reader/CSV/Sheet.php +++ b/src/Spout/Reader/CSV/Sheet.php @@ -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() diff --git a/src/Spout/Reader/Exception/IteratorNotRewindableException.php b/src/Spout/Reader/Exception/IteratorNotRewindableException.php index cb6cb2a..ef23e1f 100644 --- a/src/Spout/Reader/Exception/IteratorNotRewindableException.php +++ b/src/Spout/Reader/Exception/IteratorNotRewindableException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Reader\Exception; /** * Class IteratorNotRewindableException - * - * @api */ class IteratorNotRewindableException extends ReaderException { diff --git a/src/Spout/Reader/Exception/NoSheetsFoundException.php b/src/Spout/Reader/Exception/NoSheetsFoundException.php index 71c6655..b74a5ae 100644 --- a/src/Spout/Reader/Exception/NoSheetsFoundException.php +++ b/src/Spout/Reader/Exception/NoSheetsFoundException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Reader\Exception; /** * Class NoSheetsFoundException - * - * @api */ class NoSheetsFoundException extends ReaderException { diff --git a/src/Spout/Reader/Exception/ReaderNotOpenedException.php b/src/Spout/Reader/Exception/ReaderNotOpenedException.php index 9418d9a..aa00ea3 100644 --- a/src/Spout/Reader/Exception/ReaderNotOpenedException.php +++ b/src/Spout/Reader/Exception/ReaderNotOpenedException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Reader\Exception; /** * Class ReaderNotOpenedException - * - * @api */ class ReaderNotOpenedException extends ReaderException { diff --git a/src/Spout/Reader/Exception/SharedStringNotFoundException.php b/src/Spout/Reader/Exception/SharedStringNotFoundException.php index 106c566..024b43d 100644 --- a/src/Spout/Reader/Exception/SharedStringNotFoundException.php +++ b/src/Spout/Reader/Exception/SharedStringNotFoundException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Reader\Exception; /** * Class SharedStringNotFoundException - * - * @api */ class SharedStringNotFoundException extends ReaderException { diff --git a/src/Spout/Reader/ODS/Sheet.php b/src/Spout/Reader/ODS/Sheet.php index 31879c8..e696a1a 100644 --- a/src/Spout/Reader/ODS/Sheet.php +++ b/src/Spout/Reader/ODS/Sheet.php @@ -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() diff --git a/src/Spout/Reader/ReaderAbstract.php b/src/Spout/Reader/ReaderAbstract.php index e8ee5f0..b789636 100644 --- a/src/Spout/Reader/ReaderAbstract.php +++ b/src/Spout/Reader/ReaderAbstract.php @@ -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() diff --git a/src/Spout/Reader/ReaderFactory.php b/src/Spout/Reader/ReaderFactory.php index fb68f49..02b4e2f 100644 --- a/src/Spout/Reader/ReaderFactory.php +++ b/src/Spout/Reader/ReaderFactory.php @@ -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 diff --git a/src/Spout/Reader/XLSX/Sheet.php b/src/Spout/Reader/XLSX/Sheet.php index bff1fb4..592c7c3 100644 --- a/src/Spout/Reader/XLSX/Sheet.php +++ b/src/Spout/Reader/XLSX/Sheet.php @@ -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() diff --git a/src/Spout/Writer/CSV/Writer.php b/src/Spout/Writer/CSV/Writer.php index 0f75ecd..12c1823 100644 --- a/src/Spout/Writer/CSV/Writer.php +++ b/src/Spout/Writer/CSV/Writer.php @@ -26,7 +26,6 @@ class Writer extends WriterAbstract /** * Sets the field delimiter for the CSV * - * @api * @param string $fieldDelimiter Character that delimits fields * @return Writer */ @@ -40,7 +39,6 @@ class Writer extends WriterAbstract /** * Sets the field enclosure for the CSV * - * @api * @param string $fieldEnclosure Character that enclose fields * @return Writer */ @@ -54,7 +52,6 @@ class Writer extends WriterAbstract /** * Set if a BOM has to be added to the file * - * @api * @param bool $shouldAddBOM * @return Writer */ diff --git a/src/Spout/Writer/Common/Creator/Style/StyleBuilder.php b/src/Spout/Writer/Common/Creator/Style/StyleBuilder.php index 1a8c710..0432ccf 100644 --- a/src/Spout/Writer/Common/Creator/Style/StyleBuilder.php +++ b/src/Spout/Writer/Common/Creator/Style/StyleBuilder.php @@ -25,7 +25,6 @@ class StyleBuilder /** * Makes the font bold. * - * @api * @return StyleBuilder */ public function setFontBold() @@ -38,7 +37,6 @@ class StyleBuilder /** * Makes the font italic. * - * @api * @return StyleBuilder */ public function setFontItalic() @@ -51,7 +49,6 @@ class StyleBuilder /** * Makes the font underlined. * - * @api * @return StyleBuilder */ public function setFontUnderline() @@ -64,7 +61,6 @@ class StyleBuilder /** * Makes the font struck through. * - * @api * @return StyleBuilder */ public function setFontStrikethrough() @@ -77,7 +73,6 @@ class StyleBuilder /** * Sets the font size. * - * @api * @param int $fontSize Font size, in pixels * @return StyleBuilder */ @@ -91,7 +86,6 @@ class StyleBuilder /** * Sets the font color. * - * @api * @param string $fontColor ARGB color (@see Color) * @return StyleBuilder */ @@ -105,7 +99,6 @@ class StyleBuilder /** * Sets the font name. * - * @api * @param string $fontName Name of the font to use * @return StyleBuilder */ @@ -119,7 +112,6 @@ class StyleBuilder /** * Makes the text wrap in the cell if requested * - * @api * @param bool $shouldWrap Should the text be wrapped * @return StyleBuilder */ @@ -146,7 +138,6 @@ class StyleBuilder /** * Sets a background color * - * @api * @param string $color ARGB color (@see Color) * @return StyleBuilder */ @@ -160,7 +151,6 @@ class StyleBuilder /** * Returns the configured style. The style is cached and can be reused. * - * @api * @return Style */ public function build() diff --git a/src/Spout/Writer/Common/Entity/Sheet.php b/src/Spout/Writer/Common/Entity/Sheet.php index ddb9d60..5713175 100644 --- a/src/Spout/Writer/Common/Entity/Sheet.php +++ b/src/Spout/Writer/Common/Entity/Sheet.php @@ -41,7 +41,6 @@ class Sheet } /** - * @api * @return int Index of the sheet, based on order in the workbook (zero-based) */ public function getIndex() @@ -58,7 +57,6 @@ class Sheet } /** - * @api * @return string Name of the sheet */ public function getName() @@ -73,7 +71,6 @@ class Sheet * - it should not contain these characters: \ / ? * : [ or ] * - it should be unique * - * @api * @param string $name Name of the sheet * @throws \Box\Spout\Writer\Exception\InvalidSheetNameException If the sheet's name is invalid. * @return Sheet diff --git a/src/Spout/Writer/Common/Entity/Style/Color.php b/src/Spout/Writer/Common/Entity/Style/Color.php index 6b3682e..1f85da9 100644 --- a/src/Spout/Writer/Common/Entity/Style/Color.php +++ b/src/Spout/Writer/Common/Entity/Style/Color.php @@ -27,7 +27,6 @@ class Color /** * Returns an RGB color from R, G and B values * - * @api * @param int $red Red component, 0 - 255 * @param int $green Green component, 0 - 255 * @param int $blue Blue component, 0 - 255 diff --git a/src/Spout/Writer/Exception/InvalidColorException.php b/src/Spout/Writer/Exception/InvalidColorException.php index b4428f2..250878c 100644 --- a/src/Spout/Writer/Exception/InvalidColorException.php +++ b/src/Spout/Writer/Exception/InvalidColorException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception; /** * Class InvalidColorException - * - * @api */ class InvalidColorException extends WriterException { diff --git a/src/Spout/Writer/Exception/InvalidSheetNameException.php b/src/Spout/Writer/Exception/InvalidSheetNameException.php index 6a5f934..56bfc1c 100644 --- a/src/Spout/Writer/Exception/InvalidSheetNameException.php +++ b/src/Spout/Writer/Exception/InvalidSheetNameException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception; /** * Class InvalidSheetNameException - * - * @api */ class InvalidSheetNameException extends WriterException { diff --git a/src/Spout/Writer/Exception/SheetNotFoundException.php b/src/Spout/Writer/Exception/SheetNotFoundException.php index bc6aaa9..cd87b5c 100644 --- a/src/Spout/Writer/Exception/SheetNotFoundException.php +++ b/src/Spout/Writer/Exception/SheetNotFoundException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception; /** * Class SheetNotFoundException - * - * @api */ class SheetNotFoundException extends WriterException { diff --git a/src/Spout/Writer/Exception/WriterAlreadyOpenedException.php b/src/Spout/Writer/Exception/WriterAlreadyOpenedException.php index 8e049c8..ad8e222 100644 --- a/src/Spout/Writer/Exception/WriterAlreadyOpenedException.php +++ b/src/Spout/Writer/Exception/WriterAlreadyOpenedException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception; /** * Class WriterAlreadyOpenedException - * - * @api */ class WriterAlreadyOpenedException extends WriterException { diff --git a/src/Spout/Writer/Exception/WriterNotOpenedException.php b/src/Spout/Writer/Exception/WriterNotOpenedException.php index 518cf2b..7b6063a 100644 --- a/src/Spout/Writer/Exception/WriterNotOpenedException.php +++ b/src/Spout/Writer/Exception/WriterNotOpenedException.php @@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception; /** * Class WriterNotOpenedException - * - * @api */ class WriterNotOpenedException extends WriterException { diff --git a/src/Spout/Writer/ODS/Writer.php b/src/Spout/Writer/ODS/Writer.php index 9a05cf9..f016d57 100644 --- a/src/Spout/Writer/ODS/Writer.php +++ b/src/Spout/Writer/ODS/Writer.php @@ -18,7 +18,6 @@ class Writer extends WriterMultiSheetsAbstract * Sets a custom temporary folder for creating intermediate files/folders. * This must be set before opening the writer. * - * @api * @param string $tempFolder Temporary folder where the files to create the ODS will be stored * @throws \Box\Spout\Writer\Exception\WriterAlreadyOpenedException If the writer was already opened * @return Writer diff --git a/src/Spout/Writer/WriterFactory.php b/src/Spout/Writer/WriterFactory.php index 8395b29..6e7d8de 100644 --- a/src/Spout/Writer/WriterFactory.php +++ b/src/Spout/Writer/WriterFactory.php @@ -20,7 +20,6 @@ class WriterFactory /** * This creates an instance of the appropriate writer, given the type of the file to be read * - * @api * @param string $writerType Type of the writer to instantiate * @throws \Box\Spout\Common\Exception\UnsupportedTypeException * @return WriterInterface diff --git a/src/Spout/Writer/WriterMultiSheetsAbstract.php b/src/Spout/Writer/WriterMultiSheetsAbstract.php index 5082f09..eda9db2 100644 --- a/src/Spout/Writer/WriterMultiSheetsAbstract.php +++ b/src/Spout/Writer/WriterMultiSheetsAbstract.php @@ -51,7 +51,6 @@ abstract class WriterMultiSheetsAbstract extends WriterAbstract * Sets whether new sheets should be automatically created when the max rows limit per sheet is reached. * This must be set before opening the writer. * - * @api * @param bool $shouldCreateNewSheetsAutomatically Whether new sheets should be automatically created when the max rows limit per sheet is reached * @throws WriterAlreadyOpenedException If the writer was already opened * @return WriterMultiSheetsAbstract @@ -79,7 +78,6 @@ abstract class WriterMultiSheetsAbstract extends WriterAbstract /** * Returns all the workbook's sheets * - * @api * @throws WriterNotOpenedException If the writer has not been opened yet * @return Sheet[] All the workbook's sheets */ @@ -101,7 +99,6 @@ abstract class WriterMultiSheetsAbstract extends WriterAbstract /** * Creates a new sheet and make it the current sheet. The data will now be written to this sheet. * - * @api * @throws WriterNotOpenedException If the writer has not been opened yet * @return Sheet The created sheet */ @@ -116,7 +113,6 @@ abstract class WriterMultiSheetsAbstract extends WriterAbstract /** * Returns the current sheet * - * @api * @throws WriterNotOpenedException If the writer has not been opened yet * @return Sheet The current sheet */ @@ -131,7 +127,6 @@ abstract class WriterMultiSheetsAbstract extends WriterAbstract * Sets the given sheet as the current one. New data will be written to this sheet. * The writing will resume where it stopped (i.e. data won't be truncated). * - * @api * @param Sheet $sheet The sheet to set as current * @throws WriterNotOpenedException If the writer has not been opened yet * @throws SheetNotFoundException If the given sheet does not exist in the workbook diff --git a/src/Spout/Writer/XLSX/Writer.php b/src/Spout/Writer/XLSX/Writer.php index 9fd3143..9d928fc 100644 --- a/src/Spout/Writer/XLSX/Writer.php +++ b/src/Spout/Writer/XLSX/Writer.php @@ -18,7 +18,6 @@ class Writer extends WriterMultiSheetsAbstract * Sets a custom temporary folder for creating intermediate files/folders. * This must be set before opening the writer. * - * @api * @param string $tempFolder Temporary folder where the files to create the XLSX will be stored * @throws \Box\Spout\Writer\Exception\WriterAlreadyOpenedException If the writer was already opened * @return Writer @@ -36,7 +35,6 @@ class Writer extends WriterMultiSheetsAbstract * Use inline string to be more memory efficient. If set to false, it will use shared strings. * This must be set before opening the writer. * - * @api * @param bool $shouldUseInlineStrings Whether inline or shared strings should be used * @throws \Box\Spout\Writer\Exception\WriterAlreadyOpenedException If the writer was already opened * @return Writer