Remove @api annotation

2017-11-05 02:23:26 +01:00
1 parent 3851e05f83
commit 727a90fd06
@@ -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
     */
@@ -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()
@@ -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
@@ -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
@@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception;

 /**
 * Class InvalidColorException
- *
- * @api
 */
 class InvalidColorException extends WriterException
 {
@@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception;

 /**
 * Class InvalidSheetNameException
- *
- * @api
 */
 class InvalidSheetNameException extends WriterException
 {
@@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception;

 /**
 * Class SheetNotFoundException
- *
- * @api
 */
 class SheetNotFoundException extends WriterException
 {
@@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception;

 /**
 * Class WriterAlreadyOpenedException
- *
- * @api
 */
 class WriterAlreadyOpenedException extends WriterException
 {
@@ -4,8 +4,6 @@ namespace Box\Spout\Writer\Exception;

 /**
 * Class WriterNotOpenedException
- *
- * @api
 */
 class WriterNotOpenedException extends WriterException
 {
@@ -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
@@ -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
@@ -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
@@ -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