PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Shared/Font.php

Doc Comments +3 added lines, -2 removed lines

@@ -237,7 +237,7 @@ 
      * Calculate an (approximate) OpenXML column width, based on font size and text contained
      *
      * @param     \PhpSpreadsheet\Style\Font            $font            Font object
-     * @param     \PhpSpreadsheet\RichText|string    $cellText        Text to calculate width
+     * @param     string    $cellText        Text to calculate width
      * @param     integer                        $rotation        Rotation angle
      * @param     \PhpSpreadsheet\Style\Font|NULL    $defaultFont    Font object
      * @return     integer        Column width
@@ -406,7 +406,7 @@ 
      * Calculate an (approximate) pixel size, based on centimeter size
      *
      * @param     int        $sizeInCm    Font size (in centimeters)
-     * @return     int        Size (in pixels)
+     * @return     double        Size (in pixels)
      */
     public static function centimeterSizeToPixels($sizeInCm = 1)
     {
@@ -417,6 +417,7 @@ 
      * Returns the font path given the font
      *
      * @param \PhpSpreadsheet\Style\Font
+     * @param \PhpSpreadsheet\Style\Font $font
      * @return string Path to TrueType font file
      */
     public static function getTrueTypeFontFileFromFont($font)

src/PhpSpreadsheet/Style.php

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
     /**
      * Get parent. Only used for style supervisor
      *
-     * @return PhpSpreadsheet
+     * @return Style
      */
     public function getParent()
     {

src/PhpSpreadsheet/Worksheet.php

Doc Comments +16 added lines, -16 removed lines

@@ -328,7 +328,7 @@ 
     /**
      * Create a new worksheet
      *
-     * @param Spreadsheet        $Parent
+     * @param Spreadsheet        $parent
      * @param string        $pTitle
      */
     public function __construct(Spreadsheet $parent = null, $pTitle = 'Worksheet')
@@ -585,7 +585,7 @@ 
      * Get a chart by its index position
      *
      * @param string $index Chart index position
-     * @return false|Chart
+     * @return null|Chart
      * @throws Exception
      */
     public function getChartByIndex($index = null)
@@ -767,7 +767,7 @@ 
     /**
      * Get parent
      *
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function getParent()
     {
@@ -1077,7 +1077,7 @@ 
      * Set a cell value
      *
      * @param string $pCoordinate Coordinate of the cell
-     * @param mixed $pValue Value of the cell
+     * @param integer $pValue Value of the cell
      * @param bool $returnCell   Return the worksheet (false, default) or the cell (true)
      * @return Worksheet|Cell    Depending on the last parameter being specified
      */
@@ -1090,8 +1090,8 @@ 
     /**
      * Set a cell value by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell (A = 0)
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell (A = 0)
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param mixed $pValue Value of the cell
      * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
      * @return Worksheet|Cell    Depending on the last parameter being specified
@@ -1121,8 +1121,8 @@ 
     /**
      * Set a cell value by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param mixed $pValue Value of the cell
      * @param string $pDataType Explicit data type
      * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
@@ -1182,8 +1182,8 @@ 
     /**
      * Get cell at a specific coordinate by using numeric cell coordinates
      *
-     * @param  string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param  integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param boolean $createIfNotExists  Flag indicating whether a new cell should be created if it doesn't
      *                                       already exist, or a null should be returned instead
      * @return null|Cell Cell that was found/created or null
@@ -1290,8 +1290,8 @@ 
     /**
      * Cell at a specific coordinate by using numeric cell coordinates exists?
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @return boolean
      */
     public function cellExistsByColumnAndRow($pColumn = 0, $pRow = 1)
@@ -1350,7 +1350,7 @@ 
     /**
      * Get column dimension at a specific column by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
      * @return Worksheet\ColumnDimension
      */
     public function getColumnDimensionByColumn($pColumn = 0)
@@ -1471,7 +1471,7 @@ 
     /**
      * Set conditional styles
      *
-     * @param $pCoordinate string E.g. 'A1'
+     * @param string $pCoordinate string E.g. 'A1'
      * @param $pValue Style\Conditional[]
      * @return Worksheet
      */
@@ -1892,7 +1892,7 @@ 
     /**
      *    Set AutoFilter
      *
-     *    @param    Worksheet\AutoFilter|string   $pValue
+     *    @param    string   $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *    @throws Exception
      *    @return Worksheet
@@ -2902,7 +2902,7 @@ 
      * Define the code name of the sheet
      *
      * @param null|string Same rule as Title minus space not allowed (but, like Excel, change silently space to underscore)
-     * @return objWorksheet
+     * @return Worksheet
      * @throws Exception
     */
     public function setCodeName($pValue = null)

src/PhpSpreadsheet/Worksheet/AutoFilter/Column/Rule.php

Doc Comments +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
      *
      *    @param   string        $pRuleType
      *    @throws  \PhpSpreadsheet\Exception
-     *    @return  \PhpSpreadsheet\Worksheet\AutoFilter\Column
+     *    @return  Rule
      */
     public function setRuleType($pRuleType = self::AUTOFILTER_RULETYPE_FILTER)
     {

src/PhpSpreadsheet/Worksheet/ColumnCellIterator.php

Doc Comments +1 added lines, -1 removed lines

@@ -135,7 +135,7 @@
     /**
      * Return the current cell in this worksheet column
      *
-     * @return Row
+     * @return null|\PhpSpreadsheet\Cell
      */
     public function current()
     {

src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php

Doc Comments +1 added lines, -1 removed lines

@@ -229,7 +229,7 @@
     /**
      * Set Color
      *
-     * @param    \PhpSpreadsheet\Style_Color $pValue
+     * @param    \PhpSpreadsheet\Style\Color $pValue
      * @throws   \PhpSpreadsheet\Exception
      * @return   Shadow
      */

src/PhpSpreadsheet/Writer/CSV.php

Doc Comments +1 added lines, -1 removed lines

@@ -311,7 +311,7 @@
     /**
      * Write line to CSV file
      *
-     * @param    mixed    $pFileHandle    PHP filehandle
+     * @param    resource    $pFileHandle    PHP filehandle
      * @param    array    $pValues        Array containing values in a row
      * @throws    Exception
      */

src/PhpSpreadsheet/Writer/Excel2007/Chart.php

Doc Comments +6 added lines, -1 removed lines

@@ -411,6 +411,8 @@ 
      * @param  string $id1
      * @param  string $id2
      * @param  boolean $isMultiLevelSeries
+     * @param null|Axis $xAxis
+     * @param null|Axis $yAxis
      *
      * @throws  \PhpSpreadsheet\Writer\Exception
      */
@@ -533,6 +535,10 @@ 
      * @param  string $id1
      * @param  string $id2
      * @param  boolean $isMultiLevelSeries
+     * @param null|Axis $xAxis
+     * @param null|Axis $yAxis
+     * @param null|GridLines $majorGridlines
+     * @param null|GridLines $minorGridlines
      *
      * @throws  \PhpSpreadsheet\Writer\Exception
      */
@@ -1259,7 +1265,6 @@ 
      * @param  \PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer
      * @param  string $groupType Type of plot for dataseries
      * @param  string $dataType Datatype of series values
-     * @param  \PhpSpreadsheet\Worksheet $pSheet
      *
      * @throws  \PhpSpreadsheet\Writer\Exception
      */

src/PhpSpreadsheet/Writer/Excel5/Workbook.php

Doc Comments +5 added lines, -2 removed lines

@@ -191,7 +191,9 @@ 
      * @param int        &$str_unique    Total number of unique strings
      * @param array        &$str_table        String Table
      * @param array        &$colors        Colour Table
-     * @param mixed        $parser            The formula parser created for the Workbook
+     * @param Parser        $parser            The formula parser created for the Workbook
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(\PhpSpreadsheet\Spreadsheet $spreadsheet, &$str_total, &$str_unique, &$str_table, &$colors, $parser)
     {
@@ -238,6 +240,7 @@ 
      *
      * @param \PhpSpreadsheet\Style
      * @param boolean Is it a style XF?
+     * @param \PhpSpreadsheet\Style $style
      * @return int Index to XF record
      */
     public function addXfWriter($style, $isStyleXf = false)
@@ -790,7 +793,7 @@ 
      *
      * @param    string        $name            The name in UTF-8
      * @param    string        $formulaData    The binary formula data
-     * @param    string        $sheetIndex        1-based sheet index the defined name applies to. 0 = global
+     * @param    integer        $sheetIndex        1-based sheet index the defined name applies to. 0 = global
      * @param    boolean        $isBuiltIn        Built-in name?
      * @return    string    Complete binary record data
      */