PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +9 added lines, -14 removed lines

@@ -133,7 +133,7 @@ 
      * @param mixed $p
      * @param mixed $q
      *
-     * @return 0 if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
+     * @return double if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
      *
      * @author Jaco van Kooten
      */
@@ -159,8 +159,8 @@ 
      * @author Jaco van Kooten
      *
      * @param mixed $x
-     * @param mixed $p
-     * @param mixed $q
+     * @param double $p
+     * @param double $q
      */
     private static function betaFraction($x, $p, $q)
     {
@@ -909,8 +909,8 @@ 
      * @param float $value Value at which you want to evaluate the distribution
      * @param float $alpha Parameter to the distribution
      * @param float $beta Parameter to the distribution
-     * @param mixed $rMin
-     * @param mixed $rMax
+     * @param integer $rMin
+     * @param integer $rMax
      *
      * @return float
      */
@@ -948,8 +948,8 @@ 
      * @param float $probability Probability at which you want to evaluate the distribution
      * @param float $alpha Parameter to the distribution
      * @param float $beta Parameter to the distribution
-     * @param float $rMin Minimum value
-     * @param float $rMax Maximum value
+     * @param integer $rMin Minimum value
+     * @param integer $rMax Maximum value
      *
      * @return float
      */
@@ -2015,7 +2015,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Position (ordered from the largest) in the array or range of data to return
      *
      * @return float
      */
@@ -2745,7 +2744,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $entry Percentile value in the range 0..1, inclusive.
      *
      * @return float
      */
@@ -2796,7 +2794,7 @@ 
      * @param number the number of significant digits for the returned percentage value
      * @param mixed $valueSet
      * @param mixed $value
-     * @param mixed $significance
+     * @param integer $significance
      *
      * @return float
      */
@@ -2917,7 +2915,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Quartile value in the range 1..3, inclusive.
      *
      * @return float
      */
@@ -2950,7 +2947,7 @@ 
      * @param mixed Order to sort the values in the value set
      * @param mixed $value
      * @param mixed $valueSet
-     * @param mixed $order
+     * @param integer $order
      *
      * @return float
      */
@@ -3092,7 +3089,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Position (ordered from the smallest) in the array or range of data to return
      *
      * @return float
      */
@@ -3556,7 +3552,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $discard Percentage to discard
      *
      * @return float
      */

src/PhpSpreadsheet/Reader/Xls.php

Doc Comments +5 added lines, -5 removed lines

@@ -5118,7 +5118,7 @@ 
      * is in one piece.
      * Moves to next current position in data stream to start of next record different from a CONtINUE record.
      *
-     * @return array
+     * @return integer|null
      */
     private function getSplicedRecordData()
     {
@@ -5368,7 +5368,7 @@ 
      *
      * @throws Exception
      *
-     * @return array
+     * @return string
      */
     private function getNextToken($formulaData, $baseCell = 'A1')
     {
@@ -6945,7 +6945,7 @@ 
      *
      * @param string $subData
      *
-     * @return array
+     * @return string
      */
     private function readBIFF8CellRangeAddressList($subData)
     {
@@ -7060,7 +7060,7 @@ 
      *
      * @param string $arrayData
      *
-     * @return array
+     * @return string
      */
     private static function readBIFF8ConstantArray($arrayData)
     {
@@ -7099,7 +7099,7 @@ 
      *
      * @param string $valueData
      *
-     * @return array
+     * @return string
      */
     private static function readBIFF8Constant($valueData)
     {

src/PhpSpreadsheet/Reader/Xls/MD5.php

Doc Comments +5 added lines

@@ -187,6 +187,11 @@
         return $Y ^ ($X | (~$Z)); // Y XOR (X OR NOT Z)
     }
 
+    /**
+     * @param string[] $func
+     * @param integer $s
+     * @param integer $t
+     */
     private static function step($func, &$A, $B, $C, $D, $M, $s, $t)
     {
         $A = ($A + call_user_func($func, $B, $C, $D) + $M + $t) & 0xffffffff;

src/PhpSpreadsheet/Shared/OLERead.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
     /**
      * Read the file.
      *
-     * @param $pFilename string Filename
+     * @param string $pFilename string Filename
      *
      * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
      */

src/PhpSpreadsheet/Style.php

Doc Comments +1 added lines, -1 removed lines

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

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
      */

docs/Examples/Reader/exampleReader12.php

Spacing +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
     }
 }
 
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 /*  Create a new Reader of the type defined in $inputFileType  **/
 $reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
 

docs/Examples/Reader/exampleReader06.php

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
 //	$inputFileType = 'Gnumeric';
 $inputFileName = './sampleData/example1.xls';
 
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 $reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
 echo 'Loading all WorkSheets<br />';
 $reader->setLoadAllSheets();