PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Worksheet.php

Doc Comments +8 added lines, -8 removed lines

@@ -615,7 +615,7 @@ 
      *
      * @param string $index Chart index position
      * @throws Exception
-     * @return false|Chart
+     * @return null|Chart
      */
     public function getChartByIndex($index = null)
     {
@@ -1130,7 +1130,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
      */
@@ -1241,8 +1241,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 bool $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
@@ -1350,8 +1350,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 bool
      */
     public function cellExistsByColumnAndRow($pColumn = 0, $pRow = 1)
@@ -1968,7 +1968,7 @@ 
     /**
      *    Set AutoFilter
      *
-     *    @param    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
@@ -2991,7 +2991,7 @@ 
      *
      * @param null|string Same rule as Title minus space not allowed (but, like Excel, change silently space to underscore)
      * @throws Exception
-     * @return objWorksheet
+     * @return Worksheet
      */
     public function setCodeName($pValue = null)
     {

src/PhpSpreadsheet/Writer/Xls/Parser.php

Doc Comments +9 added lines, -9 removed lines

@@ -507,7 +507,7 @@ 
      *
      * @param mixed $token The token to convert
      *
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convert($token)
     {
@@ -577,7 +577,7 @@ 
      *
      * @param string $string A string for conversion to its ptg value
      *
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convertString($string)
     {
@@ -656,7 +656,7 @@ 
      *
      * @param string $token An Excel range in the Sheet1!A1:A2 format
      *
-     * @return mixed The packed ptgArea3d token on success
+     * @return string The packed ptgArea3d token on success
      */
     private function convertRange3d($token)
     {
@@ -708,7 +708,7 @@ 
      *
      * @param string $cell An Excel cell reference
      *
-     * @return mixed The packed ptgRef3d token on success
+     * @return string The packed ptgRef3d token on success
      */
     private function convertRef3d($cell)
     {
@@ -807,7 +807,7 @@ 
      *
      * @param string $ext_ref The name of the external reference
      *
-     * @return mixed The reference index in packed() format on success
+     * @return string The reference index in packed() format on success
      */
     private function getRefIndex($ext_ref)
     {
@@ -898,7 +898,7 @@ 
      *
      * @param string $cell The Excel cell reference to be packed
      *
-     * @return array Array containing the row and column in packed() format
+     * @return string[] Array containing the row and column in packed() format
      */
     private function cellToPackedRowcol($cell)
     {
@@ -927,7 +927,7 @@ 
      *
      * @param string $range The Excel range to be packed
      *
-     * @return array Array containing (row1,col1,row2,col2) in packed() format
+     * @return string[] Array containing (row1,col1,row2,col2) in packed() format
      */
     private function rangeToPackedRange($range)
     {
@@ -1043,7 +1043,7 @@ 
     /**
      * Checks if it's a valid token.
      *
-     * @param mixed $token The token to check
+     * @param string $token The token to check
      *
      * @return mixed The checked token or false on failure
      */
@@ -1129,7 +1129,7 @@ 
      * @param string $formula The formula to parse, without the initial equal
      *                        sign (=)
      *
-     * @return mixed true on success
+     * @return boolean true on success
      */
     public function parse($formula)
     {

src/PhpSpreadsheet/Writer/Xls/Workbook.php

Doc Comments +2 added lines, -1 removed lines

@@ -242,6 +242,7 @@ 
      *
      * @param \PhpOffice\PhpSpreadsheet\Style
      * @param bool Is it a style XF?
+     * @param \PhpOffice\PhpSpreadsheet\Style $style
      *
      * @return int Index to XF record
      */
@@ -796,7 +797,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 bool   $isBuiltIn   Built-in name?
      *
      * @return string Complete binary record data

src/PhpSpreadsheet/Writer/Xls/Worksheet.php

Doc Comments +8 added lines, -6 removed lines

@@ -219,6 +219,8 @@ 
      * @param bool                                $preCalculateFormulas Flag indicating whether formulas should be calculated or just written
      * @param string                              $phpSheet             The worksheet to write
      * @param \PhpOffice\PhpSpreadsheet\Worksheet $phpSheet
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet)
     {
@@ -620,7 +622,7 @@ 
      * @param int   $row     Zero indexed row
      * @param int   $col     Zero indexed column
      * @param float $num     The number to write
-     * @param mixed $xfIndex The optional XF format
+     * @param integer $xfIndex The optional XF format
      *
      * @return int
      */
@@ -729,7 +731,7 @@ 
      * @param int    $row     Zero indexed row
      * @param int    $col     Zero indexed column
      * @param string $str     The string to write
-     * @param mixed  $xfIndex The XF format index for the cell
+     * @param integer  $xfIndex The XF format index for the cell
      *
      * @return int
      */
@@ -796,7 +798,7 @@ 
      *
      * @param int   $row     Zero indexed row
      * @param int   $col     Zero indexed column
-     * @param mixed $xfIndex The XF format index
+     * @param integer $xfIndex The XF format index
      */
     public function writeBlank($row, $col, $xfIndex)
     {
@@ -843,7 +845,7 @@ 
      * @param int    $row             Zero indexed row
      * @param int    $col             Zero indexed column
      * @param string $formula         The formula text string
-     * @param mixed  $xfIndex         The XF format index
+     * @param integer  $xfIndex         The XF format index
      * @param mixed  $calculatedValue Calculated value
      *
      * @return int
@@ -2323,8 +2325,8 @@ 
      * @param mixed $bitmap  The bitmap filename or GD-image resource
      * @param int   $x       The horizontal position (offset) of the image inside the cell
      * @param int   $y       The vertical position (offset) of the image inside the cell
-     * @param float $scale_x The horizontal scale
-     * @param float $scale_y The vertical scale
+     * @param integer $scale_x The horizontal scale
+     * @param integer $scale_y The vertical scale
      */
     public function insertBitmap($row, $col, $bitmap, $x = 0, $y = 0, $scale_x = 1, $scale_y = 1)
     {