PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Reader/CSV.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
     /**
      * Get Contiguous
      *
-     * @return boolean
+     * @return integer
      */
     public function getContiguous()
     {

src/PhpSpreadsheet/Reader/Excel2003XML.php

Doc Comments +6 added lines

@@ -231,6 +231,9 @@ 
         return $this->loadIntoExisting($pFilename, $objPHPExcel);
     }
 
+    /**
+     * @param string $styleAttributeValue
+     */
     protected static function identifyFixedStyleValue($styleList, &$styleAttributeValue)
     {
         $styleAttributeValue = strtolower($styleAttributeValue);
@@ -786,6 +789,9 @@ 
     }
 
 
+    /**
+     * @param string $charset
+     */
     protected static function convertStringEncoding($string, $charset)
     {
         if ($charset != 'UTF-8') {

src/PhpSpreadsheet/Reader/Excel5.php

Doc Comments +16 added lines, -7 removed lines

@@ -1211,7 +1211,7 @@ 
      *
      * @param string $data   Data stream to read from
      * @param int    $pos    Position to start reading from
-     * @param int    $length Record data length
+     * @param integer $len
      *
      * @return string Record data
      */
@@ -1754,6 +1754,7 @@ 
      * @var int    $block      Block for which to create decrypto
      * @var string $valContext MD5 context state
      *
+     * @param string $valContext
      * @return Excel5\RC4
      */
     private function makeKey($block, $valContext)
@@ -1788,6 +1789,11 @@ 
      * @var string $hashedsalt_data Hashed salt data
      * @var string &$valContext     Set to the MD5 context of the value
      *
+     * @param string $password
+     * @param string $docid
+     * @param string $salt_data
+     * @param string $hashedsalt_data
+     * @param string $valContext
      * @return bool Success
      */
     private function verifyPassword($password, $docid, $salt_data, $hashedsalt_data, &$valContext)
@@ -5227,7 +5233,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()
     {
@@ -5331,8 +5337,7 @@ 
      * Take array of tokens together with additional data for formula and return human readable formula
      *
      * @param array $tokens
-     * @param array $additionalData Additional binary data going with the formula
-     * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
+     * @param string $additionalData Additional binary data going with the formula
      * @return string Human readable formula
      */
     private function createFormulaFromTokens($tokens, $additionalData)
@@ -5496,7 +5501,8 @@ 
      *
      * @param string Formula data
      * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
-     * @return array
+     * @param string $formulaData
+     * @return string
      * @throws Exception
      */
     private function getNextToken($formulaData, $baseCell = 'A1')
@@ -7070,7 +7076,7 @@ 
      * section 2.5.15
      *
      * @param string $subData
-     * @return array
+     * @return string
      */
     private function readBIFF8CellRangeAddressList($subData)
     {
@@ -7463,6 +7469,9 @@ 
     }
 
 
+    /**
+     * @param integer $rknum
+     */
     private static function getIEEE754($rknum)
     {
         if (($rknum & 0x02) != 0) {
@@ -7493,7 +7502,7 @@ 
      * Get UTF-8 string from (compressed or uncompressed) UTF-16 string
      *
      * @param string $string
-     * @param bool $compressed
+     * @param string|boolean $compressed
      * @return string
      */
     private static function encodeUTF16($string, $compressed = '')

src/PhpSpreadsheet/Reader/Excel5/Color.php

Doc Comments +1 added lines

@@ -9,6 +9,7 @@
      *
      * @param int $color Indexed color
      * @param array $palette Color palette
+     * @param integer $version
      * @return array RGB color value, example: array('rgb' => 'FF0000')
      */
     public static function map($color, $palette, $version)

src/PhpSpreadsheet/Reader/Excel5/MD5.php

Doc Comments +5 added lines

@@ -190,6 +190,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/Drawing.php

Doc Comments +3 added lines, -3 removed lines

@@ -33,7 +33,7 @@ 
      * Convert pixels to EMU
      *
      * @param     int $pValue    Value in pixels
-     * @return     int            Value in EMU
+     * @return     double            Value in EMU
      */
     public static function pixelsToEMU($pValue = 0)
     {
@@ -114,7 +114,7 @@ 
      * Convert pixels to points
      *
      * @param     int $pValue    Value in pixels
-     * @return     int            Value in points
+     * @return     double            Value in points
      */
     public static function pixelsToPoints($pValue = 0)
     {
@@ -166,7 +166,7 @@ 
      * Create a new image from file. By alexander at alexauto dot nl
      *
      * @link http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214
-     * @param string $filename Path to Windows DIB (BMP) image
+     * @param string $p_sFile
      * @return resource
      */
     public static function imagecreatefrombmp($p_sFile)

src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer/SpContainer.php

Doc Comments +2 added lines, -3 removed lines

@@ -206,7 +206,7 @@ 
     /**
      * Get the shape index
      *
-     * @return int
+     * @return boolean
      */
     public function getSpId()
     {
@@ -217,7 +217,7 @@ 
      * Set an option for the Shape Group Container
      *
      * @param int $property The number specifies the option
-     * @param mixed $value
+     * @param integer $value
      */
     public function setOPT($property, $value)
     {
@@ -331,7 +331,6 @@ 
     /**
      * Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width
      *
-     * @param int $startOffsetX
      */
     public function setEndOffsetX($endOffsetX = 0)
     {

src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php

Doc Comments +2 added lines, -2 removed lines

@@ -816,7 +816,7 @@ 
      *    Return the eigenvector matrix
      *
      *    @access public
-     *    @return V
+     *    @return Matrix
      */
     public function getV()
     {
@@ -849,7 +849,7 @@ 
      *    Return the block diagonal eigenvalue matrix
      *
      *    @access public
-     *    @return D
+     *    @return Matrix
      */
     public function getD()
     {

src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php

Doc Comments +5 added lines, -5 removed lines

@@ -59,7 +59,7 @@ 
     /**
      *    LU Decomposition constructor.
      *
-     *    @param $A Rectangular matrix
+     *    @param Matrix $A Rectangular matrix
      *    @return Structure to access L, U and piv.
      */
     public function __construct($A)
@@ -125,7 +125,7 @@ 
     /**
      *    Get lower triangular factor.
      *
-     *    @return array Lower triangular factor
+     *    @return Matrix Lower triangular factor
      */
     public function getL()
     {
@@ -146,7 +146,7 @@ 
     /**
      *    Get upper triangular factor.
      *
-     *    @return array Upper triangular factor
+     *    @return Matrix Upper triangular factor
      */
     public function getU()
     {
@@ -185,7 +185,7 @@ 
     /**
      *    Is the matrix nonsingular?
      *
-     *    @return true if U, and hence A, is nonsingular.
+     *    @return boolean if U, and hence A, is nonsingular.
      */
     public function isNonsingular()
     {
@@ -218,7 +218,7 @@ 
     /**
      *    Solve A*X = B
      *
-     *    @param  $B  A Matrix with as many rows as A and any number of columns.
+     *    @param  Matrix $B  A Matrix with as many rows as A and any number of columns.
      *    @return  X so that L*U*X = B(piv,:)
      *    @\PHPExcel\Calculation\Exception  IllegalArgumentException Matrix row dimensions must agree.
      *    @\PHPExcel\Calculation\Exception  RuntimeException  Matrix is singular.