From c66049244648456a53ffd1da091fb109292a5b37 Mon Sep 17 00:00:00 2001 From: Mark Baker Date: Sat, 27 Apr 2013 18:07:12 +0100 Subject: [PATCH] Docblocks --- Classes/PHPExcel/IOFactory.php | 6 +++--- Classes/PHPExcel/Reader/CSV.php | 10 +++++----- Classes/PHPExcel/Reader/Excel2003XML.php | 2 +- Classes/PHPExcel/Reader/Excel2007.php | 2 +- Classes/PHPExcel/Reader/Excel5.php | 2 +- Classes/PHPExcel/Reader/Gnumeric.php | 2 +- Classes/PHPExcel/Reader/HTML.php | 2 +- Classes/PHPExcel/Reader/IReader.php | 4 ++-- Classes/PHPExcel/Reader/OOCalc.php | 2 +- Classes/PHPExcel/Reader/SYLK.php | 2 +- Classes/PHPExcel/ReferenceHelper.php | 1 + Classes/PHPExcel/Shared/Font.php | 10 +++++----- Classes/PHPExcel/Shared/String.php | 9 +++++---- 13 files changed, 28 insertions(+), 26 deletions(-) diff --git a/Classes/PHPExcel/IOFactory.php b/Classes/PHPExcel/IOFactory.php index a467ecb3..63705463 100644 --- a/Classes/PHPExcel/IOFactory.php +++ b/Classes/PHPExcel/IOFactory.php @@ -183,7 +183,7 @@ class PHPExcel_IOFactory * * @static * @access public - * @param string $pFileName The name of the spreadsheet file + * @param string $pFilename The name of the spreadsheet file * @return PHPExcel * @throws PHPExcel_Reader_Exception */ @@ -197,7 +197,7 @@ class PHPExcel_IOFactory * * @static * @access public - * @param string $pFileName The name of the spreadsheet file to identify + * @param string $pFilename The name of the spreadsheet file to identify * @return string * @throws PHPExcel_Reader_Exception */ @@ -214,7 +214,7 @@ class PHPExcel_IOFactory * * @static * @access public - * @param string $pFileName The name of the spreadsheet file + * @param string $pFilename The name of the spreadsheet file * @return PHPExcel_Reader_IReader * @throws PHPExcel_Reader_Exception */ diff --git a/Classes/PHPExcel/Reader/CSV.php b/Classes/PHPExcel/Reader/CSV.php index 13d0e277..4678f7dc 100644 --- a/Classes/PHPExcel/Reader/CSV.php +++ b/Classes/PHPExcel/Reader/CSV.php @@ -113,7 +113,7 @@ class PHPExcel_Reader_CSV extends PHPExcel_Reader_Abstract implements PHPExcel_R * Can the current PHPExcel_Reader_IReader read the file? * * @access public - * @param string $pFileName + * @param string $pFilename * @return boolean * @throws PHPExcel_Reader_Exception */ @@ -434,7 +434,7 @@ class PHPExcel_Reader_CSV extends PHPExcel_Reader_Abstract implements PHPExcel_R * Set sheet index * * @access public - * @param int $pValue Sheet index + * @param integer $pValue Sheet index * @return PHPExcel_Reader_CSV */ public function setSheetIndex($pValue = 0) { @@ -447,11 +447,11 @@ class PHPExcel_Reader_CSV extends PHPExcel_Reader_Abstract implements PHPExcel_R * Set Contiguous * * @access public - * @param string $pValue Input encoding + * @param boolean $contiguous */ - public function setContiguous($contiguous = false) + public function setContiguous($contiguous = FALSE) { - $this->_contiguous = (bool)$contiguous; + $this->_contiguous = (bool) $contiguous; if (!$contiguous) { $this->_contiguousRow = -1; } diff --git a/Classes/PHPExcel/Reader/Excel2003XML.php b/Classes/PHPExcel/Reader/Excel2003XML.php index 76500ec5..58496855 100644 --- a/Classes/PHPExcel/Reader/Excel2003XML.php +++ b/Classes/PHPExcel/Reader/Excel2003XML.php @@ -70,7 +70,7 @@ class PHPExcel_Reader_Excel2003XML extends PHPExcel_Reader_Abstract implements P /** * Can the current PHPExcel_Reader_IReader read the file? * - * @param string $pFileName + * @param string $pFilename * @return boolean * @throws PHPExcel_Reader_Exception */ diff --git a/Classes/PHPExcel/Reader/Excel2007.php b/Classes/PHPExcel/Reader/Excel2007.php index e2a677de..4830934c 100644 --- a/Classes/PHPExcel/Reader/Excel2007.php +++ b/Classes/PHPExcel/Reader/Excel2007.php @@ -71,7 +71,7 @@ class PHPExcel_Reader_Excel2007 extends PHPExcel_Reader_Abstract implements PHPE /** * Can the current PHPExcel_Reader_IReader read the file? * - * @param string $pFileName + * @param string $pFilename * @return boolean * @throws PHPExcel_Reader_Exception */ diff --git a/Classes/PHPExcel/Reader/Excel5.php b/Classes/PHPExcel/Reader/Excel5.php index 5efee8d5..91569d28 100644 --- a/Classes/PHPExcel/Reader/Excel5.php +++ b/Classes/PHPExcel/Reader/Excel5.php @@ -391,7 +391,7 @@ class PHPExcel_Reader_Excel5 extends PHPExcel_Reader_Abstract implements PHPExce /** * Can the current PHPExcel_Reader_IReader read the file? * - * @param string $pFileName + * @param string $pFilename * @return boolean * @throws PHPExcel_Reader_Exception */ diff --git a/Classes/PHPExcel/Reader/Gnumeric.php b/Classes/PHPExcel/Reader/Gnumeric.php index 821d1acd..c0ad7725 100644 --- a/Classes/PHPExcel/Reader/Gnumeric.php +++ b/Classes/PHPExcel/Reader/Gnumeric.php @@ -73,7 +73,7 @@ class PHPExcel_Reader_Gnumeric extends PHPExcel_Reader_Abstract implements PHPEx /** * Can the current PHPExcel_Reader_IReader read the file? * - * @param string $pFileName + * @param string $pFilename * @return boolean * @throws PHPExcel_Reader_Exception */ diff --git a/Classes/PHPExcel/Reader/HTML.php b/Classes/PHPExcel/Reader/HTML.php index 4e8b8e99..d8c5821b 100644 --- a/Classes/PHPExcel/Reader/HTML.php +++ b/Classes/PHPExcel/Reader/HTML.php @@ -111,7 +111,7 @@ class PHPExcel_Reader_HTML extends PHPExcel_Reader_Abstract implements PHPExcel_ /** * Can the current PHPExcel_Reader_IReader read the file? * - * @param string $pFileName + * @param string $pFilename * @return boolean * @throws PHPExcel_Reader_Exception */ diff --git a/Classes/PHPExcel/Reader/IReader.php b/Classes/PHPExcel/Reader/IReader.php index c26f1d40..db97bb85 100644 --- a/Classes/PHPExcel/Reader/IReader.php +++ b/Classes/PHPExcel/Reader/IReader.php @@ -38,7 +38,7 @@ interface PHPExcel_Reader_IReader /** * Can the current PHPExcel_Reader_IReader read the file? * - * @param string $pFileName + * @param string $pFilename * @return boolean */ public function canRead($pFilename); @@ -46,7 +46,7 @@ interface PHPExcel_Reader_IReader /** * Loads PHPExcel from file * - * @param string $pFileName + * @param string $pFilename * @throws PHPExcel_Reader_Exception */ public function load($pFilename); diff --git a/Classes/PHPExcel/Reader/OOCalc.php b/Classes/PHPExcel/Reader/OOCalc.php index a25ceb09..460e675b 100644 --- a/Classes/PHPExcel/Reader/OOCalc.php +++ b/Classes/PHPExcel/Reader/OOCalc.php @@ -63,7 +63,7 @@ class PHPExcel_Reader_OOCalc extends PHPExcel_Reader_Abstract implements PHPExce /** * Can the current PHPExcel_Reader_IReader read the file? * - * @param string $pFileName + * @param string $pFilename * @return boolean * @throws PHPExcel_Reader_Exception */ diff --git a/Classes/PHPExcel/Reader/SYLK.php b/Classes/PHPExcel/Reader/SYLK.php index 0be71f3c..d3a99357 100644 --- a/Classes/PHPExcel/Reader/SYLK.php +++ b/Classes/PHPExcel/Reader/SYLK.php @@ -83,7 +83,7 @@ class PHPExcel_Reader_SYLK extends PHPExcel_Reader_Abstract implements PHPExcel_ /** * Can the current PHPExcel_Reader_IReader read the file? * - * @param string $pFileName + * @param string $pFilename * @return boolean * @throws PHPExcel_Reader_Exception */ diff --git a/Classes/PHPExcel/ReferenceHelper.php b/Classes/PHPExcel/ReferenceHelper.php index 94f21b32..0e191c62 100644 --- a/Classes/PHPExcel/ReferenceHelper.php +++ b/Classes/PHPExcel/ReferenceHelper.php @@ -641,6 +641,7 @@ class PHPExcel_ReferenceHelper * @param int $pBefore Insert before this one * @param int $pNumCols Number of columns to insert * @param int $pNumRows Number of rows to insert + * @param string $sheetName Worksheet name/title * @return string Updated formula * @throws PHPExcel_Exception */ diff --git a/Classes/PHPExcel/Shared/Font.php b/Classes/PHPExcel/Shared/Font.php index 6879e602..1a4f8ae4 100644 --- a/Classes/PHPExcel/Shared/Font.php +++ b/Classes/PHPExcel/Shared/Font.php @@ -244,11 +244,11 @@ class PHPExcel_Shared_Font /** * Calculate an (approximate) OpenXML column width, based on font size and text contained * - * @param int $fontSize Font size (in pixels or points) - * @param bool $fontSizeInPixels Is the font size specified in pixels (true) or in points (false) ? - * @param string $cellText Text to calculate width - * @param int $rotation Rotation angle - * @return int Column width + * @param PHPExcel_Style_Font $font Font object + * @param PHPExcel_RichText|string $cellText Text to calculate width + * @param integer $rotation Rotation angle + * @param PHPExcel_Style_Font|NULL $defaultFont Font object + * @return integer Column width */ public static function calculateColumnWidth(PHPExcel_Style_Font $font, $cellText = '', $rotation = 0, PHPExcel_Style_Font $defaultFont = null) { diff --git a/Classes/PHPExcel/Shared/String.php b/Classes/PHPExcel/Shared/String.php index 38974336..d9470b1b 100644 --- a/Classes/PHPExcel/Shared/String.php +++ b/Classes/PHPExcel/Shared/String.php @@ -427,7 +427,8 @@ class PHPExcel_Shared_String * although this will give wrong results for non-ASCII strings * see OpenOffice.org's Documentation of the Microsoft Excel File Format, sect. 2.5.3 * - * @param string $value UTF-8 encoded string + * @param string $value UTF-8 encoded string + * @param mixed[] $arrcRuns Details of rich text runs in $value * @return string */ public static function UTF8toBIFF8UnicodeShort($value, $arrcRuns = array()) @@ -523,7 +524,7 @@ class PHPExcel_Shared_String * @author Rasmus Andersson {@link http://rasmusandersson.se/} * @author vadik56 */ - public static function utf16_decode( $str, $bom_be=true ) { + public static function utf16_decode($str, $bom_be = TRUE) { if( strlen($str) < 2 ) return $str; $c0 = ord($str{0}); $c1 = ord($str{1}); @@ -564,8 +565,8 @@ class PHPExcel_Shared_String * Get a substring of a UTF-8 encoded string. First try mbstring, then iconv, finally strlen * * @param string $pValue UTF-8 encoded string - * @param int $start Start offset - * @param int $length Maximum number of characters in substring + * @param int $pStart Start offset + * @param int $pLength Maximum number of characters in substring * @return string */ public static function Substring($pValue = '', $pStart = 0, $pLength = 0)