Doc Block changes

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

Classes/PHPExcel/Writer/Excel2007/Rels.php

@@ -173,9 +173,10 @@ class PHPExcel_Writer_Excel2007_Rels extends PHPExcel_Writer_Excel2007_WriterPar
 	 * 	rId1 				- Drawings
 	 *  rId_hyperlink_x 	- Hyperlinks
 	 *
-	 * @param 	PHPExcel_Worksheet		$pWorksheet
+	 * @param 	PHPExcel_Worksheet	$pWorksheet
-	 * @param 	int						$pWorksheetId
+	 * @param 	int					$pWorksheetId
-	 * @return 	string 					XML Output
+	 * @param	boolean				$includeCharts	Flag indicating if we should write charts
+	 * @return 	string 				XML Output
 	 * @throws 	Exception
 	 */
 	public function writeWorksheetRelationships(PHPExcel_Worksheet $pWorksheet = null, $pWorksheetId = 1, $includeCharts = FALSE)
@@ -281,8 +282,10 @@ class PHPExcel_Writer_Excel2007_Rels extends PHPExcel_Writer_Excel2007_WriterPar
 	/**
 	 * Write drawing relationships to XML format
 	 *
-	 * @param 	PHPExcel_Worksheet			$pWorksheet
+	 * @param 	PHPExcel_Worksheet	$pWorksheet
-	 * @return 	string 						XML Output
+	 * @param	int					&$chartRef		Chart ID
+	 * @param	boolean				$includeCharts	Flag indicating if we should write charts
+	 * @return 	string 				XML Output
 	 * @throws 	Exception
 	 */
 	public function writeDrawingRelationships(PHPExcel_Worksheet $pWorksheet = null, &$chartRef, $includeCharts = FALSE)

Classes/PHPExcel/Writer/Excel2007/StringTable.php

@@ -142,8 +142,9 @@ class PHPExcel_Writer_Excel2007_StringTable extends PHPExcel_Writer_Excel2007_Wr
 	/**
 	 * Write Rich Text
 	 *
-	 * @param 	PHPExcel_Shared_XMLWriter		$objWriter 		XML Writer
+	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer
-	 * @param 	PHPExcel_RichText				$pRichText		Rich text
+	 * @param 	PHPExcel_RichText			$pRichText		Rich text
+	 * @param 	string						$prefix			Optional Namespace prefix
 	 * @throws 	Exception
 	 */
 	public function writeRichText(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_RichText $pRichText = null, $prefix=NULL)
@@ -223,8 +224,9 @@ class PHPExcel_Writer_Excel2007_StringTable extends PHPExcel_Writer_Excel2007_Wr
 	/**
 	 * Write Rich Text
 	 *
-	 * @param 	PHPExcel_Shared_XMLWriter		$objWriter 		XML Writer
+	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer
-	 * @param 	PHPExcel_RichText				$pRichText		Rich text
+	 * @param 	PHPExcel_RichText			$pRichText		Rich text
+	 * @param 	string						$prefix			Optional Namespace prefix
 	 * @throws 	Exception
 	 */
 	public function writeRichTextForCharts(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_RichText $pRichText = null, $prefix=NULL)

Classes/PHPExcel/Writer/Excel2007/Theme.php

@@ -35,6 +35,11 @@
  */
 class PHPExcel_Writer_Excel2007_Theme extends PHPExcel_Writer_Excel2007_WriterPart
 {
+	/**
+	 * Map of Major fonts to write
+	 * @static	array of string
+	 *
+	 */
 	private static $_majorFonts = array(
 					'Jpan' => 'ＭＳ Ｐゴシック',
 					'Hang' => '맑은 고딕',
@@ -68,6 +73,11 @@ class PHPExcel_Writer_Excel2007_Theme extends PHPExcel_Writer_Excel2007_WriterPa
 					'Geor' => 'Sylfaen',
 			);
 
+	/**
+	 * Map of Minor fonts to write
+	 * @static	array of string
+	 *
+	 */
 	private static $_minorFonts = array(
 					'Jpan' => 'ＭＳ Ｐゴシック',
 					'Hang' => '맑은 고딕',
@@ -101,6 +111,11 @@ class PHPExcel_Writer_Excel2007_Theme extends PHPExcel_Writer_Excel2007_WriterPa
 					'Geor' => 'Sylfaen',
 			);
 
+	/**
+	 * Map of core colours
+	 * @static	array of string
+	 *
+	 */
 		private static $_colourScheme = array(
 					'dk2'		=> '1F497D',
 					'lt2'		=> 'EEECE1',
@@ -798,6 +813,15 @@ class PHPExcel_Writer_Excel2007_Theme extends PHPExcel_Writer_Excel2007_WriterPa
 			return $objWriter->getData();
 	}
 
+	/**
+	 * Write fonts to XML format
+	 *
+	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter
+	 * @param 	string						$latinFont
+	 * @param 	array of string				$fontSet
+	 * @return 	string 						XML Output
+	 * @throws 	Exception
+	 */
 	private function _writeFonts($objWriter, $latinFont, $fontSet)
 	{
 		// a:latin
@@ -824,6 +848,13 @@ class PHPExcel_Writer_Excel2007_Theme extends PHPExcel_Writer_Excel2007_WriterPa
 
 	}
 
+	/**
+	 * Write colour scheme to XML format
+	 *
+	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter
+	 * @return 	string 						XML Output
+	 * @throws 	Exception
+	 */
 	private function _writeColourScheme($objWriter)
 	{
 		foreach(self::$_colourScheme as $colourName => $colourValue) {

Classes/PHPExcel/Writer/Excel2007/Workbook.php

@@ -39,6 +39,7 @@ class PHPExcel_Writer_Excel2007_Workbook extends PHPExcel_Writer_Excel2007_Write
 	 * Write workbook to XML format
 	 *
 	 * @param 	PHPExcel	$pPHPExcel
+	 * @param	boolean		$recalcRequired	Indicate whether formulas should be recalculated before writing
 	 * @return 	string 		XML Output
 	 * @throws 	Exception
 	 */
@@ -185,7 +186,8 @@ class PHPExcel_Writer_Excel2007_Workbook extends PHPExcel_Writer_Excel2007_Write
 	/**
 	 * Write calcPr
 	 *
-	 * @param 	PHPExcel_Shared_XMLWriter $objWriter 		XML Writer
+	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter		XML Writer
+	 * @param	boolean						$recalcRequired	Indicate whether formulas should be recalculated before writing
 	 * @throws 	Exception
 	 */
 	private function _writeCalcPr(PHPExcel_Shared_XMLWriter $objWriter = null, $recalcRequired = TRUE)