PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Chart.php

Doc Comments +13 added lines

@@ -171,6 +171,7 @@ 
 
     /**
      * Create a new Chart
+     * @param string $name
      */
     public function __construct($name, Title $title = null, Legend $legend = null, PlotArea $plotArea = null, $plotVisibleOnly = true, $displayBlanksAs = '0', Title $xAxisLabel = null, Title $yAxisLabel = null, Axis $xAxis = null, Axis $yAxis = null, GridLines $majorGridlines = null, GridLines $minorGridlines = null)
     {
@@ -514,6 +515,9 @@ 
         ];
     }
 
+    /**
+     * @param integer $xOffset
+     */
     public function setTopLeftXOffset($xOffset)
     {
         $this->topLeftXOffset = $xOffset;
@@ -526,6 +530,9 @@ 
         return $this->topLeftXOffset;
     }
 
+    /**
+     * @param integer $yOffset
+     */
     public function setTopLeftYOffset($yOffset)
     {
         $this->topLeftYOffset = $yOffset;
@@ -622,6 +629,9 @@ 
         ];
     }
 
+    /**
+     * @param integer $xOffset
+     */
     public function setBottomRightXOffset($xOffset)
     {
         $this->bottomRightXOffset = $xOffset;
@@ -634,6 +644,9 @@ 
         return $this->bottomRightXOffset;
     }
 
+    /**
+     * @param integer $yOffset
+     */
     public function setBottomRightYOffset($yOffset)
     {
         $this->bottomRightYOffset = $yOffset;

src/PhpSpreadsheet/Reader/Xlsx.php

Doc Comments +12 added lines, -1 removed lines

@@ -287,6 +287,11 @@ 
         return isset($c->v) ? (string) $c->v : null;
     }
 
+    /**
+     * @param string $r
+     * @param string $cellDataType
+     * @param string $castBaseType
+     */
     private function castToFormula($c, $r, &$cellDataType, &$value, &$calculatedValue, &$sharedFormulas, $castBaseType)
     {
         $cellDataType = 'f';
@@ -343,7 +348,7 @@ 
      *
      * @throws Exception
      *
-     * @return Spreadsheet
+     * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
      */
     public function load($pFilename)
     {
@@ -2010,6 +2015,9 @@ 
         }
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Style\Border $docBorder
+     */
     private static function readBorder($docBorder, $eleBorder)
     {
         if (isset($eleBorder['style'])) {
@@ -2132,6 +2140,9 @@ 
         return preg_replace('~[^/]+/\.\./~', '', dirname($base)."/$add");
     }
 
+    /**
+     * @param string $style
+     */
     private static function toCSSArray($style)
     {
         $style = str_replace(["\r", "\n"], '', $style);

src/PhpSpreadsheet/Shared/Date.php

Doc Comments +4 added lines, -4 removed lines

@@ -169,7 +169,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a PHP Date/Time object.
      *
-     * @param int|float                 $excelTimestamp MS Excel serialized date/time value
+     * @param integer                 $excelTimestamp MS Excel serialized date/time value
      * @param \DateTimeZone|string|null $timeZone       The timezone to assume for the Excel timestamp,
      *                                                  if you don't want to treat it as a UTC value
      *                                                  Use the default (UST) unless you absolutely need a conversion
@@ -210,7 +210,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a unix timestamp.
      *
-     * @param int|float                 $excelTimestamp MS Excel serialized date/time value
+     * @param integer                 $excelTimestamp MS Excel serialized date/time value
      * @param \DateTimeZone|string|null $timeZone       The timezone to assume for the Excel timestamp,
      *                                                  if you don't want to treat it as a UTC value
      *                                                  Use the default (UST) unless you absolutely need a conversion
@@ -228,7 +228,7 @@ 
     /**
      *    Convert a date from PHP to an MS Excel serialized date/time value.
      *
-     *    @param    mixed            $dateValue            Unix Timestamp or PHP DateTime object or a string
+     *    @param    integer            $dateValue            Unix Timestamp or PHP DateTime object or a string
      *
      *    @return   float|bool    Excel date/time value
      *                                  or boolean FALSE on failure
@@ -268,7 +268,7 @@ 
     /**
      *    Convert a Unix timestamp to an MS Excel serialized date/time value.
      *
-     *    @param    \DateTimeInterface    $dateValue       Unix Timestamp
+     *    @param    integer    $dateValue       Unix Timestamp
      *
      *    @return   float                 MS Excel serialized date/time value
      */

src/PhpSpreadsheet/Shared/Drawing.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
      *
      * @param int $pValue Value in pixels
      *
-     * @return int Value in EMU
+     * @return double Value in EMU
      */
     public static function pixelsToEMU($pValue = 0)
     {

src/PhpSpreadsheet/Shared/Font.php

Doc Comments +1 added lines, -1 removed lines

@@ -238,7 +238,7 @@
      * Calculate an (approximate) OpenXML column width, based on font size and text contained.
      *
      * @param \PhpOffice\PhpSpreadsheet\Style\Font      $font        Font object
-     * @param \PhpOffice\PhpSpreadsheet\RichText|string $cellText    Text to calculate width
+     * @param string $cellText    Text to calculate width
      * @param int                                       $rotation    Rotation angle
      * @param \PhpOffice\PhpSpreadsheet\Style\Font|null $defaultFont Font object
      *

src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php

Doc Comments +1 added lines, -1 removed lines

@@ -228,7 +228,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
      *
      *    @throws \PhpOffice\PhpSpreadsheet\Calculation\Exception  IllegalArgumentException Matrix row dimensions must agree
      *    @throws \PhpOffice\PhpSpreadsheet\Calculation\Exception  RuntimeException  Matrix is singular

src/PhpSpreadsheet/Shared/JAMA/Matrix.php

Doc Comments +2 added lines, -47 removed lines

@@ -149,12 +149,6 @@ 
      *
      *    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()
     {
@@ -365,7 +359,7 @@ 
      *
      *    @param int $m Row dimension
      *    @param int $n Column dimension
-     *    @param mixed $c Diagonal value
+     *    @param integer $c Diagonal value
      *
      *    @return Matrix Diagonal matrix
      */
@@ -449,7 +443,7 @@ 
      *
      *    Sum of diagonal elements
      *
-     *    @return float Sum of diagonal elements
+     *    @return integer Sum of diagonal elements
      */
     public function trace()
     {
@@ -478,9 +472,6 @@ 
      *
      *    A + B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function plus()
     {
@@ -521,9 +512,6 @@ 
      *
      *    A = A + B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function plusEquals()
     {
@@ -578,9 +566,6 @@ 
      *
      *    A - B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function minus()
     {
@@ -621,9 +606,6 @@ 
      *
      *    A = A - B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function minusEquals()
     {
@@ -679,9 +661,6 @@ 
      *    Element-by-element multiplication
      *    Cij = Aij * Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Cij
      */
     public function arrayTimes()
     {
@@ -723,9 +702,6 @@ 
      *    Element-by-element multiplication
      *    Aij = Aij * Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayTimesEquals()
     {
@@ -781,9 +757,6 @@ 
      *    Element-by-element right division
      *    A / B
      *
-     *    @param Matrix $B Matrix B
-     *
-     *    @return Matrix Division result
      */
     public function arrayRightDivide()
     {
@@ -844,9 +817,6 @@ 
      *    Element-by-element right division
      *    Aij = Aij / Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayRightDivideEquals()
     {
@@ -888,9 +858,6 @@ 
      *    Element-by-element Left division
      *    A / B
      *
-     *    @param Matrix $B Matrix B
-     *
-     *    @return Matrix Division result
      */
     public function arrayLeftDivide()
     {
@@ -932,9 +899,6 @@ 
      *    Element-by-element Left division
      *    Aij = Aij / Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayLeftDivideEquals()
     {
@@ -975,9 +939,6 @@ 
      *
      *    Matrix multiplication
      *
-     *    @param mixed $n Matrix/Array/Scalar
-     *
-     *    @return Matrix Product
      */
     public function times()
     {
@@ -1078,9 +1039,6 @@ 
      *
      *    A = A ^ B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function power()
     {
@@ -1135,9 +1093,6 @@ 
      *
      *    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 \PhpOffice\PhpSpreadsheet\Writer\WriteException
      *
@@ -120,7 +120,7 @@ 
      *
      * @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/ZipArchive.php

Doc Comments +1 added lines, -1 removed lines

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