Add further description to PHPDoc blocks

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

Classes/PHPExcel/Reader/Excel2007.php

@@ -46,15 +46,18 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
 {
 	/**
 	 *	Read data only?
+	 *	Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
+	 *		or whether it should read both data and formatting
 	 *
 	 *	@var	boolean
 	 */
 	private $_readDataOnly = false;
 
 	/**
-	 * Restict which sheets should be loaded?
+	 *	Restrict which sheets should be loaded?
+	 *	This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.
 	 *
-	 * @var array
+	 *	@var array of string
 	 */
 	private $_loadSheetsOnly = null;
 
@@ -65,13 +68,25 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
 	 */
 	private $_readFilter = null;
 
-
+	/**
+	 * PHPExcel_ReferenceHelper instance
+	 *
+	 * @var PHPExcel_ReferenceHelper
+	 */
 	private $_referenceHelper = null;
 
+	/**
+	 * PHPExcel_Reader_Excel2007_Theme instance
+	 *
+	 * @var PHPExcel_Reader_Excel2007_Theme
+	 */
 	private static $_theme = null;
 
+
 	/**
 	 *	Read data only?
+	 *		If this is true, then the Reader will only read data values for cells, it will not read any formatting information.
+	 *		If false (the default) it will read data and formatting.
 	 *
 	 *	@return	boolean
 	 */
@@ -81,8 +96,11 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Set read data only
+	 *		Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.
+	 *		Set to false (the default) to advise the Reader to read both data and formatting for cells.
 	 *
 	 *	@param	boolean	$pValue
+	 *
 	 *	@return	PHPExcel_Reader_Excel2007
 	 */
 	public function setReadDataOnly($pValue = false) {
@@ -92,6 +110,8 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Get which sheets to load
+	 *		Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
+	 *			indicating that all worksheets in the workbook should be loaded.
 	 *
 	 *	@return mixed
 	 */
@@ -104,6 +124,9 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
 	 *	Set which sheets to load
 	 *
 	 *	@param mixed $value
+	 *		This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name.
+	 *		If NULL, then it tells the Reader to read all worksheets in the workbook
+	 *
 	 *	@return PHPExcel_Reader_Excel2007
 	 */
 	public function setLoadSheetsOnly($value = null)
@@ -115,6 +138,7 @@ class PHPExcel_Reader_Excel2007 implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Set all sheets to load
+	 *		Tells the Reader to load all worksheets from the workbook.
 	 *
 	 *	@return PHPExcel_Reader_Excel2007
 	 */

Classes/PHPExcel/Reader/Excel5.php

@@ -160,15 +160,18 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Read data only?
+	 *	Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
+	 *		or whether it should read both data and formatting
 	 *
 	 *	@var	boolean
 	 */
 	private $_readDataOnly = false;
 
 	/**
-	 * Restict which sheets should be loaded?
+	 *	Restrict which sheets should be loaded?
+	 *	This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.
 	 *
-	 * @var array
+	 *	@var	array of string
 	 */
 	private $_loadSheetsOnly = null;
 
@@ -398,8 +401,11 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
 	 */
 	private $_sharedFormulaParts;
 
+
 	/**
 	 *	Read data only?
+	 *		If this is true, then the Reader will only read data values for cells, it will not read any formatting information.
+	 *		If false (the default) it will read data and formatting.
 	 *
 	 *	@return	boolean
 	 */
@@ -410,8 +416,11 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Set read data only
+	 *		Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.
+	 *		Set to false (the default) to advise the Reader to read both data and formatting for cells.
 	 *
 	 *	@param	boolean	$pValue
+	 *
 	 *	@return	PHPExcel_Reader_Excel5
 	 */
 	public function setReadDataOnly($pValue = false)
@@ -422,6 +431,8 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Get which sheets to load
+	 *		Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
+	 *			indicating that all worksheets in the workbook should be loaded.
 	 *
 	 *	@return mixed
 	 */
@@ -434,6 +445,9 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
 	 *	Set which sheets to load
 	 *
 	 *	@param mixed $value
+	 *		This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name.
+	 *		If NULL, then it tells the Reader to read all worksheets in the workbook
+	 *
 	 *	@return PHPExcel_Reader_Excel5
 	 */
 	public function setLoadSheetsOnly($value = null)
@@ -445,6 +459,7 @@ class PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Set all sheets to load
+	 *		Tells the Reader to load all worksheets from the workbook.
 	 *
 	 *	@return	PHPExcel_Reader_Excel5
 	 */

Classes/PHPExcel/Reader/Gnumeric.php

@@ -46,15 +46,18 @@ class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
 {
 	/**
 	 *	Read data only?
+	 *	Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
+	 *		or whether it should read both data and formatting
 	 *
 	 *	@var	boolean
 	 */
 	private $_readDataOnly = false;
 
 	/**
-	 * Restict which sheets should be loaded?
+	 *	Restrict which sheets should be loaded?
+	 *	This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.
 	 *
-	 * @var array
+	 *	@var	array of string
 	 */
 	private $_loadSheetsOnly = null;
 
@@ -84,6 +87,8 @@ class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Read data only?
+	 *		If this is true, then the Reader will only read data values for cells, it will not read any formatting information.
+	 *		If false (the default) it will read data and formatting.
 	 *
 	 *	@return	boolean
 	 */
@@ -93,8 +98,11 @@ class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Set read data only
+	 *		Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.
+	 *		Set to false (the default) to advise the Reader to read both data and formatting for cells.
 	 *
 	 *	@param	boolean	$pValue
+	 *
 	 *	@return	PHPExcel_Reader_Gnumeric
 	 */
 	public function setReadDataOnly($pValue = false) {
@@ -104,6 +112,8 @@ class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Get which sheets to load
+	 *		Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
+	 *			indicating that all worksheets in the workbook should be loaded.
 	 *
 	 *	@return mixed
 	 */
@@ -116,6 +126,9 @@ class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
 	 *	Set which sheets to load
 	 *
 	 *	@param mixed $value
+	 *		This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name.
+	 *		If NULL, then it tells the Reader to read all worksheets in the workbook
+	 *
 	 *	@return PHPExcel_Reader_Gnumeric
 	 */
 	public function setLoadSheetsOnly($value = null)
@@ -127,6 +140,7 @@ class PHPExcel_Reader_Gnumeric implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Set all sheets to load
+	 *		Tells the Reader to load all worksheets from the workbook.
 	 *
 	 *	@return PHPExcel_Reader_Gnumeric
 	 */

Classes/PHPExcel/Reader/OOCalc.php

@@ -46,15 +46,18 @@ class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
 {
 	/**
 	 *	Read data only?
+	 *	Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
+	 *		or whether it should read both data and formatting
 	 *
 	 *	@var	boolean
 	 */
 	private $_readDataOnly = false;
 
 	/**
-	 * Restict which sheets should be loaded?
+	 *	Restrict which sheets should be loaded?
+	 *	This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.
 	 *
-	 * @var array
+	 *	@var	array of string
 	 */
 	private $_loadSheetsOnly = null;
 
@@ -75,6 +78,8 @@ class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Read data only?
+	 *		If this is true, then the Reader will only read data values for cells, it will not read any formatting information.
+	 *		If false (the default) it will read data and formatting.
 	 *
 	 *	@return	boolean
 	 */
@@ -84,8 +89,11 @@ class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Set read data only
+	 *		Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.
+	 *		Set to false (the default) to advise the Reader to read both data and formatting for cells.
 	 *
 	 *	@param	boolean	$pValue
+	 *
 	 *	@return	PHPExcel_Reader_OOCalc
 	 */
 	public function setReadDataOnly($pValue = false) {
@@ -95,6 +103,8 @@ class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Get which sheets to load
+	 *		Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
+	 *			indicating that all worksheets in the workbook should be loaded.
 	 *
 	 *	@return mixed
 	 */
@@ -107,6 +117,9 @@ class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
 	 *	Set which sheets to load
 	 *
 	 *	@param mixed $value
+	 *		This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name.
+	 *		If NULL, then it tells the Reader to read all worksheets in the workbook
+	 *
 	 *	@return PHPExcel_Reader_OOCalc
 	 */
 	public function setLoadSheetsOnly($value = null)
@@ -118,6 +131,7 @@ class PHPExcel_Reader_OOCalc implements PHPExcel_Reader_IReader
 
 	/**
 	 *	Set all sheets to load
+	 *		Tells the Reader to load all worksheets from the workbook.
 	 *
 	 *	@return PHPExcel_Reader_OOCalc
 	 */