Doc Block changes

git-svn-id: https://phpexcel.svn.codeplex.com/svn/trunk@87532 2327b42d-5241-43d6-9e2a-de5ac946f064
This commit is contained in:
Mark Baker 2012-03-09 23:55:17 +00:00
parent 93fa26a100
commit b3cb86ccff
8 changed files with 26 additions and 10 deletions

View File

@ -127,6 +127,11 @@ class PHPExcel
}
/**
* Disconnect all worksheets from this PHPExcel workbook object,
* typically so that the PHPExcel object can be unset
*
*/
public function disconnectWorksheets() {
foreach($this->_workSheetCollection as $k => &$worksheet) {
$worksheet->disconnectCells();
@ -189,7 +194,9 @@ class PHPExcel
/**
* Create sheet and add it to this workbook
*
* @param int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last)
* @return PHPExcel_Worksheet
* @throws Exception
*/
public function createSheet($iSheetIndex = null)
{
@ -491,8 +498,8 @@ class PHPExcel
/**
* Remove named range
*
* @param string $namedRange
* @param PHPExcel_Worksheet|null $pSheet. Scope. Use null for global scope.
* @param string $namedRange
* @param PHPExcel_Worksheet|null $pSheet Scope: use null for global scope.
* @return PHPExcel
*/
public function removeNamedRange($namedRange, PHPExcel_Worksheet $pSheet = null) {
@ -558,7 +565,7 @@ class PHPExcel
/**
* Get cellXf by index
*
* @param int $index
* @param int $pIndex
* @return PHPExcel_Style
*/
public function getCellXfByIndex($pIndex = 0)
@ -599,7 +606,7 @@ class PHPExcel
/**
* Add a cellXf to the workbook
*
* @param PHPExcel_Style
* @param PHPExcel_Style $style
*/
public function addCellXf(PHPExcel_Style $style)
{

View File

@ -369,6 +369,11 @@ class PHPExcel_Worksheet implements PHPExcel_IComparable
}
/**
* Disconnect all cells from this PHPExcel_Worksheet object,
* typically so that the worksheet object can be unset
*
*/
public function disconnectCells() {
$this->_cellCollection->unsetWorksheetCells();
$this->_cellCollection = null;

View File

@ -95,7 +95,7 @@ class PHPExcel_Writer_CSV implements PHPExcel_Writer_IWriter {
/**
* Save PHPExcel to file
*
* @param string $pFileName
* @param string $pFilename
* @throws Exception
*/
public function save($pFilename = null) {

View File

@ -190,7 +190,7 @@ class PHPExcel_Writer_Excel2007 implements PHPExcel_Writer_IWriter
/**
* Save PHPExcel to file
*
* @param string $pFileName
* @param string $pFilename
* @throws Exception
*/
public function save($pFilename = null)

View File

@ -109,7 +109,7 @@ class PHPExcel_Writer_Excel5 implements PHPExcel_Writer_IWriter
/**
* Save PHPExcel to file
*
* @param string $pFileName
* @param string $pFilename
* @throws Exception
*/
public function save($pFilename = null) {

View File

@ -145,7 +145,7 @@ class PHPExcel_Writer_HTML implements PHPExcel_Writer_IWriter {
/**
* Save PHPExcel to file
*
* @param string $pFileName
* @param string $pFilename
* @throws Exception
*/
public function save($pFilename = null) {
@ -189,6 +189,9 @@ class PHPExcel_Writer_HTML implements PHPExcel_Writer_IWriter {
/**
* Map VAlign
*
* @param string $vAlign Vertical alignment
* @return string
*/
private function _mapVAlign($vAlign) {
switch ($vAlign) {
@ -203,6 +206,7 @@ class PHPExcel_Writer_HTML implements PHPExcel_Writer_IWriter {
/**
* Map HAlign
*
* @param string $hAlign Horizontal alignment
* @return string|false
*/
private function _mapHAlign($hAlign) {

View File

@ -38,7 +38,7 @@ interface PHPExcel_Writer_IWriter
/**
* Save PHPExcel to file
*
* @param string $pFileName
* @param string $pFilename
* @throws Exception
*/
public function save($pFilename = null);

View File

@ -210,7 +210,7 @@ class PHPExcel_Writer_PDF extends PHPExcel_Writer_HTML implements PHPExcel_Write
/**
* Save PHPExcel to file
*
* @param string $pFileName
* @param string $pFilename Filename for the saved file
* @throws Exception
*/
public function save($pFilename = null) {