PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +8 added lines, -13 removed lines

@@ -114,8 +114,8 @@ 
      * @author Jaco van Kooten
      *
      * @param mixed $x
-     * @param mixed $p
-     * @param mixed $q
+     * @param double $p
+     * @param double $q
      */
     private static function betaFraction($x, $p, $q)
     {
@@ -717,8 +717,8 @@ 
      * @param float $value Value at which you want to evaluate the distribution
      * @param float $alpha Parameter to the distribution
      * @param float $beta Parameter to the distribution
-     * @param mixed $rMin
-     * @param mixed $rMax
+     * @param integer $rMin
+     * @param integer $rMax
      *
      * @return float
      */
@@ -756,8 +756,8 @@ 
      * @param float $probability Probability at which you want to evaluate the distribution
      * @param float $alpha Parameter to the distribution
      * @param float $beta Parameter to the distribution
-     * @param float $rMin Minimum value
-     * @param float $rMax Maximum value
+     * @param integer $rMin Minimum value
+     * @param integer $rMax Maximum value
      *
      * @return float
      */
@@ -1823,7 +1823,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Position (ordered from the largest) in the array or range of data to return
      *
      * @return float
      */
@@ -2554,7 +2553,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $entry Percentile value in the range 0..1, inclusive.
      *
      * @return float
      */
@@ -2605,7 +2603,7 @@ 
      * @param number the number of significant digits for the returned percentage value
      * @param mixed $valueSet
      * @param mixed $value
-     * @param mixed $significance
+     * @param integer $significance
      *
      * @return float
      */
@@ -2726,7 +2724,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Quartile value in the range 1..3, inclusive.
      *
      * @return float
      */
@@ -2759,7 +2756,7 @@ 
      * @param mixed Order to sort the values in the value set
      * @param mixed $value
      * @param mixed $valueSet
-     * @param mixed $order
+     * @param integer $order
      *
      * @return float
      */
@@ -2901,7 +2898,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Position (ordered from the smallest) in the array or range of data to return
      *
      * @return float
      */
@@ -3365,7 +3361,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $discard Percentage to discard
      *
      * @return float
      */

src/PhpSpreadsheet/Reader/Xml.php

Doc Comments +9 added lines

@@ -236,6 +236,9 @@ 
         return $this->loadIntoExisting($pFilename, $spreadsheet);
     }
 
+    /**
+     * @param string $styleAttributeValue
+     */
     private static function identifyFixedStyleValue($styleList, &$styleAttributeValue)
     {
         $styleAttributeValue = strtolower($styleAttributeValue);
@@ -811,6 +814,9 @@ 
         return $spreadsheet;
     }
 
+    /**
+     * @param string $charset
+     */
     protected static function convertStringEncoding($string, $charset)
     {
         if ($charset != 'UTF-8') {
@@ -820,6 +826,9 @@ 
         return $string;
     }
 
+    /**
+     * @param string $is
+     */
     protected function parseRichText($is)
     {
         $value = new RichText();

src/PhpSpreadsheet/Shared/OLE.php

Doc Comments +1 added lines, -1 removed lines

@@ -536,7 +536,7 @@
      *
      * @param int $string A binary string with the encoded date
      *
-     * @return string The timestamp corresponding to the string
+     * @return double The timestamp corresponding to the string
      */
     public static function OLE2LocalDate($string)
     {

src/PhpSpreadsheet/Calculation/Calculation.php

Doc Comments +2 added lines, -2 removed lines

@@ -2664,7 +2664,7 @@ 
 
     /**
      * @param string $cellReference
-     * @param mixed $cellValue
+     * @param boolean $cellValue
      */
     public function saveValueToCache($cellReference, $cellValue)
     {
@@ -2789,7 +2789,7 @@ 
      *
      * @param mixed &$matrix matrix operand
      *
-     * @return int[] An array comprising the number of rows, and number of columns
+     * @return integer[] An array comprising the number of rows, and number of columns
      */
     private static function getMatrixDimensions(&$matrix)
     {

src/PhpSpreadsheet/Chart/Renderer/JpGraph.php

Doc Comments +63 added lines

@@ -76,6 +76,9 @@ 
         $loaded = true;
     }
 
+    /**
+     * @param string $markerID
+     */
     private function formatPointMarker($seriesPlot, $markerID)
     {
         $plotMarkKeys = array_keys(self::$markSet);
@@ -103,6 +106,9 @@ 
         return $seriesPlot;
     }
 
+    /**
+     * @param integer $labelCount
+     */
     private function formatDataSetLabels($groupID, $datasetLabels, $labelCount, $rotation = '')
     {
         $datasetLabelFormatCode = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotCategoryByIndex(0)->getFormatCode();
@@ -132,6 +138,9 @@ 
         return $datasetLabels;
     }
 
+    /**
+     * @param integer $seriesCount
+     */
     private function percentageSumCalculation($groupID, $seriesCount)
     {
         //    Adjust our values to a percentage value across all series in the group
@@ -162,6 +171,9 @@ 
         return $dataValues;
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Chart\Title $captionElement
+     */
     private function getCaption($captionElement)
     {
         //    Read any caption
@@ -271,6 +283,9 @@ 
         $this->renderTitle();
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotLine($groupID, $filled = false, $combination = false, $dimensions = '2d')
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -334,6 +349,9 @@ 
         $this->graph->Add($groupPlot);
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotBar($groupID, $dimensions = '2d')
     {
         $rotation = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotDirection();
@@ -418,6 +436,10 @@ 
         $this->graph->Add($groupPlot);
     }
 
+    /**
+     * @param integer $groupID
+     * @param boolean $bubble
+     */
     private function renderPlotScatter($groupID, $bubble)
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -463,6 +485,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotRadar($groupID)
     {
         $radarStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -501,6 +526,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotContour($groupID)
     {
         $contourStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -521,6 +549,9 @@ 
         $this->graph->Add($seriesPlot);
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotStock($groupID)
     {
         $seriesCount = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotSeriesCount();
@@ -560,6 +591,9 @@ 
         $this->graph->Add($seriesPlot);
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderAreaChart($groupCount, $dimensions = '2d')
     {
         $this->renderCartesianPlotArea();
@@ -569,6 +603,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderLineChart($groupCount, $dimensions = '2d')
     {
         $this->renderCartesianPlotArea();
@@ -578,6 +615,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBarChart($groupCount, $dimensions = '2d')
     {
         $this->renderCartesianPlotArea();
@@ -587,6 +627,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderScatterChart($groupCount)
     {
         $this->renderCartesianPlotArea('linlin');
@@ -596,6 +639,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBubbleChart($groupCount)
     {
         $this->renderCartesianPlotArea('linlin');
@@ -605,6 +651,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false)
     {
         $this->renderPiePlotArea();
@@ -676,6 +725,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderRadarChart($groupCount)
     {
         $this->renderRadarPlotArea();
@@ -685,6 +737,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderStockChart($groupCount)
     {
         $this->renderCartesianPlotArea('intint');
@@ -694,6 +749,10 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     * @param string|null $dimensions
+     */
     private function renderContourChart($groupCount, $dimensions)
     {
         $this->renderCartesianPlotArea('intint');
@@ -703,6 +762,10 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     * @param string $outputDestination
+     */
     private function renderCombinationChart($groupCount, $dimensions, $outputDestination)
     {
         $this->renderCartesianPlotArea();

src/PhpSpreadsheet/Style/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/Chart/Axis.php

Doc Comments +1 added lines

@@ -463,6 +463,7 @@
      * Get Shadow Property.
      *
      * @param mixed $elements
+     * @return string
      */
     public function getShadowProperty($elements)
     {

src/PhpSpreadsheet/Worksheet/Worksheet.php

Doc Comments +4 added lines, -4 removed lines

@@ -576,7 +576,7 @@ 
      *
      * @throws Exception
      *
-     * @return Chart|false
+     * @return Chart
      */
     public function getChartByIndex($index)
     {
@@ -1087,7 +1087,7 @@ 
      * @param string $column Return the highest data row for the specified column,
      *                                     or the highest data row of any column if no column letter is passed
      *
-     * @return string Highest row number that contains data
+     * @return integer Highest row number that contains data
      */
     public function getHighestDataRow($column = null)
     {
@@ -1139,7 +1139,7 @@ 
      * Set a cell value.
      *
      * @param string $pCoordinate Coordinate of the cell, eg: 'A1'
-     * @param mixed $pValue Value of the cell
+     * @param string $pValue Value of the cell
      * @param string $pDataType Explicit data type, see DataType::TYPE_*
      *
      * @return Worksheet
@@ -1910,7 +1910,7 @@ 
     /**
      * Set AutoFilter.
      *
-     * @param AutoFilter|string $pValue
+     * @param string $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *
      * @throws Exception

src/PhpSpreadsheet/Writer/Xls/Worksheet.php

Doc Comments +6 added lines, -6 removed lines

@@ -622,7 +622,7 @@ 
      * @param int $row Zero indexed row
      * @param int $col Zero indexed column
      * @param float $num The number to write
-     * @param mixed $xfIndex The optional XF format
+     * @param integer $xfIndex The optional XF format
      *
      * @return int
      */
@@ -694,7 +694,7 @@ 
      * @param int $row Zero indexed row
      * @param int $col Zero indexed column
      * @param string $str The string to write
-     * @param mixed $xfIndex The XF format index for the cell
+     * @param integer $xfIndex The XF format index for the cell
      *
      * @return int
      */
@@ -730,7 +730,7 @@ 
      *
      * @param int $row Zero indexed row
      * @param int $col Zero indexed column
-     * @param mixed $xfIndex The XF format index
+     * @param integer $xfIndex The XF format index
      */
     public function writeBlank($row, $col, $xfIndex)
     {
@@ -777,7 +777,7 @@ 
      * @param int $row Zero indexed row
      * @param int $col Zero indexed column
      * @param string $formula The formula text string
-     * @param mixed $xfIndex The XF format index
+     * @param integer $xfIndex The XF format index
      * @param mixed $calculatedValue Calculated value
      *
      * @return int
@@ -2205,8 +2205,8 @@ 
      * @param mixed $bitmap The bitmap filename or GD-image resource
      * @param int $x the horizontal position (offset) of the image inside the cell
      * @param int $y the vertical position (offset) of the image inside the cell
-     * @param float $scale_x The horizontal scale
-     * @param float $scale_y The vertical scale
+     * @param integer $scale_x The horizontal scale
+     * @param integer $scale_y The vertical scale
      */
     public function insertBitmap($row, $col, $bitmap, $x = 0, $y = 0, $scale_x = 1, $scale_y = 1)
     {