PHPOffice / PhpSpreadsheet

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/Thumbnails.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     /**
      * Write Thumbnails/thumbnail.png to PNG format
      *
-     * @param   PHPExcel                   $pPHPExcel
+     * @param   \PHPExcel\Spreadsheet                   $pPHPExcel
      * @return  string                     XML Output
      * @throws  \PHPExcel\Writer\Exception
      */

src/PhpSpreadsheet/Writer/PDF/Core.php

Doc Comments +3 added lines, -3 removed lines

@@ -256,7 +256,7 @@ 
      *  Set Paper Size
      *
      *  @param  string  $pValue Paper size
-     *  @return PHPExcel_Writer_PDF
+     *  @return Core
      */
     public function setPaperSize($pValue = \PHPExcel\Worksheet\PageSetup::PAPERSIZE_LETTER)
     {
@@ -278,7 +278,7 @@ 
      *  Set Orientation
      *
      *  @param string $pValue  Page orientation
-     *  @return PHPExcel_Writer_PDF
+     *  @return Core
      */
     public function setOrientation($pValue = \PHPExcel\Worksheet\PageSetup::ORIENTATION_DEFAULT)
     {
@@ -301,7 +301,7 @@ 
      *
      *  @param     string        $pValue        Temporary storage directory
      *  @throws    \PHPExcel\Writer\Exception    when directory does not exist
-     *  @return    PHPExcel_Writer_PDF
+     *  @return    Core
      */
     public function setTempDir($pValue = '')
     {

src/PhpSpreadsheet/Shared/Date.php

Doc Comments +6 added lines, -8 removed lines

@@ -112,7 +112,7 @@ 
     /**
      * Set the Default timezone to use for dates
      *
-     * @param     string|\DateTimeZone    $timezone    The timezone to set for all Excel datetimestamp to PHP DateTime Object conversions
+     * @param     string|\DateTimeZone    $timeZone    The timezone to set for all Excel datetimestamp to PHP DateTime Object conversions
      * @return    boolean                              Success or failure
      * @throws    \Exception
      */
@@ -141,7 +141,7 @@ 
     /**
      * Validate a timezone
      *
-     * @param     string|\DateTimeZone    $timezone    The timezone to validate, either as a timezone string or object
+     * @param     string|\DateTimeZone    $timeZone    The timezone to validate, either as a timezone string or object
      * @return    \DateTimeZone                        The timezone as a timezone object
      * @throws    \Exception
      */
@@ -158,8 +158,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a PHP Date/Time object
      *
-     * @param     integer|float    $dateValue        Excel date/time value
-     * @param     \DateTimeZone|string|null          $timezone            The timezone to assume for the Excel timestamp,
+     * @param     \DateTimeZone|string|null          $timeZone            The timezone to assume for the Excel timestamp,
      *                                                                        if you don't want to treat it as a UTC value
      * @return    \DateTime                          PHP date/time object
      * @throws    \Exception
@@ -189,8 +188,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a unix timestamp
      *
-     * @param     integer|float    $dateValue        Excel date/time value
-     * @return    integer                            Unix timetamp for this date/time
+     * @return    string                            Unix timetamp for this date/time
      * @throws    \Exception
      */
     public static function excelToTimestamp($excelTimestamp = 0, $timeZone = null)
@@ -203,7 +201,7 @@ 
     /**
      *    Convert a date from PHP to Excel
      *
-     *    @param    mixed        $dateValue            PHP serialized date/time or date object
+     *    @param    integer        $dateValue            PHP serialized date/time or date object
      *    @param    boolean        $adjustToTimezone    Flag indicating whether $dateValue should be treated as
      *                                                    a UST timestamp, or adjusted to UST
      *    @param    string         $timezone            The timezone for finding the adjustment from UST
@@ -244,7 +242,7 @@ 
      * @param    integer    $hours
      * @param    integer    $minutes
      * @param    integer    $seconds
-     * @return   integer    Excel date/time value
+     * @return   double    Excel date/time value
      */
     public static function formattedPHPToExcel($year, $month, $day, $hours = 0, $minutes = 0, $seconds = 0)
     {

src/PhpSpreadsheet/Style/Fill.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
     /**
      * Set Row Height
      *
-     * @param double $pValue
+     * @param integer $pValue
      * @return RowDimension
      */
     public function setRowHeight($pValue = -1)

src/PhpSpreadsheet/Style/Font.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
     /**
      * Set Row Height
      *
-     * @param double $pValue
+     * @param integer $pValue
      * @return RowDimension
      */
     public function setRowHeight($pValue = -1)