PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +6 added lines, -44 removed lines

@@ -130,7 +130,7 @@ 
      *
      * @param p require p>0
      * @param q require q>0
-     * @return 0 if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
+     * @return double if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
      * @author Jaco van Kooten
      */
     private static function logBeta($p, $q)
@@ -152,6 +152,8 @@ 
      * Evaluates of continued fraction part of incomplete beta function.
      * Based on an idea from Numerical Recipes (W.H. Press et al, 1992).
      * @author Jaco van Kooten
+     * @param double $p
+     * @param double $q
      */
     private static function betaFraction($x, $p, $q)
     {
@@ -708,7 +710,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function AVEDEV()
@@ -757,7 +758,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function AVERAGE()
@@ -800,7 +800,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function AVERAGEA()
@@ -847,7 +846,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be checked.
      * @param    mixed[]        $averageArgs    Data values
      * @return    float
@@ -892,7 +890,6 @@ 
      * @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    boolean        $cumulative
      * @return    float
      *
      */
@@ -929,9 +926,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    boolean        $cumulative
+     * @param    integer        $rMin            Minimum value
+     * @param    integer        $rMax            Maximum value
      * @return    float
      *
      */
@@ -1180,7 +1176,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    int
      */
     public static function COUNT()
@@ -1214,7 +1209,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    int
      */
     public static function COUNTA()
@@ -1244,7 +1238,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    int
      */
     public static function COUNTBLANK()
@@ -1274,7 +1267,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be counted.
      * @return    int
      */
@@ -1462,7 +1454,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function DEVSQ()
@@ -1744,7 +1735,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function GEOMEAN()
@@ -1805,7 +1795,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function HARMEAN()
@@ -1961,8 +1950,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Position (ordered from the largest) in the array or range of data to return
      * @return    float
      *
      */
@@ -2187,7 +2174,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MAX()
@@ -2222,7 +2208,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MAXA()
@@ -2262,7 +2247,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be checked.
      * @return    float
      */
@@ -2302,7 +2286,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MEDIAN()
@@ -2346,7 +2329,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MIN()
@@ -2381,7 +2363,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MINA()
@@ -2421,7 +2402,6 @@ 
      *
      * @access    public
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be checked.
      * @return    float
      */
@@ -2499,7 +2479,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MODE()
@@ -2604,9 +2583,9 @@ 
      *
      * Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.
      *
-     * @param    float        $value
      * @param    float        $mean        Mean Value
      * @param    float        $stdDev        Standard Deviation
+     * @param double $probability
      * @return    float
      *
      */
@@ -2671,8 +2650,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    float        $entry            Percentile value in the range 0..1, inclusive.
      * @return    float
      */
     public static function PERCENTILE()
@@ -2836,8 +2813,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Quartile value in the range 1..3, inclusive.
      * @return    float
      */
     public static function QUARTILE()
@@ -2999,8 +2974,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Position (ordered from the smallest) in the array or range of data to return
      * @return    float
      */
     public static function SMALL()
@@ -3067,7 +3040,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function STDEV()
@@ -3115,7 +3087,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function STDEVA()
@@ -3166,7 +3137,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function STDEVP()
@@ -3212,7 +3182,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function STDEVPA()
@@ -3445,8 +3414,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    float        $discard        Percentage to discard
      * @return    float
      */
     public static function TRIMMEAN()
@@ -3489,7 +3456,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function VARFunc()
@@ -3532,7 +3498,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function VARA()
@@ -3584,7 +3549,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function VARP()
@@ -3628,7 +3592,6 @@ 
      *
      * @access    public
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function VARPA()
@@ -3714,7 +3677,6 @@ 
      * @param    float        $dataSet
      * @param    float        $m0        Alpha Parameter
      * @param    float        $sigma    Beta Parameter
-     * @param    boolean        $cumulative
      * @return    float
      *
      */

src/PhpSpreadsheet/Calculation/TextData.php

Doc Comments +6 added lines, -6 removed lines

@@ -56,7 +56,7 @@ 
      * CHARACTER
      *
      * @param    string    $character    Value
-     * @return    int
+     * @return    string
      */
     public static function CHARACTER($character)
     {
@@ -186,7 +186,7 @@ 
      * This function converts a number to text using currency format, with the decimals rounded to the specified place.
      * The format used is $#,##0.00_);($#,##0.00)..
      *
-     * @param    float    $value            The value to format
+     * @param    integer    $value            The value to format
      * @param    int        $decimals        The number of digits to display to the right of the decimal point.
      *                                    If decimals is negative, number is rounded to the left of the decimal point.
      *                                    If you omit decimals, it is assumed to be 2
@@ -299,7 +299,7 @@ 
      * @param    mixed        $value    Value to check
      * @param    integer        $decimals
      * @param    boolean        $no_commas
-     * @return    boolean
+     * @return    string
      */
     public static function FIXEDFORMAT($value, $decimals = 2, $no_commas = false)
     {
@@ -418,7 +418,7 @@ 
      * STRINGLENGTH
      *
      * @param    string    $value    Value
-     * @return    string
+     * @return    integer
      */
     public static function STRINGLENGTH($value = '')
     {
@@ -571,7 +571,7 @@ 
      * RETURNSTRING
      *
      * @param    mixed    $testValue    Value to check
-     * @return    boolean
+     * @return    string|null
      */
     public static function RETURNSTRING($testValue = '')
     {
@@ -589,7 +589,7 @@ 
      *
      * @param    mixed    $value    Value to check
      * @param    string    $format    Format mask to use
-     * @return    boolean
+     * @return    string
      */
     public static function TEXTFORMAT($value, $format)
     {

src/PhpSpreadsheet/Cell.php

Doc Comments +3 added lines, -3 removed lines

@@ -93,7 +93,7 @@ 
     /**
      *    Send notification to the cache controller
      *
-     *    @return void
+     *    @return Cell
      **/
     public function notifyCacheController()
     {
@@ -580,7 +580,7 @@ 
      *    Coordinate from string
      *
      *    @param    string    $pCoordinateString
-     *    @return    array    Array containing column and row (indexes 0 and 1)
+     *    @return    string[]    Array containing column and row (indexes 0 and 1)
      *    @throws    Exception
      */
     public static function coordinateFromString($pCoordinateString = 'A1')
@@ -760,7 +760,7 @@ 
      *    Calculate range boundaries
      *
      *    @param    string    $pRange        Cell range (e.g. A1:A1)
-     *    @return    array    Range coordinates array(Start Cell, End Cell)
+     *    @return    integer    Range coordinates array(Start Cell, End Cell)
      *                    where Start Cell and End Cell are arrays (Column ID, Row Number)
      */
     public static function getRangeBoundaries($pRange = 'A1:A1')

src/PhpSpreadsheet/Chart/Axis.php

Doc Comments +1 added lines, -5 removed lines

@@ -332,7 +332,7 @@ 
     /**
      * Set Shadow Properties
      *
-     * @param int $shadow_presets
+     * @param int $sh_presets
      * @param string $sh_color_value
      * @param string $sh_color_type
      * @param string $sh_color_alpha
@@ -467,10 +467,6 @@ 
     /**
      * Get Glow Property
      *
-     * @param float $size
-     * @param string $color_value
-     * @param int $color_alpha
-     * @param string $color_type
      */
     public function getShadowProperty($elements)
     {

src/PhpSpreadsheet/Chart/DataSeries.php

Doc Comments +3 added lines, -3 removed lines

@@ -180,7 +180,7 @@ 
     /**
      * Get Plot Grouping Type
      *
-     * @return string
+     * @return boolean
      */
     public function getPlotGrouping()
     {
@@ -202,7 +202,7 @@ 
     /**
      * Get Plot Direction
      *
-     * @return string
+     * @return boolean
      */
     public function getPlotDirection()
     {
@@ -344,7 +344,7 @@ 
     /**
      * Get Smooth Line
      *
-     * @return boolean
+     * @return string
      */
     public function getSmoothLine()
     {

src/PhpSpreadsheet/Chart/DataSeriesValues.php

Doc Comments +3 added lines, -2 removed lines

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

src/PhpSpreadsheet/Chart/Layout.php

Doc Comments +1 added lines

@@ -176,6 +176,7 @@
      * Set Layout Target
      *
      * @param Layout Target $value
+     * @param string $value
      * @return Layout
      */
     public function setLayoutTarget($value)

src/PhpSpreadsheet/Chart/Properties.php

Doc Comments +17 added lines

@@ -116,11 +116,17 @@ 
         SHADOW_PRESETS_PERSPECTIVE_LOWER_RIGHT = 22,
         SHADOW_PRESETS_PERSPECTIVE_LOWER_LEFT = 23;
 
+    /**
+     * @param double $width
+     */
     protected function getExcelPointsWidth($width)
     {
         return $width * 12700;
     }
 
+    /**
+     * @param integer $angle
+     */
     protected function getExcelPointsAngle($angle)
     {
         return $angle * 60000;
@@ -131,6 +137,11 @@ 
         return (string) 100 - $alpha . '000';
     }
 
+    /**
+     * @param string $color
+     * @param integer $alpha
+     * @param string $type
+     */
     protected function setColorProperties($color, $alpha, $type)
     {
         return array(
@@ -140,6 +151,9 @@ 
         );
     }
 
+    /**
+     * @param string $array_kay_selector
+     */
     protected function getLineStyleArrowSize($array_selector, $array_kay_selector)
     {
         $sizes = array(
@@ -157,6 +171,9 @@ 
         return $sizes[$array_selector][$array_kay_selector];
     }
 
+    /**
+     * @param integer $shadow_presets_option
+     */
     protected function getShadowPresetsMap($shadow_presets_option)
     {
         $presets_options = array(

src/PhpSpreadsheet/Chart/Renderer/JpGraph.php

Doc Comments +62 added lines

@@ -65,6 +65,9 @@ 
     private static $plotMark = 0;
 
 
+    /**
+     * @param string $markerID
+     */
     private function formatPointMarker($seriesPlot, $markerID)
     {
         $plotMarkKeys = array_keys(self::$markSet);
@@ -93,6 +96,9 @@ 
     }
 
 
+    /**
+     * @param integer $labelCount
+     */
     private function formatDataSetLabels($groupID, $datasetLabels, $labelCount, $rotation = '')
     {
         $datasetLabelFormatCode = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotCategoryByIndex(0)->getFormatCode();
@@ -123,6 +129,9 @@ 
     }
 
 
+    /**
+     * @param integer $seriesCount
+     */
     private function percentageSumCalculation($groupID, $seriesCount)
     {
         //    Adjust our values to a percentage value across all series in the group
@@ -155,6 +164,9 @@ 
     }
 
 
+    /**
+     * @param \PHPExcel\Chart\Title $captionElement
+     */
     private function getCaption($captionElement)
     {
         //    Read any caption
@@ -267,6 +279,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotLine($groupID, $filled = false, $combination = false, $dimensions = '2d')
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -331,6 +346,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotBar($groupID, $dimensions = '2d')
     {
         $rotation = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotDirection();
@@ -417,6 +435,10 @@ 
     }
 
 
+    /**
+     * @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();
@@ -502,6 +527,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotContour($groupID)
     {
         $contourStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -523,6 +551,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotStock($groupID)
     {
         $seriesCount = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotSeriesCount();
@@ -563,6 +594,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderAreaChart($groupCount, $dimensions = '2d')
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_line.php');
@@ -575,6 +609,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderLineChart($groupCount, $dimensions = '2d')
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_line.php');
@@ -587,6 +624,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBarChart($groupCount, $dimensions = '2d')
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_bar.php');
@@ -599,6 +639,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderScatterChart($groupCount)
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_scatter.php');
@@ -613,6 +656,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBubbleChart($groupCount)
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_scatter.php');
@@ -625,6 +671,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false)
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_pie.php');
@@ -702,6 +751,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderRadarChart($groupCount)
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_radar.php');
@@ -714,6 +766,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderStockChart($groupCount)
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_stock.php');
@@ -726,6 +781,10 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     * @param string|null $dimensions
+     */
     private function renderContourChart($groupCount, $dimensions)
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_contour.php');
@@ -738,6 +797,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderCombinationChart($groupCount, $dimensions, $outputDestination)
     {
         require_once(\PHPExcel\Settings::getChartRendererPath().'jpgraph_line.php');