PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Reader/HTML.php

Doc Comments +7 added lines, -1 removed lines

@@ -135,7 +135,7 @@ 
      * Loads PhpSpreadsheet from file
      *
      * @param  string                    $pFilename
-     * @return PhpSpreadsheet
+     * @return \PhpSpreadsheet\Spreadsheet
      * @throws Exception
      */
     public function load($pFilename)
@@ -217,6 +217,12 @@ 
         $cellContent = (string) '';
     }
 
+    /**
+     * @param \PhpSpreadsheet\Worksheet $sheet
+     * @param integer $row
+     * @param string $column
+     * @param string $cellContent
+     */
     protected function processDomElement(DOMNode $element, $sheet, &$row, &$column, &$cellContent, $format = null)
     {
         foreach ($element->childNodes as $child) {

src/PhpSpreadsheet/Shared/Font.php

Doc Comments +3 added lines, -2 removed lines

@@ -237,7 +237,7 @@ 
      * Calculate an (approximate) OpenXML column width, based on font size and text contained
      *
      * @param     \PhpSpreadsheet\Style\Font            $font            Font object
-     * @param     \PhpSpreadsheet\RichText|string    $cellText        Text to calculate width
+     * @param     string    $cellText        Text to calculate width
      * @param     integer                        $rotation        Rotation angle
      * @param     \PhpSpreadsheet\Style\Font|NULL    $defaultFont    Font object
      * @return     integer        Column width
@@ -406,7 +406,7 @@ 
      * Calculate an (approximate) pixel size, based on centimeter size
      *
      * @param     int        $sizeInCm    Font size (in centimeters)
-     * @return     int        Size (in pixels)
+     * @return     double        Size (in pixels)
      */
     public static function centimeterSizeToPixels($sizeInCm = 1)
     {
@@ -417,6 +417,7 @@ 
      * Returns the font path given the font
      *
      * @param \PhpSpreadsheet\Style\Font
+     * @param \PhpSpreadsheet\Style\Font $font
      * @return string Path to TrueType font file
      */
     public static function getTrueTypeFontFileFromFont($font)

src/PhpSpreadsheet/Spreadsheet.php

Doc Comments +11 added lines, -10 removed lines

@@ -136,7 +136,7 @@ 
     /**
     * The workbook has macros ?
     *
-    * @return true if workbook has macros, false if not
+    * @return boolean if workbook has macros, false if not
     */
     public function hasMacros()
     {
@@ -177,7 +177,7 @@ 
     /**
     * Set the macros certificate
     *
-    * @param string|null $Certificate
+    * @param string|null $certificate
     */
     public function setMacrosCertificate($certificate = null)
     {
@@ -232,6 +232,7 @@ 
     * retrieve ribbon XML Data
     *
     * return string|null|array
+    * @return string
     */
     public function getRibbonXMLData($what = 'all') //we need some constants here...
     {
@@ -307,7 +308,7 @@ 
     /**
     * This workbook have a custom UI ?
     *
-    * @return true|false
+    * @return boolean
     */
     public function hasRibbon()
     {
@@ -317,7 +318,7 @@ 
     /**
     * This workbook have additionnal object for the ribbon ?
     *
-    * @return true|false
+    * @return boolean
     */
     public function hasRibbonBinObjects()
     {
@@ -615,7 +616,7 @@ 
      * Get index for sheet
      *
      * @param  Worksheet $pSheet
-     * @return Sheet index
+     * @return integer index
      * @throws Exception
      */
     public function getIndex(Worksheet $pSheet)
@@ -634,7 +635,7 @@ 
      *
      * @param  string $sheetName Sheet name to modify index for
      * @param  int $newIndex New index for the sheet
-     * @return New sheet index
+     * @return integer sheet index
      * @throws Exception
      */
     public function setIndexByName($sheetName, $newIndex)
@@ -776,7 +777,7 @@ 
      * Add named range
      *
      * @param  NamedRange $namedRange
-     * @return PhpSpreadsheet
+     * @return boolean
      */
     public function addNamedRange(NamedRange $namedRange)
     {
@@ -821,7 +822,7 @@ 
      *
      * @param  string  $namedRange
      * @param  Worksheet|null  $pSheet  Scope: use null for global scope.
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function removeNamedRange($namedRange, Worksheet $pSheet = null)
     {
@@ -840,7 +841,7 @@ 
     /**
      * Get worksheet iterator
      *
-     * @return WorksheetIterator
+     * @return Worksheet\Iterator
      */
     public function getWorksheetIterator()
     {
@@ -850,7 +851,7 @@ 
     /**
      * Copy workbook (!= clone!)
      *
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function copy()
     {

src/PhpSpreadsheet/Style.php

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
     /**
      * Get parent. Only used for style supervisor
      *
-     * @return PhpSpreadsheet
+     * @return Style
      */
     public function getParent()
     {

src/PhpSpreadsheet/Worksheet.php

Doc Comments +16 added lines, -16 removed lines

@@ -328,7 +328,7 @@ 
     /**
      * Create a new worksheet
      *
-     * @param Spreadsheet        $Parent
+     * @param Spreadsheet        $parent
      * @param string        $pTitle
      */
     public function __construct(Spreadsheet $parent = null, $pTitle = 'Worksheet')
@@ -585,7 +585,7 @@ 
      * Get a chart by its index position
      *
      * @param string $index Chart index position
-     * @return false|Chart
+     * @return null|Chart
      * @throws Exception
      */
     public function getChartByIndex($index = null)
@@ -767,7 +767,7 @@ 
     /**
      * Get parent
      *
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function getParent()
     {
@@ -1077,7 +1077,7 @@ 
      * Set a cell value
      *
      * @param string $pCoordinate Coordinate of the cell
-     * @param mixed $pValue Value of the cell
+     * @param integer $pValue Value of the cell
      * @param bool $returnCell   Return the worksheet (false, default) or the cell (true)
      * @return Worksheet|Cell    Depending on the last parameter being specified
      */
@@ -1090,8 +1090,8 @@ 
     /**
      * Set a cell value by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell (A = 0)
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell (A = 0)
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param mixed $pValue Value of the cell
      * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
      * @return Worksheet|Cell    Depending on the last parameter being specified
@@ -1121,8 +1121,8 @@ 
     /**
      * Set a cell value by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param mixed $pValue Value of the cell
      * @param string $pDataType Explicit data type
      * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
@@ -1182,8 +1182,8 @@ 
     /**
      * Get cell at a specific coordinate by using numeric cell coordinates
      *
-     * @param  string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param  integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param boolean $createIfNotExists  Flag indicating whether a new cell should be created if it doesn't
      *                                       already exist, or a null should be returned instead
      * @return null|Cell Cell that was found/created or null
@@ -1290,8 +1290,8 @@ 
     /**
      * Cell at a specific coordinate by using numeric cell coordinates exists?
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @return boolean
      */
     public function cellExistsByColumnAndRow($pColumn = 0, $pRow = 1)
@@ -1350,7 +1350,7 @@ 
     /**
      * Get column dimension at a specific column by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
      * @return Worksheet\ColumnDimension
      */
     public function getColumnDimensionByColumn($pColumn = 0)
@@ -1471,7 +1471,7 @@ 
     /**
      * Set conditional styles
      *
-     * @param $pCoordinate string E.g. 'A1'
+     * @param string $pCoordinate string E.g. 'A1'
      * @param $pValue Style\Conditional[]
      * @return Worksheet
      */
@@ -1892,7 +1892,7 @@ 
     /**
      *    Set AutoFilter
      *
-     *    @param    Worksheet\AutoFilter|string   $pValue
+     *    @param    string   $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *    @throws Exception
      *    @return Worksheet
@@ -2902,7 +2902,7 @@ 
      * Define the code name of the sheet
      *
      * @param null|string Same rule as Title minus space not allowed (but, like Excel, change silently space to underscore)
-     * @return objWorksheet
+     * @return Worksheet
      * @throws Exception
     */
     public function setCodeName($pValue = null)

src/PhpSpreadsheet/Worksheet/AutoFilter/Column/Rule.php

Doc Comments +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
      *
      *    @param   string        $pRuleType
      *    @throws  \PhpSpreadsheet\Exception
-     *    @return  \PhpSpreadsheet\Worksheet\AutoFilter\Column
+     *    @return  Rule
      */
     public function setRuleType($pRuleType = self::AUTOFILTER_RULETYPE_FILTER)
     {

src/PhpSpreadsheet/Worksheet/ColumnCellIterator.php

Doc Comments +1 added lines, -1 removed lines

@@ -135,7 +135,7 @@
     /**
      * Return the current cell in this worksheet column
      *
-     * @return Row
+     * @return null|\PhpSpreadsheet\Cell
      */
     public function current()
     {

src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php

Doc Comments +1 added lines, -1 removed lines

@@ -229,7 +229,7 @@
     /**
      * Set Color
      *
-     * @param    \PhpSpreadsheet\Style_Color $pValue
+     * @param    \PhpSpreadsheet\Style\Color $pValue
      * @throws   \PhpSpreadsheet\Exception
      * @return   Shadow
      */

src/PhpSpreadsheet/Writer/CSV.php

Doc Comments +1 added lines, -1 removed lines

@@ -311,7 +311,7 @@
     /**
      * Write line to CSV file
      *
-     * @param    mixed    $pFileHandle    PHP filehandle
+     * @param    resource    $pFileHandle    PHP filehandle
      * @param    array    $pValues        Array containing values in a row
      * @throws    Exception
      */