PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php

Doc Comments +1 added lines, -1 removed lines

@@ -220,7 +220,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,:)
      *    @\PhpSpreadsheet\Calculation\Exception  IllegalArgumentException Matrix row dimensions must agree.
      *    @\PhpSpreadsheet\Calculation\Exception  RuntimeException  Matrix is singular.

src/PhpSpreadsheet/Shared/JAMA/Matrix.php

Doc Comments +2 added lines, -33 removed lines

@@ -146,11 +146,6 @@ 
      *    getMatrix
      *
      *    Get a submatrix
-     *    @param int $i0 Initial row index
-     *    @param int $iF Final row index
-     *    @param int $j0 Initial column index
-     *    @param int $jF Final column index
-     *    @return Matrix Submatrix
      */
     public function getMatrix()
     {
@@ -354,7 +349,7 @@ 
      *    Generate a diagonal matrix
      *    @param int $m Row dimension
      *    @param int $n Column dimension
-     *    @param mixed $c Diagonal value
+     *    @param integer $c Diagonal value
      *    @return Matrix Diagonal matrix
      */
     public function diagonal($m = null, $n = null, $c = 1)
@@ -431,7 +426,7 @@ 
      *    trace
      *
      *    Sum of diagonal elements
-     *    @return float Sum of diagonal elements
+     *    @return integer Sum of diagonal elements
      */
     public function trace()
     {
@@ -458,8 +453,6 @@ 
      *    plus
      *
      *    A + B
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Sum
      */
     public function plus()
     {
@@ -499,8 +492,6 @@ 
      *    plusEquals
      *
      *    A = A + B
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Sum
      */
     public function plusEquals()
     {
@@ -554,8 +545,6 @@ 
      *    minus
      *
      *    A - B
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Sum
      */
     public function minus()
     {
@@ -595,8 +584,6 @@ 
      *    minusEquals
      *
      *    A = A - B
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Sum
      */
     public function minusEquals()
     {
@@ -651,8 +638,6 @@ 
      *
      *    Element-by-element multiplication
      *    Cij = Aij * Bij
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Matrix Cij
      */
     public function arrayTimes()
     {
@@ -693,8 +678,6 @@ 
      *
      *    Element-by-element multiplication
      *    Aij = Aij * Bij
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Matrix Aij
      */
     public function arrayTimesEquals()
     {
@@ -749,8 +732,6 @@ 
      *
      *    Element-by-element right division
      *    A / B
-     *    @param Matrix $B Matrix B
-     *    @return Matrix Division result
      */
     public function arrayRightDivide()
     {
@@ -810,8 +791,6 @@ 
      *
      *    Element-by-element right division
      *    Aij = Aij / Bij
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Matrix Aij
      */
     public function arrayRightDivideEquals()
     {
@@ -852,8 +831,6 @@ 
      *
      *    Element-by-element Left division
      *    A / B
-     *    @param Matrix $B Matrix B
-     *    @return Matrix Division result
      */
     public function arrayLeftDivide()
     {
@@ -894,8 +871,6 @@ 
      *
      *    Element-by-element Left division
      *    Aij = Aij / Bij
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Matrix Aij
      */
     public function arrayLeftDivideEquals()
     {
@@ -935,8 +910,6 @@ 
      *    times
      *
      *    Matrix multiplication
-     *    @param mixed $n Matrix/Array/Scalar
-     *    @return Matrix Product
      */
     public function times()
     {
@@ -1036,8 +1009,6 @@ 
      *    power
      *
      *    A = A ^ B
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Sum
      */
     public function power()
     {
@@ -1091,8 +1062,6 @@ 
      *    concat
      *
      *    A = A & B
-     *    @param mixed $B Matrix/Array
-     *    @return Matrix Sum
      */
     public function concat()
     {

src/PhpSpreadsheet/Shared/OLE/PPS/Root.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
      * If a resource pointer to a stream created by fopen() is passed
      * it will be used, but you have to close such stream by yourself.
      *
-     * @param string|resource $filename The name of the file or stream where to save the OLE container.
+     * @param string|null $filename The name of the file or stream where to save the OLE container.
      * @throws \PhpSpreadsheet\Writer\Exception
      * @return bool true on success
      */
@@ -117,7 +117,7 @@ 
      * Calculate some numbers
      *
      * @param array $raList Reference to an array of PPS's
-     * @return float[] The array of numbers
+     * @return double[] The array of numbers
      */
     public function _calcSize(&$raList)
     {

src/PhpSpreadsheet/Shared/PCLZip/PclZip.php

Doc Comments +8 added lines

@@ -2215,6 +2215,10 @@ 
     // Description :
     // Parameters :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_mode
+     */
     public function privOpenFd($p_mode)
     {
         $v_result = 1;
@@ -3815,6 +3819,10 @@ 
     // Parameters :
     // Return Values :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_string
+     */
     public function privExtractFileAsString(&$p_entry, &$p_string, &$p_options)
     {
         $v_result = 1;

src/PhpSpreadsheet/Shared/Trend/BestFit.php

Doc Comments +4 added lines

@@ -316,6 +316,10 @@
         return $this->yBestFitValues;
     }
 
+    /**
+     * @param double $sumY2
+     * @param boolean $const
+     */
     protected function calculateGoodnessOfFit($sumX, $sumY, $sumX2, $sumY2, $sumXY, $meanX, $meanY, $const)
     {
         $SSres = $SScov = $SScor = $SStot = $SSsex = 0.0;

src/PhpSpreadsheet/Shared/ZipArchive.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
      * Find if given fileName exist in archive (Emulate ZipArchive locateName())
      *
      * @param        string        $fileName        Filename for the file in zip archive
-     * @return        bool
+     * @return        integer
      */
     public function locateName($fileName)
     {

src/PhpSpreadsheet/Shared/ZipStreamWrapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -166,7 +166,7 @@
      *
      * @param    int        $offset    byte offset
      * @param    int        $whence    SEEK_SET, SEEK_CUR or SEEK_END
-     * @return    bool
+     * @return    boolean|null
      */
     public function stream_seek($offset, $whence) // @codingStandardsIgnoreLine
     {

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/Worksheet.php

Doc Comments +8 added lines, -8 removed lines

@@ -584,7 +584,7 @@ 
      *
      * @param string $index Chart index position
      * @throws Exception
-     * @return false|Chart
+     * @return null|Chart
      */
     public function getChartByIndex($index = null)
     {
@@ -1085,7 +1085,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
      */
@@ -1196,8 +1196,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
@@ -1305,8 +1305,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)
@@ -1923,7 +1923,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
@@ -2954,7 +2954,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)
     {