Doc Block changes

git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@87554 2327b42d-5241-43d6-9e2a-de5ac946f064

Classes/PHPExcel/Writer/Excel2007/Worksheet.php

@@ -40,6 +40,7 @@ class PHPExcel_Writer_Excel2007_Worksheet extends PHPExcel_Writer_Excel2007_Writ
 	 *
 	 * @param	PHPExcel_Worksheet		$pSheet
 	 * @param	string[]				$pStringTable
+	 * @param	boolean					$includeCharts	Flag indicating if we should write charts
 	 * @return	string					XML Output
 	 * @throws	Exception
 	 */
@@ -959,7 +960,7 @@ class PHPExcel_Writer_Excel2007_Worksheet extends PHPExcel_Writer_Excel2007_Writ
 	 *
 	 * @param	PHPExcel_Shared_XMLWriter	$objWriter				XML Writer
 	 * @param	PHPExcel_Worksheet			$pSheet					Worksheet
-	 * @param	PHPExcel_Cell				$pCell					Cell
+	 * @param	PHPExcel_Cell				$pCellAddress			Cell Address
 	 * @param	string[]					$pStringTable			String table
 	 * @param	string[]					$pFlippedStringTable	String table (flipped), for faster index searching
 	 * @throws	Exception
@@ -1083,6 +1084,7 @@ class PHPExcel_Writer_Excel2007_Worksheet extends PHPExcel_Writer_Excel2007_Writ
 	 *
 	 * @param	PHPExcel_Shared_XMLWriter	$objWriter		XML Writer
 	 * @param	PHPExcel_Worksheet			$pSheet			Worksheet
+	 * @param	boolean						$includeCharts	Flag indicating if we should include drawing details for charts
 	 * @throws	Exception
 	 */
 	private function _writeDrawings(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_Worksheet $pSheet = null, $includeCharts = FALSE)

Classes/PHPExcel/Writer/Excel5/Font.php

@@ -139,6 +139,11 @@ class PHPExcel_Writer_Excel5_Font
 		return 0x190;		//	400 = Normal font weight
 	}
 
+	/**
+	 * Map of BIFF2-BIFF8 codes for underline styles
+	 * @static	array of int
+	 *
+	 */
 	private static $_mapUnderline = array(	PHPExcel_Style_Font::UNDERLINE_NONE					=> 0x00,
 											PHPExcel_Style_Font::UNDERLINE_SINGLE				=> 0x01,
 											PHPExcel_Style_Font::UNDERLINE_DOUBLE				=> 0x02,

Classes/PHPExcel/Writer/Excel5/Parser.php

@@ -118,8 +118,6 @@ class PHPExcel_Writer_Excel5_Parser
 	/**
 	 * The class constructor
 	 *
-	 * @param integer $byte_order The byte order (Little endian or Big endian) of the architecture
-	 *                           (optional). 1 => big endian, 0 (default) little endian.
 	 */
 	public function __construct()
 	{
@@ -635,6 +633,7 @@ class PHPExcel_Writer_Excel5_Parser
 	 *
 	 * @access private
 	 * @param string	$range	An Excel range in the A1:A2
+	 * @param int		$class
 	 */
 	function _convertRange2d($range, $class=0)
 	{
@@ -777,7 +776,8 @@ class PHPExcel_Writer_Excel5_Parser
      * Convert an error code to a ptgErr
      *
      * @access	private
-     * @param mixed $num an error codefor conversion to its ptg value
+	 * @param	string	$errorCode	The error code for conversion to its ptg value
+     * @return	string				The error code ptgErr
      */
     function _convertError($errorCode)
     {
@@ -903,6 +903,7 @@ class PHPExcel_Writer_Excel5_Parser
 	 * PHPExcel_Writer_Excel5_Workbook class.
 	 *
 	 * @access	private
+	 * @param	string	$sheet_name		Sheet name
 	 * @return	integer					The sheet index, -1 if the sheet was not found
 	 */
 	function _getSheetIndex($sheet_name)

Classes/PHPExcel/Writer/Excel5/Workbook.php

@@ -194,9 +194,10 @@ class PHPExcel_Writer_Excel5_Workbook extends PHPExcel_Writer_Excel5_BIFFwriter
 	 * Class constructor
 	 *
 	 * @param PHPExcel	$phpExcel		The Workbook
-	 * @param int  $str_total		Total number of strings
+	 * @param int		&$str_total		Total number of strings
-	 * @param int  $str_unique		Total number of unique strings
+	 * @param int		&$str_unique	Total number of unique strings
-	 * @param array  $str_table
+	 * @param array		&$str_table		String Table
+	 * @param array		&$colors		Colour Table
 	 * @param mixed		$parser			The formula parser created for the Workbook
 	 */
 	public function __construct(PHPExcel $phpExcel = null,
@@ -418,7 +419,7 @@ class PHPExcel_Writer_Excel5_Workbook extends PHPExcel_Writer_Excel5_BIFFwriter
 	 * Assemble worksheets into a workbook and send the BIFF data to an OLE
 	 * storage.
 	 *
-	 * @param array $worksheetSizes The sizes in bytes of the binary worksheet streams
+	 * @param	array	$pWorksheetSizes	The sizes in bytes of the binary worksheet streams
 	 * @return	string	Binary data for workbook stream
 	 */
 	public function writeWorkbook($pWorksheetSizes = null)

Classes/PHPExcel/Writer/Excel5/Worksheet.php

@@ -204,8 +204,8 @@ class PHPExcel_Writer_Excel5_Worksheet extends PHPExcel_Writer_Excel5_BIFFwriter
 	 *
 	 * @param int		&$str_total		Total number of strings
 	 * @param int		&$str_unique	Total number of unique strings
-	 * @param array		&$str_table
+	 * @param array		&$str_table		String Table
-	 * @param array		&$colors
+	 * @param array		&$colors		Colour Table
 	 * @param mixed		$parser			The formula parser created for the Workbook
 	 * @param boolean	$preCalculateFormulas	Flag indicating whether formulas should be calculated or just written
 	 * @param string	$phpSheet		The worksheet to write