From eeac8e3b7fb176e8ff386e11c5145048e5e94a04 Mon Sep 17 00:00:00 2001
From: Mark Baker <mark@lange.demon.co.uk>
Date: Sat, 10 Mar 2012 11:14:05 +0000
Subject: [PATCH] Doc Block changes

git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@87549 2327b42d-5241-43d6-9e2a-de5ac946f064
---
 Classes/PHPExcel/Writer/Excel5.php    | 14 ++++++++++++++
 Classes/PHPExcel/Writer/Excel5/Xf.php | 27 ++++++++++++++++++++++++++-
 Classes/PHPExcel/Writer/HTML.php      |  3 +++
 3 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/Classes/PHPExcel/Writer/Excel5.php b/Classes/PHPExcel/Writer/Excel5.php
index 7a6c3a71..1bab6438 100644
--- a/Classes/PHPExcel/Writer/Excel5.php
+++ b/Classes/PHPExcel/Writer/Excel5.php
@@ -91,8 +91,18 @@ class PHPExcel_Writer_Excel5 implements PHPExcel_Writer_IWriter
 	 */
 	private $_IDCLs;
 
+	/**
+	 * Basic OLE object summary information
+	 *
+	 * @var array
+	 */
 	private $_summaryInformation;
 
+	/**
+	 * Extended OLE object document summary information
+	 *
+	 * @var array
+	 */
 	private $_documentSummaryInformation;
 
 	/**
@@ -256,6 +266,10 @@ class PHPExcel_Writer_Excel5 implements PHPExcel_Writer_IWriter
 		$this->_preCalculateFormulas = $pValue;
 	}
 
+	/**
+	 * Build the Worksheet Escher objects
+	 *
+	 */
 	private function _buildWorksheetEschers()
 	{
 		// 1-based index to BstoreContainer
diff --git a/Classes/PHPExcel/Writer/Excel5/Xf.php b/Classes/PHPExcel/Writer/Excel5/Xf.php
index 22ec76fc..828a436c 100644
--- a/Classes/PHPExcel/Writer/Excel5/Xf.php
+++ b/Classes/PHPExcel/Writer/Excel5/Xf.php
@@ -165,7 +165,6 @@ class PHPExcel_Writer_Excel5_Xf
 	/**
 	 * Generate an Excel BIFF XF record (style or cell).
 	 *
-	 * @param string $style The type of the XF record ('style' or 'cell').
 	 * @return string The XF record
 	 */
 	function writeXf()
@@ -378,6 +377,11 @@ class PHPExcel_Writer_Excel5_Xf
 		$this->_fontIndex = $value;
 	}
 
+	/**
+	 * Map of BIFF2-BIFF8 codes for border styles
+	 * @static	array of int
+	 *
+	 */
 	private static $_mapBorderStyle = array	( PHPExcel_Style_Border::BORDER_NONE				=> 0x00,
 											  PHPExcel_Style_Border::BORDER_THIN				=> 0x01,
 											  PHPExcel_Style_Border::BORDER_MEDIUM				=> 0x02,
@@ -396,6 +400,9 @@ class PHPExcel_Writer_Excel5_Xf
 
 	/**
 	 * Map border style
+	 *
+	 * @param string $borderStyle
+	 * @return int
 	 */
 	private static function _mapBorderStyle($borderStyle) {
 		if (isset(self::$_mapBorderStyle[$borderStyle]))
@@ -403,6 +410,11 @@ class PHPExcel_Writer_Excel5_Xf
 		return 0x00;
 	}
 
+	/**
+	 * Map of BIFF2-BIFF8 codes for fill types
+	 * @static	array of int
+	 *
+	 */
 	private static $_mapFillType = array( PHPExcel_Style_Fill::FILL_NONE					=> 0x00,
 										  PHPExcel_Style_Fill::FILL_SOLID					=> 0x01,
 										  PHPExcel_Style_Fill::FILL_PATTERN_MEDIUMGRAY		=> 0x02,
@@ -427,6 +439,9 @@ class PHPExcel_Writer_Excel5_Xf
 										);
 	/**
 	 * Map fill type
+	 *
+	 * @param string $fillType
+	 * @return int
 	 */
 	private static function _mapFillType($fillType) {
 		if (isset(self::$_mapFillType[$fillType]))
@@ -434,6 +449,11 @@ class PHPExcel_Writer_Excel5_Xf
 		return 0x00;
 	}
 
+	/**
+	 * Map of BIFF2-BIFF8 codes for horizontal alignment
+	 * @static	array of int
+	 *
+	 */
 	private static $_mapHAlign = array( PHPExcel_Style_Alignment::HORIZONTAL_GENERAL			=> 0,
 										PHPExcel_Style_Alignment::HORIZONTAL_LEFT				=> 1,
 										PHPExcel_Style_Alignment::HORIZONTAL_CENTER				=> 2,
@@ -454,6 +474,11 @@ class PHPExcel_Writer_Excel5_Xf
 		return 0;
 	}
 
+	/**
+	 * Map of BIFF2-BIFF8 codes for vertical alignment
+	 * @static	array of int
+	 *
+	 */
 	private static $_mapVAlign = array( PHPExcel_Style_Alignment::VERTICAL_TOP		=> 0,
 										PHPExcel_Style_Alignment::VERTICAL_CENTER	=> 1,
 										PHPExcel_Style_Alignment::VERTICAL_BOTTOM	=> 2,
diff --git a/Classes/PHPExcel/Writer/HTML.php b/Classes/PHPExcel/Writer/HTML.php
index 02e91707..08a2676d 100644
--- a/Classes/PHPExcel/Writer/HTML.php
+++ b/Classes/PHPExcel/Writer/HTML.php
@@ -223,6 +223,9 @@ class PHPExcel_Writer_HTML implements PHPExcel_Writer_IWriter {
 
 	/**
 	 * Map border style
+	 *
+	 * @param	int		$borderStyle		Sheet index
+	 * @return	string
 	 */
 	private function _mapBorderStyle($borderStyle) {
 		switch ($borderStyle) {