added/fixed some PHPDoc

dompdf · Nov 11, 2018 · aacedb7 · aacedb7
1 parent dc68bcb
commit aacedb7
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/src/Adapter/PDFLib.php b/src/Adapter/PDFLib.php
@@ -88,7 +88,7 @@ class PDFLib implements Canvas
     /**
      * Instance of PDFLib class
      *
-     * @var \PDFlib
+     * @var \PDFLib
      */
     private $_pdf;
 
@@ -200,7 +200,7 @@ class PDFLib implements Canvas
     /**
      * Class constructor
      *
-     * @param mixed  $paper       The size of paper to use either a string (see {@link Dompdf\Adapter\CPDF::$PAPER_SIZES}) or
+     * @param string|array $paper The size of paper to use either a string (see {@link Dompdf\Adapter\CPDF::$PAPER_SIZES}) or
      *                            an array(xmin,ymin,xmax,ymax)
      * @param string $orientation The orientation of the document (either 'landscape' or 'portrait')
      * @param Dompdf $dompdf

diff --git a/src/Css/Stylesheet.php b/src/Css/Stylesheet.php
@@ -445,7 +445,7 @@ private function _specificity($selector, $origin = self::ORIG_AUTHOR)
      * @param bool $first_pass
      *
      * @throws Exception
-     * @return string
+     * @return array
      */
     private function _css_selector_to_xpath($selector, $first_pass = false)
     {

diff --git a/src/Dompdf.php b/src/Dompdf.php
@@ -107,7 +107,7 @@ class Dompdf
     /**
      * Desired paper size ('letter', 'legal', 'A4', etc.)
      *
-     * @var string
+     * @var string|array
      */
     private $paperSize;
 
@@ -397,8 +397,8 @@ public function loadHtmlFile($file)
     }
 
     /**
-     * @param $str
-     * @param null $encoding
+     * @param string $str
+     * @param string $encoding
      * @deprecated
      */
     public function load_html($str, $encoding = 'UTF-8')
@@ -1030,7 +1030,7 @@ public function set_paper($size, $orientation = "portrait")
     /**
      * Sets the paper size & orientation
      *
-     * @param string $size 'letter', 'legal', 'A4', etc. {@link Dompdf\Adapter\CPDF::$PAPER_SIZES}
+     * @param string|array $size 'letter', 'legal', 'A4', etc. {@link Dompdf\Adapter\CPDF::$PAPER_SIZES}
      * @param string $orientation 'portrait' or 'landscape'
      * @return $this
      */

diff --git a/src/FrameDecorator/AbstractFrameDecorator.php b/src/FrameDecorator/AbstractFrameDecorator.php
@@ -438,6 +438,7 @@ function remove_child(Frame $child, $update_node = true)
     }
 
     /**
+     * @param bool $use_cache
      * @return AbstractFrameDecorator
      */
     function get_parent($use_cache = true)

diff --git a/src/Helpers.php b/src/Helpers.php
@@ -583,6 +583,7 @@ public static function cmyk_to_rgb($c, $m = null, $y = null, $k = null)
      * getimagesize doesn't give a good size for 32bit BMP image v5
      *
      * @param string $filename
+     * @param resource $context
      * @return array The same format as getimagesize($filename)
      */
     public static function dompdf_getimagesize($filename, $context = null)