PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Writer/Excel2007/Style.php

Doc Comments +1 added lines, -1 removed lines

@@ -565,7 +565,7 @@
     /**
      * Get an array of all styles
      *
-     * @param     PHPExcel                $pPHPExcel
+     * @param     \PHPExcel\Spreadsheet                $pPHPExcel
      * @return     PHPExcel_Style[]        All styles in PHPExcel
      * @throws     \PHPExcel\Writer\Exception
      */

src/PhpSpreadsheet/Writer/Excel2007/Workbook.php

Doc Comments +4 added lines, -4 removed lines

@@ -122,7 +122,7 @@ 
      * Write BookViews
      *
      * @param     \PHPExcel\Shared\XMLWriter     $objWriter         XML Writer
-     * @param     PHPExcel                    $pPHPExcel
+     * @param     \PHPExcel\Spreadsheet                    $pPHPExcel
      * @throws     \PHPExcel\Writer\Exception
      */
     private function writeBookViews(\PHPExcel\Shared\XMLWriter $objWriter, \PHPExcel\SpreadSheet $pPHPExcel = null)
@@ -152,7 +152,7 @@ 
      * Write WorkbookProtection
      *
      * @param     \PHPExcel\Shared\XMLWriter     $objWriter         XML Writer
-     * @param     PHPExcel                    $pPHPExcel
+     * @param     \PHPExcel\Spreadsheet                    $pPHPExcel
      * @throws     \PHPExcel\Writer\Exception
      */
     private function writeWorkbookProtection(\PHPExcel\Shared\XMLWriter $objWriter, \PHPExcel\SpreadSheet $pPHPExcel = null)
@@ -202,7 +202,7 @@ 
      * Write sheets
      *
      * @param     \PHPExcel\Shared\XMLWriter     $objWriter         XML Writer
-     * @param     PHPExcel                    $pPHPExcel
+     * @param     \PHPExcel\Spreadsheet                    $pPHPExcel
      * @throws     \PHPExcel\Writer\Exception
      */
     private function writeSheets(\PHPExcel\Shared\XMLWriter $objWriter, \PHPExcel\SpreadSheet $pPHPExcel = null)
@@ -255,7 +255,7 @@ 
      * Write Defined Names
      *
      * @param     \PHPExcel\Shared\XMLWriter    $objWriter         XML Writer
-     * @param     PHPExcel                    $pPHPExcel
+     * @param     \PHPExcel\Spreadsheet                    $pPHPExcel
      * @throws     \PHPExcel\Writer\Exception
      */
     private function writeDefinedNames(\PHPExcel\Shared\XMLWriter $objWriter, \PHPExcel\SpreadSheet $pPHPExcel = null)

src/PhpSpreadsheet/Writer/Excel5/Escher.php

Doc Comments +1 added lines

@@ -67,6 +67,7 @@
 
     /**
      * Process the object to be written
+     * @return string
      */
     public function close()
     {

src/PhpSpreadsheet/Writer/Excel5/Parser.php

Doc Comments +9 added lines, -9 removed lines

@@ -504,7 +504,7 @@ 
      *
      * @access private
      * @param mixed $token The token to convert.
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convert($token)
     {
@@ -574,7 +574,7 @@ 
      *
      * @access private
      * @param string $string A string for conversion to its ptg value.
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convertString($string)
     {
@@ -654,7 +654,7 @@ 
      *
      * @access private
      * @param string $token An Excel range in the Sheet1!A1:A2 format.
-     * @return mixed The packed ptgArea3d token on success.
+     * @return string The packed ptgArea3d token on success.
      */
     private function convertRange3d($token)
     {
@@ -726,7 +726,7 @@ 
      *
      * @access private
      * @param string $cell An Excel cell reference
-     * @return mixed The packed ptgRef3d token on success.
+     * @return string The packed ptgRef3d token on success.
      */
     private function convertRef3d($cell)
     {
@@ -834,7 +834,7 @@ 
      *
      * @access private
      * @param string $ext_ref The name of the external reference
-     * @return mixed The reference index in packed() format on success
+     * @return string The reference index in packed() format on success
      */
     private function getRefIndex($ext_ref)
     {
@@ -925,7 +925,7 @@ 
      *
      * @access private
      * @param string $cell The Excel cell reference to be packed
-     * @return array Array containing the row and column in packed() format
+     * @return string[] Array containing the row and column in packed() format
      */
     private function cellToPackedRowcol($cell)
     {
@@ -954,7 +954,7 @@ 
      *
      * @access private
      * @param string $range The Excel range to be packed
-     * @return array Array containing (row1,col1,row2,col2) in packed() format
+     * @return string[] Array containing (row1,col1,row2,col2) in packed() format
      */
     private function rangeToPackedRange($range)
     {
@@ -1075,7 +1075,7 @@ 
      * Checks if it's a valid token.
      *
      * @access private
-     * @param mixed $token The token to check.
+     * @param string $token The token to check.
      * @return mixed       The checked token or false on failure
      */
     private function match($token)
@@ -1157,7 +1157,7 @@ 
      * @access public
      * @param string $formula The formula to parse, without the initial equal
      *                        sign (=).
-     * @return mixed true on success
+     * @return boolean true on success
      */
     public function parse($formula)
     {

src/PhpSpreadsheet/Writer/Excel5/Workbook.php

Doc Comments +4 added lines, -2 removed lines

@@ -192,7 +192,9 @@ 
      * @param int        &$str_unique    Total number of unique strings
      * @param array        &$str_table        String Table
      * @param array        &$colors        Colour Table
-     * @param mixed        $parser            The formula parser created for the Workbook
+     * @param Parser        $parser            The formula parser created for the Workbook
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(\PHPExcel\Spreadsheet $phpExcel, &$str_total, &$str_unique, &$str_table, &$colors, $parser)
     {
@@ -792,7 +794,7 @@ 
      *
      * @param    string        $name            The name in UTF-8
      * @param    string        $formulaData    The binary formula data
-     * @param    string        $sheetIndex        1-based sheet index the defined name applies to. 0 = global
+     * @param    integer        $sheetIndex        1-based sheet index the defined name applies to. 0 = global
      * @param    boolean        $isBuiltIn        Built-in name?
      * @return    string    Complete binary record data
      */

src/PhpSpreadsheet/Writer/Excel5/Worksheet.php

Doc Comments +10 added lines, -8 removed lines

@@ -200,10 +200,12 @@ 
      * @param int        &$str_unique    Total number of unique strings
      * @param array        &$str_table        String Table
      * @param array        &$colors        Colour Table
-     * @param mixed        $parser            The formula parser created for the Workbook
+     * @param Parser        $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
      * @param \PHPExcel\Worksheet $phpSheet
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet)
     {
@@ -614,7 +616,7 @@ 
      * @param integer $row    Zero indexed row
      * @param integer $col    Zero indexed column
      * @param float   $num    The number to write
-     * @param mixed   $xfIndex The optional XF format
+     * @param integer   $xfIndex The optional XF format
      * @return integer
      */
     private function writeNumber($row, $col, $num, $xfIndex)
@@ -652,7 +654,7 @@ 
      * @param int $row Row index (0-based)
      * @param int $col Column index (0-based)
      * @param string $str The string
-     * @param mixed   $xfIndex The XF format index for the cell
+     * @param integer   $xfIndex The XF format index for the cell
      * @param array $arrcRun Index to Font record and characters beginning
      */
     private function writeRichTextString($row, $col, $str, $xfIndex, $arrcRun)
@@ -720,7 +722,7 @@ 
      * @param integer $row    Zero indexed row
      * @param integer $col    Zero indexed column
      * @param string  $str    The string to write
-     * @param mixed   $xfIndex The XF format index for the cell
+     * @param integer   $xfIndex The XF format index for the cell
      * @return integer
      */
     private function writeLabelSst($row, $col, $str, $xfIndex)
@@ -785,7 +787,7 @@ 
      *
      * @param integer $row    Zero indexed row
      * @param integer $col    Zero indexed column
-     * @param mixed   $xfIndex The XF format index
+     * @param integer   $xfIndex The XF format index
      */
     public function writeBlank($row, $col, $xfIndex)
     {
@@ -830,7 +832,7 @@ 
      * @param integer $row     Zero indexed row
      * @param integer $col     Zero indexed column
      * @param string  $formula The formula text string
-     * @param mixed   $xfIndex  The XF format index
+     * @param integer   $xfIndex  The XF format index
      * @param mixed   $calculatedValue  Calculated value
      * @return integer
      */
@@ -2307,8 +2309,8 @@ 
      * @param mixed   $bitmap  The bitmap filename or GD-image resource
      * @param integer $x       The horizontal position (offset) of the image inside the cell.
      * @param integer $y       The vertical position (offset) of the image inside the cell.
-     * @param float   $scale_x The horizontal scale
-     * @param float   $scale_y The vertical scale
+     * @param integer   $scale_x The horizontal scale
+     * @param integer   $scale_y The vertical scale
      */
     public function insertBitmap($row, $col, $bitmap, $x = 0, $y = 0, $scale_x = 1, $scale_y = 1)
     {

src/PhpSpreadsheet/Writer/HTML.php

Doc Comments +5 added lines, -5 removed lines

@@ -135,7 +135,7 @@ 
     /**
      * Create a new PHPExcel_Writer_HTML
      *
-     * @param    PHPExcel    $phpExcel    PHPExcel object
+     * @param    Spreadsheet    $phpExcel    PHPExcel object
      */
     public function __construct(Spreadsheet $phpExcel)
     {
@@ -1419,7 +1419,7 @@ 
      * Set images root
      *
      * @param string $pValue
-     * @return PHPExcel_Writer_HTML
+     * @return HTML
      */
     public function setImagesRoot($pValue = '.')
     {
@@ -1440,8 +1440,8 @@ 
     /**
      * Set embed images
      *
-     * @param boolean $pValue
-     * @return PHPExcel_Writer_HTML
+     * @param string|boolean $pValue
+     * @return HTML
      */
     public function setEmbedImages($pValue = '.')
     {
@@ -1463,7 +1463,7 @@ 
      * Set use inline CSS?
      *
      * @param boolean $pValue
-     * @return PHPExcel_Writer_HTML
+     * @return HTML
      */
     public function setUseInlineCss($pValue = false)
     {

src/PhpSpreadsheet/Writer/OpenDocument.php

Doc Comments +3 added lines, -3 removed lines

@@ -71,7 +71,7 @@ 
      * Get writer part
      *
      * @param  string  $pPartName  Writer part name
-     * @return \PHPExcel\Writer\Excel2007\WriterPart
+     * @return PHPExcel_Writer_OpenDocument_WriterPart|null
      */
     public function getWriterPart($pPartName = '')
     {
@@ -180,9 +180,9 @@ 
     /**
      * Set PHPExcel object
      *
-     * @param  PHPExcel  $pPHPExcel  PHPExcel object
+     * @param  \PHPExcel\Spreadsheet  $pPHPExcel  PHPExcel object
      * @throws \PHPExcel\Writer\Exception
-     * @return PHPExcel_Writer_Excel2007
+     * @return OpenDocument
      */
     public function setPHPExcel(\PHPExcel\SpreadSheet $pPHPExcel = null)
     {

src/PhpSpreadsheet/Writer/OpenDocument/Content.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
     /**
      * Write content.xml to XML format
      *
-     * @param   PHPExcel                   $pPHPExcel
+     * @param   \PHPExcel\Spreadsheet                   $pPHPExcel
      * @return  string                     XML Output
      * @throws  \PHPExcel\Writer\Exception
      */