PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Chart/DataSeries.php

Doc Comments +3 added lines, -3 removed lines

@@ -177,7 +177,7 @@ 
     /**
      * Get Plot Grouping Type
      *
-     * @return string
+     * @return boolean
      */
     public function getPlotGrouping()
     {
@@ -200,7 +200,7 @@ 
     /**
      * Get Plot Direction
      *
-     * @return string
+     * @return boolean
      */
     public function getPlotDirection()
     {
@@ -347,7 +347,7 @@ 
     /**
      * Get Smooth Line
      *
-     * @return bool
+     * @return string
      */
     public function getSmoothLine()
     {

src/PhpSpreadsheet/Chart/DataSeriesValues.php

Doc Comments +3 added lines, -2 removed lines

@@ -80,6 +80,7 @@ 
 
     /**
      * Create a new DataSeriesValues object
+     * @param string $dataSource
      */
     public function __construct($dataType = self::DATASERIES_TYPE_NUMBER, $dataSource = null, $formatCode = null, $pointCount = 0, $dataValues = [], $marker = null)
     {
@@ -209,7 +210,7 @@ 
     /**
      * Identify if the Data Series is a multi-level or a simple series
      *
-     * @return    bool
+     * @return    boolean|null
      */
     public function isMultiLevelSeries()
     {
@@ -223,7 +224,7 @@ 
     /**
      * Return the level count of a multi-level Data Series
      *
-     * @return    bool
+     * @return    integer
      */
     public function multiLevelCount()
     {

src/PhpSpreadsheet/Reader/CSV.php

Doc Comments +1 added lines, -1 removed lines

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

src/PhpSpreadsheet/Reader/Excel5.php

Doc Comments +16 added lines, -7 removed lines

@@ -1207,7 +1207,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
      */
@@ -1743,6 +1743,7 @@ 
      * @var int         Block for which to create decrypto
      * @var string $valContext MD5 context state
      *
+     * @param string $valContext
      * @return Excel5\RC4
      */
     private function makeKey($block, $valContext)
@@ -1778,6 +1779,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)
@@ -5157,7 +5163,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()
     {
@@ -5257,8 +5263,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)
@@ -5421,8 +5426,9 @@ 
      *
      * @param string Formula data
      * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
+     * @param string $formulaData
      * @throws Exception
-     * @return array
+     * @return string
      */
     private function getNextToken($formulaData, $baseCell = 'A1')
     {
@@ -6990,7 +6996,7 @@ 
      * section 2.5.15
      *
      * @param string $subData
-     * @return array
+     * @return string
      */
     private function readBIFF8CellRangeAddressList($subData)
     {
@@ -7372,6 +7378,9 @@ 
         return $value;
     }
 
+    /**
+     * @param integer $rknum
+     */
     private static function getIEEE754($rknum)
     {
         if (($rknum & 0x02) != 0) {
@@ -7402,7 +7411,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/Shared/OLE.php

Doc Comments +6 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
      * @acces public
      * @param string $file
      * @throws \PhpSpreadsheet\Reader\Exception
-     * @return mixed true on success, PEAR_Error on failure
+     * @return boolean true on success, PEAR_Error on failure
      */
     public function read($file)
     {
@@ -223,6 +223,7 @@ 
     /**
      * Reads a signed char.
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      */
     private static function _readInt1($fh)
@@ -235,6 +236,7 @@ 
     /**
      * Reads an unsigned short (2 octets).
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      */
     private static function _readInt2($fh)
@@ -247,6 +249,7 @@ 
     /**
      * Reads an unsigned long (4 octets).
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      */
     private static function _readInt4($fh)
@@ -261,7 +264,8 @@ 
      * creates an OLE_PPS object for each one.
      *
      * @param  int  the block id of the first block
-     * @return mixed true on success, PEAR_Error on failure
+     * @param integer $blockId
+     * @return boolean true on success, PEAR_Error on failure
      */
     public function _readPpsWks($blockId)
     {

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

Doc Comments +5 added lines, -4 removed lines

@@ -39,6 +39,7 @@ 
     /**
      * @param int $time_1st A timestamp
      * @param int $time_2nd A timestamp
+     * @param File[] $raChild
      */
     public function __construct($time_1st, $time_2nd, $raChild)
     {
@@ -54,9 +55,9 @@ 
      * 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 mixed true on success
+     * @return boolean true on success
      */
     public function save($filename)
     {
@@ -116,7 +117,7 @@ 
      * Calculate some numbers
      *
      * @param array $raList Reference to an array of PPS's
-     * @return array The array of numbers
+     * @return double[] The array of numbers
      */
     public function _calcSize(&$raList)
     {
@@ -154,7 +155,7 @@ 
      *
      * @param int $i2 The argument
      * @see save()
-     * @return int
+     * @return double
      */
     private static function adjust2($i2)
     {

src/PhpSpreadsheet/Shared/ZipStreamWrapper.php

Doc Comments +3 added lines, -3 removed lines

@@ -99,7 +99,7 @@ 
     /**
      * Implements support for fstat().
      *
-     * @return  bool
+     * @return  string
      */
     public function statName()
     {
@@ -109,7 +109,7 @@ 
     /**
      * Implements support for fstat().
      *
-     * @return  bool
+     * @return  string
      */
     public function url_stat() // @codingStandardsIgnoreLine
     {
@@ -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/Spreadsheet.php

Doc Comments +11 added lines, -10 removed lines

@@ -136,7 +136,7 @@ 
     /**
      * The workbook has macros ?
      *
-     * @return true if workbook has macros, false if not
+     * @return boolean if workbook has macros, false if not
      */
     public function hasMacros()
     {
@@ -177,7 +177,7 @@ 
     /**
      * Set the macros certificate
      *
-     * @param string|null $Certificate
+     * @param string|null $certificate
      */
     public function setMacrosCertificate($certificate = null)
     {
@@ -230,6 +230,7 @@ 
      * retrieve ribbon XML Data
      *
      * return string|null|array
+     * @return string
      */
     public function getRibbonXMLData($what = 'all') //we need some constants here...
     {
@@ -303,7 +304,7 @@ 
     /**
      * This workbook have a custom UI ?
      *
-     * @return true|false
+     * @return boolean
      */
     public function hasRibbon()
     {
@@ -313,7 +314,7 @@ 
     /**
      * This workbook have additionnal object for the ribbon ?
      *
-     * @return true|false
+     * @return boolean
      */
     public function hasRibbonBinObjects()
     {
@@ -609,7 +610,7 @@ 
      *
      * @param  Worksheet $pSheet
      * @throws Exception
-     * @return Sheet index
+     * @return integer index
      */
     public function getIndex(Worksheet $pSheet)
     {
@@ -628,7 +629,7 @@ 
      * @param  string $sheetName Sheet name to modify index for
      * @param  int $newIndex New index for the sheet
      * @throws Exception
-     * @return New sheet index
+     * @return integer sheet index
      */
     public function setIndexByName($sheetName, $newIndex)
     {
@@ -772,7 +773,7 @@ 
      * Add named range
      *
      * @param  NamedRange $namedRange
-     * @return PhpSpreadsheet
+     * @return boolean
      */
     public function addNamedRange(NamedRange $namedRange)
     {
@@ -818,7 +819,7 @@ 
      *
      * @param  string  $namedRange
      * @param  Worksheet|null  $pSheet  Scope: use null for global scope.
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function removeNamedRange($namedRange, Worksheet $pSheet = null)
     {
@@ -838,7 +839,7 @@ 
     /**
      * Get worksheet iterator
      *
-     * @return WorksheetIterator
+     * @return Worksheet\Iterator
      */
     public function getWorksheetIterator()
     {
@@ -848,7 +849,7 @@ 
     /**
      * Copy workbook (!= clone!)
      *
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function copy()
     {

src/PhpSpreadsheet/Worksheet/ColumnDimension.php

Doc Comments +2 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
     /**
      * Get ColumnIndex
      *
-     * @return string
+     * @return integer
      */
     public function getColumnIndex()
     {
@@ -101,7 +101,7 @@ 
     /**
      * Set Width
      *
-     * @param float $pValue
+     * @param integer $pValue
      * @return ColumnDimension
      */
     public function setWidth($pValue = -1)