PHPOffice / PhpSpreadsheet

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

docs/Examples/Reading WorkBook Data/exampleWorkBookReader04.php

Spacing +2 added lines, -2 removed lines

@@ -34,13 +34,13 @@
 echo 'Reading the number of Worksheets in the WorkBook<br />';
 /*  Use the PhpSpreadsheet object's getSheetCount() method to get a count of the number of WorkSheets in the WorkBook  */
 $sheetCount = $spreadsheet->getSheetCount();
-echo 'There ',(($sheetCount == 1) ? 'is' : 'are'),' ',$sheetCount,' WorkSheet',(($sheetCount == 1) ? '' : 's'),' in the WorkBook<br /><br />';
+echo 'There ', (($sheetCount == 1) ? 'is' : 'are'), ' ', $sheetCount, ' WorkSheet', (($sheetCount == 1) ? '' : 's'), ' in the WorkBook<br /><br />';
 
 echo 'Reading the names of Worksheets in the WorkBook<br />';
 /*  Use the PhpSpreadsheet object's getSheetNames() method to get an array listing the names/titles of the WorkSheets in the WorkBook  */
 $sheetNames = $spreadsheet->getSheetNames();
 foreach ($sheetNames as $sheetIndex => $sheetName) {
-    echo 'WorkSheet #',$sheetIndex,' is named "',$sheetName,'"<br />';
+    echo 'WorkSheet #', $sheetIndex, ' is named "', $sheetName, '"<br />';
 }
 
 ?>

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

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
      * Resolve a named range to a regular cell range.
      *
      * @param string $pNamedRange Named range
-     * @param Worksheet|null $pSheet Scope. Use null for global scope
+     * @param Worksheet $pSheet Scope. Use null for global scope
      *
      * @return NamedRange
      */

src/PhpSpreadsheet/Reader/Gnumeric.php

Doc Comments +3 added lines

@@ -804,6 +804,9 @@
         return $styleArray;
     }
 
+    /**
+     * @param string $is
+     */
     private function parseRichText($is)
     {
         $value = new \PhpOffice\PhpSpreadsheet\RichText();

src/PhpSpreadsheet/Reader/Slk.php

Doc Comments +1 added lines, -1 removed lines

@@ -472,7 +472,7 @@
      *
      * @param int $pValue Sheet index
      *
-     * @return SYLK
+     * @return Slk
      */
     public function setSheetIndex($pValue)
     {

src/PhpSpreadsheet/Reader/Xml.php

Doc Comments +9 added lines

@@ -230,6 +230,9 @@ 
         return $this->loadIntoExisting($pFilename, $spreadsheet);
     }
 
+    /**
+     * @param string $styleAttributeValue
+     */
     protected static function identifyFixedStyleValue($styleList, &$styleAttributeValue)
     {
         $styleAttributeValue = strtolower($styleAttributeValue);
@@ -761,6 +764,9 @@ 
         return $spreadsheet;
     }
 
+    /**
+     * @param string $charset
+     */
     protected static function convertStringEncoding($string, $charset)
     {
         if ($charset != 'UTF-8') {
@@ -770,6 +776,9 @@ 
         return $string;
     }
 
+    /**
+     * @param string $is
+     */
     protected function parseRichText($is)
     {
         $value = new \PhpOffice\PhpSpreadsheet\RichText();

src/PhpSpreadsheet/Shared/Drawing.php

Doc Comments +1 added lines, -1 removed lines

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

src/PhpSpreadsheet/Shared/JAMA/CholeskyDecomposition.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
      *    Class constructor - decomposes symmetric positive definite matrix
      *
      * @param mixed Matrix square symmetric positive definite matrix
-     * @param null|mixed $A
+     * @param Matrix $A
      */
     public function __construct(Matrix $A)
     {