Fix a few phpdoc blocks

This commit is contained in:
Adrien Crivelli 2017-12-27 22:20:47 +09:00
parent 27d83b4404
commit ac1c7a2c7d
No known key found for this signature in database
GPG Key ID: B182FD79DC6DE92E
10 changed files with 92 additions and 109 deletions

View File

@ -2,28 +2,28 @@
namespace PhpOffice\PhpSpreadsheet\Calculation; namespace PhpOffice\PhpSpreadsheet\Calculation;
/* /**
PARTLY BASED ON: * PARTLY BASED ON:
Copyright (c) 2007 E. W. Bachtal, Inc. * Copyright (c) 2007 E. W. Bachtal, Inc.
*
Permission is hereby granted, free of charge, to any person obtaining a copy of this software * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without restriction, * and associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions: * subject to the following conditions:
*
The above copyright notice and this permission notice shall be included in all copies or substantial * The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software. * portions of the Software.
*
The software is provided "as is", without warranty of any kind, express or implied, including but not * The software is provided "as is", without warranty of any kind, express or implied, including but not
limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In * limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In
no event shall the authors or copyright holders be liable for any claim, damages or other liability, * no event shall the authors or copyright holders be liable for any claim, damages or other liability,
whether in an action of contract, tort or otherwise, arising from, out of or in connection with the * whether in an action of contract, tort or otherwise, arising from, out of or in connection with the
software or the use or other dealings in the software. * software or the use or other dealings in the software.
*
http://ewbi.blogs.com/develops/2007/03/excel_formula_p.html * http://ewbi.blogs.com/develops/2007/03/excel_formula_p.html
http://ewbi.blogs.com/develops/2004/12/excel_formula_p.html * http://ewbi.blogs.com/develops/2004/12/excel_formula_p.html
*/ */
class FormulaParser class FormulaParser
{ {
// Character constants // Character constants

View File

@ -2,29 +2,28 @@
namespace PhpOffice\PhpSpreadsheet\Calculation; namespace PhpOffice\PhpSpreadsheet\Calculation;
/* /**
PARTLY BASED ON: * PARTLY BASED ON:
Copyright (c) 2007 E. W. Bachtal, Inc. * Copyright (c) 2007 E. W. Bachtal, Inc.
*
Permission is hereby granted, free of charge, to any person obtaining a copy of this software * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without restriction, * and associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions: * subject to the following conditions:
*
The above copyright notice and this permission notice shall be included in all copies or substantial * The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software. * portions of the Software.
*
The software is provided "as is", without warranty of any kind, express or implied, including but not * The software is provided "as is", without warranty of any kind, express or implied, including but not
limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In * limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In
no event shall the authors or copyright holders be liable for any claim, damages or other liability, * no event shall the authors or copyright holders be liable for any claim, damages or other liability,
whether in an action of contract, tort or otherwise, arising from, out of or in connection with the * whether in an action of contract, tort or otherwise, arising from, out of or in connection with the
software or the use or other dealings in the software. * software or the use or other dealings in the software.
*
http://ewbi.blogs.com/develops/2007/03/excel_formula_p.html * http://ewbi.blogs.com/develops/2007/03/excel_formula_p.html
http://ewbi.blogs.com/develops/2004/12/excel_formula_p.html * http://ewbi.blogs.com/develops/2004/12/excel_formula_p.html
*/ */
class FormulaToken class FormulaToken
{ {
// Token types // Token types

View File

@ -15,11 +15,10 @@ class Date
const CALENDAR_WINDOWS_1900 = 1900; // Base date of 1st Jan 1900 = 1.0 const CALENDAR_WINDOWS_1900 = 1900; // Base date of 1st Jan 1900 = 1.0
const CALENDAR_MAC_1904 = 1904; // Base date of 2nd Jan 1904 = 1.0 const CALENDAR_MAC_1904 = 1904; // Base date of 2nd Jan 1904 = 1.0
/* /**
* Names of the months of the year, indexed by shortname * Names of the months of the year, indexed by shortname
* Planned usage for locale settings * Planned usage for locale settings.
* *
* @public
* @var string[] * @var string[]
*/ */
public static $monthNames = [ public static $monthNames = [
@ -37,8 +36,7 @@ class Date
'Dec' => 'December', 'Dec' => 'December',
]; ];
/* /**
* @public
* @var string[] * @var string[]
*/ */
public static $numberSuffixes = [ public static $numberSuffixes = [
@ -48,19 +46,17 @@ class Date
'th', 'th',
]; ];
/* /**
* Base calendar year to use for calculations * Base calendar year to use for calculations
* Value is either CALENDAR_WINDOWS_1900 (1900) or CALENDAR_MAC_1904 (1904) * Value is either CALENDAR_WINDOWS_1900 (1900) or CALENDAR_MAC_1904 (1904).
* *
* @private
* @var int * @var int
*/ */
protected static $excelCalendar = self::CALENDAR_WINDOWS_1900; protected static $excelCalendar = self::CALENDAR_WINDOWS_1900;
/* /**
* Default timezone to use for DateTime objects * Default timezone to use for DateTime objects.
* *
* @private
* @var null|\DateTimeZone * @var null|\DateTimeZone
*/ */
protected static $defaultTimeZone; protected static $defaultTimeZone;

View File

@ -7,13 +7,11 @@ use ZipArchive;
class File class File
{ {
/* /**
* Use Temp or File Upload Temp for temporary files * Use Temp or File Upload Temp for temporary files.
* *
* @protected * @var bool
* @var boolean
*/ */
protected static $useUploadTempDirectory = false; protected static $useUploadTempDirectory = false;
/** /**

View File

@ -2,20 +2,22 @@
namespace PhpOffice\PhpSpreadsheet\Shared\JAMA; namespace PhpOffice\PhpSpreadsheet\Shared\JAMA;
/* use PhpOffice\PhpSpreadsheet\Calculation\Exception as CalculationException;
* Matrix class use PhpOffice\PhpSpreadsheet\Calculation\Functions;
use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
/**
* Matrix class.
* *
* @author Paul Meagher * @author Paul Meagher
* @author Michael Bommarito * @author Michael Bommarito
* @author Lukasz Karapuda * @author Lukasz Karapuda
* @author Bartek Matosiuk * @author Bartek Matosiuk
*
* @version 1.8 * @version 1.8
*
* @see http://math.nist.gov/javanumerics/jama/ * @see http://math.nist.gov/javanumerics/jama/
*/ */
use PhpOffice\PhpSpreadsheet\Calculation\Exception as CalculationException;
use PhpOffice\PhpSpreadsheet\Calculation\Functions;
use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
class Matrix class Matrix
{ {
const POLYMORPHIC_ARGUMENT_EXCEPTION = 'Invalid argument pattern for polymorphic function.'; const POLYMORPHIC_ARGUMENT_EXCEPTION = 'Invalid argument pattern for polymorphic function.';

View File

@ -191,15 +191,7 @@ class QRDecomposition
} }
} }
} }
/*
for($i = 0; $i < count($Q); ++$i) {
for($j = 0; $j < count($Q); ++$j) {
if (! isset($Q[$i][$j]) ) {
$Q[$i][$j] = 0;
}
}
}
*/
return new Matrix($Q); return new Matrix($Q);
} }

View File

@ -21,14 +21,15 @@ namespace PhpOffice\PhpSpreadsheet\Shared;
// +----------------------------------------------------------------------+ // +----------------------------------------------------------------------+
// //
/*
* Array for storing OLE instances that are accessed from
* OLE_ChainedBlockStream::stream_open().
* @var array
*/
use PhpOffice\PhpSpreadsheet\Reader\Exception as ReaderException; use PhpOffice\PhpSpreadsheet\Reader\Exception as ReaderException;
use PhpOffice\PhpSpreadsheet\Shared\OLE\ChainedBlockStream; use PhpOffice\PhpSpreadsheet\Shared\OLE\ChainedBlockStream;
/*
* Array for storing OLE instances that are accessed from
* OLE_ChainedBlockStream::stream_open().
*
* @var array
*/
$GLOBALS['_OLE_INSTANCES'] = []; $GLOBALS['_OLE_INSTANCES'] = [];
/** /**

View File

@ -7,10 +7,9 @@ use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
class TimeZone class TimeZone
{ {
/* /**
* Default Timezone used for date/time conversions * Default Timezone used for date/time conversions.
* *
* @private
* @var string * @var string
*/ */
protected static $timezone = 'UTC'; protected static $timezone = 'UTC';

View File

@ -17,8 +17,6 @@ class PolynomialBestFit extends BestFit
/** /**
* Polynomial order. * Polynomial order.
* *
* @protected
*
* @var int * @var int
**/ **/
protected $order = 0; protected $order = 0;

View File

@ -187,8 +187,6 @@ class Color extends Supervisor
/** /**
* Get a specified colour component of an RGB value. * Get a specified colour component of an RGB value.
* *
* @private
*
* @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE
* @param int $offset Position within the RGB value to extract * @param int $offset Position within the RGB value to extract
* @param bool $hex Flag indicating whether the component should be returned as a hex or a * @param bool $hex Flag indicating whether the component should be returned as a hex or a