Docblock fixes
This commit is contained in:
Mark Baker
parent
73d2757728
commit
c2bbafb4d9
|
|
@ -495,7 +495,7 @@ class PHPExcel_Calculation_MathTrig {
|
|||
*
|
||||
* @access public
|
||||
* @category Mathematical and Trigonometric Functions
|
||||
* @param float $value The positive real number for which you want the logarithm
|
||||
* @param float $number The positive real number for which you want the logarithm
|
||||
* @param float $base The base of the logarithm. If base is omitted, it is assumed to be 10.
|
||||
* @return float
|
||||
*/
|
||||
|
|
@ -1252,7 +1252,8 @@ class PHPExcel_Calculation_MathTrig {
|
|||
/**
|
||||
* SUMX2MY2
|
||||
*
|
||||
* @param mixed $value Value to check
|
||||
* @param mixed[] $matrixData1 Matrix #1
|
||||
* @param mixed[] $matrixData2 Matrix #2
|
||||
* @return float
|
||||
*/
|
||||
public static function SUMX2MY2($matrixData1,$matrixData2) {
|
||||
|
|
@ -1281,7 +1282,8 @@ class PHPExcel_Calculation_MathTrig {
|
|||
/**
|
||||
* SUMX2PY2
|
||||
*
|
||||
* @param mixed $value Value to check
|
||||
* @param mixed[] $matrixData1 Matrix #1
|
||||
* @param mixed[] $matrixData2 Matrix #2
|
||||
* @return float
|
||||
*/
|
||||
public static function SUMX2PY2($matrixData1,$matrixData2) {
|
||||
|
|
@ -1310,7 +1312,8 @@ class PHPExcel_Calculation_MathTrig {
|
|||
/**
|
||||
* SUMXMY2
|
||||
*
|
||||
* @param mixed $value Value to check
|
||||
* @param mixed[] $matrixData1 Matrix #1
|
||||
* @param mixed[] $matrixData2 Matrix #2
|
||||
* @return float
|
||||
*/
|
||||
public static function SUMXMY2($matrixData1,$matrixData2) {
|
||||
|
|
|
|||
|
|
@ -834,6 +834,7 @@ class PHPExcel_Calculation_Statistical {
|
|||
* @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
|
||||
*/
|
||||
public static function AVERAGEIF($aArgs,$condition,$averageArgs = array()) {
|
||||
|
|
@ -912,6 +913,8 @@ class PHPExcel_Calculation_Statistical {
|
|||
* @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
|
||||
* @return float
|
||||
*
|
||||
|
|
@ -1954,9 +1957,9 @@ class PHPExcel_Calculation_Statistical {
|
|||
* @param boolean A logical value specifying whether to return additional regression statistics.
|
||||
* @return array
|
||||
*/
|
||||
public static function LINEST($yValues,$xValues=null,$const=True,$stats=False) {
|
||||
$const = (is_null($const)) ? True : (boolean) PHPExcel_Calculation_Functions::flattenSingleValue($const);
|
||||
$stats = (is_null($stats)) ? False : (boolean) PHPExcel_Calculation_Functions::flattenSingleValue($stats);
|
||||
public static function LINEST($yValues, $xValues = NULL, $const = TRUE, $stats = FALSE) {
|
||||
$const = (is_null($const)) ? TRUE : (boolean) PHPExcel_Calculation_Functions::flattenSingleValue($const);
|
||||
$stats = (is_null($stats)) ? FALSE : (boolean) PHPExcel_Calculation_Functions::flattenSingleValue($stats);
|
||||
if (is_null($xValues)) $xValues = range(1,count(PHPExcel_Calculation_Functions::flattenArray($yValues)));
|
||||
|
||||
if (!self::_checkTrendArrays($yValues,$xValues)) {
|
||||
|
|
@ -2059,7 +2062,9 @@ class PHPExcel_Calculation_Statistical {
|
|||
*
|
||||
* Returns the inverse of the normal cumulative distribution
|
||||
*
|
||||
* @param float $value
|
||||
* @param float $probability
|
||||
* @param float $mean
|
||||
* @param float $stdDev
|
||||
* @return float
|
||||
*
|
||||
* @todo Try implementing P J Acklam's refinement algorithm for greater
|
||||
|
|
@ -2088,6 +2093,8 @@ class PHPExcel_Calculation_Statistical {
|
|||
* with parameters mean and standard_dev.
|
||||
*
|
||||
* @param float $value
|
||||
* @param float $mean
|
||||
* @param float $stdDev
|
||||
* @return float
|
||||
*/
|
||||
public static function LOGNORMDIST($value, $mean, $stdDev) {
|
||||
|
|
@ -3621,14 +3628,14 @@ class PHPExcel_Calculation_Statistical {
|
|||
* Returns the Weibull distribution. Use this distribution in reliability
|
||||
* analysis, such as calculating a device's mean time to failure.
|
||||
*
|
||||
* @param float $value
|
||||
* @param float $alpha Alpha Parameter
|
||||
* @param float $beta Beta Parameter
|
||||
* @param float $dataSet
|
||||
* @param float $m0 Alpha Parameter
|
||||
* @param float $sigma Beta Parameter
|
||||
* @param boolean $cumulative
|
||||
* @return float
|
||||
*
|
||||
*/
|
||||
public static function ZTEST($dataSet, $m0, $sigma=null) {
|
||||
public static function ZTEST($dataSet, $m0, $sigma = NULL) {
|
||||
$dataSet = PHPExcel_Calculation_Functions::flattenArrayIndexed($dataSet);
|
||||
$m0 = PHPExcel_Calculation_Functions::flattenSingleValue($m0);
|
||||
$sigma = PHPExcel_Calculation_Functions::flattenSingleValue($sigma);
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ class PHPExcel_Calculation_TextData {
|
|||
/**
|
||||
* TRIMNONPRINTABLE
|
||||
*
|
||||
* @param mixed $value Value to check
|
||||
* @param mixed $stringValue Value to check
|
||||
* @return string
|
||||
*/
|
||||
public static function TRIMNONPRINTABLE($stringValue = '') {
|
||||
|
|
@ -113,7 +113,7 @@ class PHPExcel_Calculation_TextData {
|
|||
/**
|
||||
* TRIMSPACES
|
||||
*
|
||||
* @param mixed $value Value to check
|
||||
* @param mixed $stringValue Value to check
|
||||
* @return string
|
||||
*/
|
||||
public static function TRIMSPACES($stringValue = '') {
|
||||
|
|
@ -133,7 +133,7 @@ class PHPExcel_Calculation_TextData {
|
|||
/**
|
||||
* ASCIICODE
|
||||
*
|
||||
* @param string $character Value
|
||||
* @param string $characters Value
|
||||
* @return int
|
||||
*/
|
||||
public static function ASCIICODE($characters) {
|
||||
|
|
@ -297,6 +297,8 @@ class PHPExcel_Calculation_TextData {
|
|||
* FIXEDFORMAT
|
||||
*
|
||||
* @param mixed $value Value to check
|
||||
* @param integer $decimals
|
||||
* @param boolean $no_commas
|
||||
* @return boolean
|
||||
*/
|
||||
public static function FIXEDFORMAT($value, $decimals = 2, $no_commas = FALSE) {
|
||||
|
|
@ -407,7 +409,6 @@ class PHPExcel_Calculation_TextData {
|
|||
* STRINGLENGTH
|
||||
*
|
||||
* @param string $value Value
|
||||
* @param int $chars Number of characters
|
||||
* @return string
|
||||
*/
|
||||
public static function STRINGLENGTH($value = '') {
|
||||
|
|
@ -485,9 +486,10 @@ class PHPExcel_Calculation_TextData {
|
|||
/**
|
||||
* REPLACE
|
||||
*
|
||||
* @param string $value Value
|
||||
* @param string $oldText String to modify
|
||||
* @param int $start Start character
|
||||
* @param int $chars Number of characters
|
||||
* @param string $newText String to replace in defined position
|
||||
* @return string
|
||||
*/
|
||||
public static function REPLACE($oldText = '', $start = 1, $chars = null, $newText) {
|
||||
|
|
@ -553,7 +555,7 @@ class PHPExcel_Calculation_TextData {
|
|||
/**
|
||||
* RETURNSTRING
|
||||
*
|
||||
* @param mixed $value Value to check
|
||||
* @param mixed $testValue Value to check
|
||||
* @return boolean
|
||||
*/
|
||||
public static function RETURNSTRING($testValue = '') {
|
||||
|
|
@ -570,6 +572,7 @@ class PHPExcel_Calculation_TextData {
|
|||
* TEXTFORMAT
|
||||
*
|
||||
* @param mixed $value Value to check
|
||||
* @param string $format Format mask to use
|
||||
* @return boolean
|
||||
*/
|
||||
public static function TEXTFORMAT($value,$format) {
|
||||
|
|
|
|||
Loading…
Reference in New Issue