PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Shared/OLE.php

Doc Comments +6 added lines, -2 removed lines

@@ -94,7 +94,7 @@ 
      *
      * @acces public
      * @param string $file
-     * @return mixed true on success, PEAR_Error on failure
+     * @return boolean true on success, PEAR_Error on failure
      * @throws \PHPExcel\Reader\Exception
     */
     public function read($file)
@@ -225,6 +225,7 @@ 
     /**
      * Reads a signed char.
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      * @access public
      */
@@ -237,6 +238,7 @@ 
     /**
      * Reads an unsigned short (2 octets).
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      * @access public
      */
@@ -249,6 +251,7 @@ 
     /**
      * Reads an unsigned long (4 octets).
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      * @access public
      */
@@ -264,7 +267,8 @@ 
     *
     * @access public
     * @param  integer  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

@@ -42,6 +42,7 @@ 
     /**
      * @param integer $time_1st A timestamp
      * @param integer $time_2nd A timestamp
+     * @param File[] $raChild
      */
     public function __construct($time_1st, $time_2nd, $raChild)
     {
@@ -57,9 +58,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.
     * @access public
-    * @return mixed true on success
+    * @return boolean true on success
     * @throws \PHPExcel\Writer\Exception
     */
     public function save($filename)
@@ -121,7 +122,7 @@ 
     *
     * @access public
     * @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)
     {
@@ -160,7 +161,7 @@ 
     * @access public
     * @param integer $i2 The argument
     * @see save()
-    * @return integer
+    * @return double
     */
     private static function adjust2($i2)
     {

src/PhpSpreadsheet/Shared/OLERead.php

Doc Comments +2 added lines, -1 removed lines

@@ -74,7 +74,7 @@ 
     /**
      * Read the file
      *
-     * @param $sFileName string Filename
+     * @param string $sFileName string Filename
      * @throws \PHPExcel\Reader\Exception
      */
     public function read($sFileName)
@@ -172,6 +172,7 @@ 
     /**
      * Extract binary stream data
      *
+     * @param integer $stream
      * @return string
      */
     public function getStream($stream)

src/PhpSpreadsheet/Shared/PCLZip/PclZip.php

Doc Comments +12 added lines

@@ -215,6 +215,10 @@ 
     //     Note that no real action is taken, if the archive does not exist it is not
     //     created. Use create() for that.
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_zipname
+     */
     public function __construct($p_zipname)
     {
 
@@ -2193,6 +2197,10 @@ 
     // Description :
     // Parameters :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_mode
+     */
     public function privOpenFd($p_mode)
     {
         $v_result=1;
@@ -3772,6 +3780,10 @@ 
     // Parameters :
     // Return Values :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_string
+     */
     public function privExtractFileAsString(&$p_entry, &$p_string, &$p_options)
     {
         $v_result=1;

src/PhpSpreadsheet/Shared/TimeZone.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
     /**
      *    Return the Timezone transition for the specified timezone and timestamp
      *
-     *    @param        DateTimeZone         $objTimezone    The timezone for finding the transitions
+     *    @param        \DateTimeZone         $objTimezone    The timezone for finding the transitions
      *    @param        integer                 $timestamp        PHP date/time value for finding the current transition
      *    @return         array                The current transition details
      */

src/PhpSpreadsheet/Shared/Trend/BestFit.php

Doc Comments +11 added lines, -3 removed lines

@@ -122,7 +122,7 @@ 
      * Return the Y-Value for a specified value of X
      *
      * @param     float        $xValue            X-Value
-     * @return     float                        Y-Value
+     * @return     boolean                        Y-Value
      */
     public function getValueOfYForX($xValue)
     {
@@ -133,7 +133,7 @@ 
      * Return the X-Value for a specified value of Y
      *
      * @param     float        $yValue            Y-Value
-     * @return     float                        X-Value
+     * @return     boolean                        X-Value
      */
     public function getValueOfXForY($yValue)
     {
@@ -154,7 +154,7 @@ 
      * Return the Equation of the best-fit line
      *
      * @param     int        $dp        Number of places of decimal precision to display
-     * @return     string
+     * @return     boolean
      */
     public function getEquation($dp = 0)
     {
@@ -306,6 +306,9 @@ 
         return $this->yBestFitValues;
     }
 
+    /**
+     * @param double $sumY2
+     */
     protected function calculateGoodnessOfFit($sumX, $sumY, $sumX2, $sumY2, $sumXY, $meanX, $meanY, $const)
     {
         $SSres = $SScov = $SScor = $SStot = $SSsex = 0.0;
@@ -360,6 +363,11 @@ 
         }
     }
 
+    /**
+     * @param double[] $yValues
+     * @param double[] $xValues
+     * @param boolean $const
+     */
     protected function leastSquareFit($yValues, $xValues, $const)
     {
         // calculate sums

src/PhpSpreadsheet/Shared/Trend/ExponentialBestFit.php

Doc Comments +2 added lines, -2 removed lines

@@ -77,7 +77,7 @@ 
      * Return the Slope of the line
      *
      * @param     int        $dp        Number of places of decimal precision to display
-     * @return     string
+     * @return     double
      **/
     public function getSlope($dp = 0)
     {
@@ -91,7 +91,7 @@ 
      * Return the Value of X where it intersects Y = 0
      *
      * @param     int        $dp        Number of places of decimal precision to display
-     * @return     string
+     * @return     double
      **/
     public function getIntersect($dp = 0)
     {

src/PhpSpreadsheet/Shared/Trend/PowerBestFit.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
      * Return the Value of X where it intersects Y = 0
      *
      * @param     int        $dp        Number of places of decimal precision to display
-     * @return     string
+     * @return     double
      **/
     public function getIntersect($dp = 0)
     {

src/PhpSpreadsheet/Shared/XMLWriter.php

Doc Comments +1 added lines, -1 removed lines

@@ -109,7 +109,7 @@
      * Fallback method for writeRaw, introduced in PHP 5.2
      *
      * @param string $text
-     * @return string
+     * @return boolean
      */
     public function writeRawData($text)
     {