PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Writer/Xls/Parser.php

Doc Comments +9 added lines, -9 removed lines

@@ -505,7 +505,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)
     {
@@ -576,7 +576,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)
     {
@@ -654,7 +654,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)
     {
@@ -706,7 +706,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)
     {
@@ -805,7 +805,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)
     {
@@ -896,7 +896,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)
     {
@@ -925,7 +925,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)
     {
@@ -1041,7 +1041,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
      */
@@ -1127,7 +1127,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/Xlsx/Chart.php

Doc Comments +6 added lines, -6 removed lines

@@ -410,8 +410,8 @@ 
      * @param string $id1
      * @param string $id2
      * @param bool $isMultiLevelSeries
-     * @param mixed $xAxis
-     * @param mixed $yAxis
+     * @param null|Axis $xAxis
+     * @param null|Axis $yAxis
      *
      * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
      */
@@ -533,10 +533,10 @@ 
      * @param string $id1
      * @param string $id2
      * @param bool $isMultiLevelSeries
-     * @param mixed $xAxis
-     * @param mixed $yAxis
-     * @param mixed $majorGridlines
-     * @param mixed $minorGridlines
+     * @param null|Axis $xAxis
+     * @param null|Axis $yAxis
+     * @param null|GridLines $majorGridlines
+     * @param null|GridLines $minorGridlines
      *
      * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
      */

src/PhpSpreadsheet/Chart/DataSeriesValues.php

Doc Comments +2 added lines, -2 removed lines

@@ -79,10 +79,10 @@
     /**
      * Create a new DataSeriesValues object.
      *
-     * @param mixed $dataType
+     * @param string $dataType
      * @param string $dataSource
      * @param null|mixed $formatCode
-     * @param mixed $pointCount
+     * @param integer $pointCount
      * @param mixed $dataValues
      * @param null|mixed $marker
      */

src/PhpSpreadsheet/Calculation/LookupRef.php

Doc Comments +10 added lines, -10 removed lines

@@ -36,7 +36,7 @@ 
      *
      * @param row Row number to use in the cell reference
      * @param column Column number to use in the cell reference
-     * @param relativity Flag indicating the type of reference to return
+     * @param relativity integer indicating the type of reference to return
      *                                1 or omitted    Absolute
      *                                2                Absolute row; relative column
      *                                3                Relative row; absolute column
@@ -47,7 +47,7 @@ 
      * @param sheetText Optional Name of worksheet to use
      * @param mixed $row
      * @param mixed $column
-     * @param mixed $relativity
+     * @param integer $relativity
      * @param mixed $referenceStyle
      * @param mixed $sheetText
      *
@@ -358,7 +358,7 @@ 
      *
      * @param cellAddress The reference from which you want to base the offset. Reference must refer to a cell or
      *                                range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value.
-     * @param rows The number of rows, up or down, that you want the upper-left cell to refer to.
+     * @param rows integer number of rows, up or down, that you want the upper-left cell to refer to.
      *                                Using 5 as the rows argument specifies that the upper-left cell in the reference is
      *                                five rows below reference. Rows can be positive (which means below the starting reference)
      *                                or negative (which means above the starting reference).
@@ -370,8 +370,8 @@ 
      * @param height The height, in number of rows, that you want the returned reference to be. Height must be a positive number.
      * @param width The width, in number of columns, that you want the returned reference to be. Width must be a positive number.
      * @param null|mixed $cellAddress
-     * @param mixed $rows
-     * @param mixed $columns
+     * @param integer $rows
+     * @param integer $columns
      * @param null|mixed $height
      * @param null|mixed $width
      * @param \PhpOffice\PhpSpreadsheet\Cell $pCell
@@ -499,7 +499,7 @@ 
      *
      * @param mixed $lookupValue The value that you want to match in lookup_array
      * @param mixed $lookupArray The range of cells being searched
-     * @param mixed $matchType The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.
+     * @param integer $matchType The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.
      *
      * @return int The relative position of the found item
      */
@@ -613,8 +613,8 @@ 
      * @param row_num The row in array from which to return a value. If row_num is omitted, column_num is required.
      * @param column_num The column in array from which to return a value. If column_num is omitted, row_num is required.
      * @param mixed $arrayValues
-     * @param mixed $rowNum
-     * @param mixed $columnNum
+     * @param integer $rowNum
+     * @param integer $columnNum
      *
      * @return mixed the value of a specified cell or array of cells
      */
@@ -710,11 +710,11 @@ 
      *
      * @param lookup_value The value that you want to match in lookup_array
      * @param lookup_array The range of cells being searched
-     * @param index_number The column number in table_array from which the matching value must be returned. The first column is 1.
+     * @param index_number integer column number in table_array from which the matching value must be returned. The first column is 1.
      * @param not_exact_match determines if you are looking for an exact match based on lookup_value
      * @param mixed $lookup_value
      * @param mixed $lookup_array
-     * @param mixed $index_number
+     * @param integer $index_number
      * @param mixed $not_exact_match
      *
      * @return mixed The value of the found cell

src/PhpSpreadsheet/Collection/Cells.php

Doc Comments +1 added lines, -1 removed lines

@@ -158,7 +158,7 @@
     /**
      * Get a list of all cell coordinates currently held in the collection.
      *
-     * @return string[]
+     * @return integer[]
      */
     public function getCoordinates()
     {

src/PhpSpreadsheet/Worksheet.php

Doc Comments +11 added lines, -11 removed lines

@@ -580,7 +580,7 @@ 
      *
      * @throws Exception
      *
-     * @return false|Chart
+     * @return null|Chart
      */
     public function getChartByIndex($index = null)
     {
@@ -1089,7 +1089,7 @@ 
      * @param string $column Return the highest data row for the specified column,
      *                                     or the highest data row of any column if no column letter is passed
      *
-     * @return string Highest row number that contains data
+     * @return integer Highest row number that contains data
      */
     public function getHighestDataRow($column = null)
     {
@@ -1143,7 +1143,7 @@ 
      * Set a cell value.
      *
      * @param string $pCoordinate Coordinate of the cell
-     * @param mixed $pValue Value of the cell
+     * @param string $pValue Value of the cell
      * @param string $pDataType Explicit data type
      * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
      *
@@ -1227,8 +1227,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
      *
@@ -1336,8 +1336,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
      */
@@ -1350,7 +1350,7 @@ 
      * Get row dimension at a specific row.
      *
      * @param int $pRow Numeric index of the row
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\RowDimension
      */
@@ -1376,7 +1376,7 @@ 
      * Get column dimension at a specific column.
      *
      * @param string $pColumn String index of the column
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\ColumnDimension
      */
@@ -1922,7 +1922,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
@@ -2988,7 +2988,7 @@ 
      *
      * @throws Exception
      *
-     * @return objWorksheet
+     * @return Worksheet
      */
     public function setCodeName($pValue = null)
     {