Merge pull request #294 from oliverklee/task/types-commentable

Author: sabberworm

src/CSSList/CSSList.php

@@ -32,7 +32,7 @@
 abstract class CSSList implements Renderable, Commentable
 {
     /**
-     * @var array<array-key, Comment> $aComments
+     * @var array<array-key, Comment>
      */
     protected $aComments;
 
@@ -57,10 +57,10 @@ public function __construct($iLineNo = 0)
     }
 
     /**
-     * @throws SourceException
-     * @throws UnexpectedTokenException
-     *
      * @return void
+     *
+     * @throws UnexpectedTokenException
+     * @throws SourceException
      */
     public static function parseList(ParserState $oParserState, CSSList $oList)
     {
@@ -451,6 +451,8 @@ public function getContents()
 
     /**
      * @param array<array-key, Comment> $aComments
+     *
+     * @return void
      */
     public function addComments(array $aComments)
     {
@@ -467,6 +469,8 @@ public function getComments()
 
     /**
      * @param array<array-key, Comment> $aComments
+     *
+     * @return void
      */
     public function setComments(array $aComments)
     {

src/Comment/Commentable.php

@@ -5,17 +5,21 @@
 interface Commentable
 {
     /**
-     * @param array $aComments Array of comments.
+     * @param array<array-key, Comment> $aComments
+     *
+     * @return void
      */
     public function addComments(array $aComments);
 
     /**
-     * @return array
+     * @return array<array-key, Comment>
      */
     public function getComments();
 
     /**
-     * @param array $aComments Array containing Comment objects.
+     * @param array<array-key, Comment> $aComments
+     *
+     * @return void
      */
     public function setComments(array $aComments);
 }

src/Property/CSSNamespace.php

@@ -2,6 +2,7 @@
 
 namespace Sabberworm\CSS\Property;
 
+use Sabberworm\CSS\Comment\Comment;
 use Sabberworm\CSS\OutputFormat;
 
 /**
@@ -15,6 +16,9 @@ class CSSNamespace implements AtRule
 
     private $iLineNo;
 
+    /**
+     * @var array<array-key, Comment>
+     */
     protected $aComments;
 
     public function __construct($mUrl, $sPrefix = null, $iLineNo = 0)
@@ -89,16 +93,29 @@ public function atRuleArgs()
         return $aResult;
     }
 
+    /**
+     * @param array<array-key, Comment> $aComments
+     *
+     * @return void
+     */
     public function addComments(array $aComments)
     {
         $this->aComments = array_merge($this->aComments, $aComments);
     }
 
+    /**
+     * @return array<array-key, Comment>
+     */
     public function getComments()
     {
         return $this->aComments;
     }
 
+    /**
+     * @param array<array-key, Comment> $aComments
+     *
+     * @return void
+     */
     public function setComments(array $aComments)
     {
         $this->aComments = $aComments;

src/Property/Import.php

@@ -2,6 +2,7 @@
 
 namespace Sabberworm\CSS\Property;
 
+use Sabberworm\CSS\Comment\Comment;
 use Sabberworm\CSS\OutputFormat;
 use Sabberworm\CSS\Value\URL;
 
@@ -26,7 +27,7 @@ class Import implements AtRule
     protected $iLineNo;
 
     /**
-     * @var array
+     * @var array<array-key, Comment>
      */
     protected $aComments;
 
@@ -97,16 +98,29 @@ public function atRuleArgs()
         return $aResult;
     }
 
+    /**
+     * @param array<array-key, Comment> $aComments
+     *
+     * @return void
+     */
     public function addComments(array $aComments)
     {
         $this->aComments = array_merge($this->aComments, $aComments);
     }
 
+    /**
+     * @return array<array-key, Comment>
+     */
     public function getComments()
     {
         return $this->aComments;
     }
 
+    /**
+     * @param array<array-key, Comment> $aComments
+     *
+     * @return void
+     */
     public function setComments(array $aComments)
     {
         $this->aComments = $aComments;

src/Property/Selector.php

@@ -60,15 +60,30 @@ class Selector
 	)$
 	/ux';
 
+    /**
+     * @var string
+     */
     private $sSelector;
 
+    /**
+     * @var int|null
+     */
     private $iSpecificity;
 
+    /**
+     * @param string $sSelector
+     *
+     * @return bool
+     */
     public static function isValid($sSelector)
     {
         return preg_match(static::SELECTOR_VALIDATION_RX, $sSelector);
     }
 
+    /**
+     * @param string $sSelector
+     * @param bool $bCalculateSpecificity
+     */
     public function __construct($sSelector, $bCalculateSpecificity = false)
     {
         $this->setSelector($sSelector);
@@ -77,22 +92,36 @@ public function __construct($sSelector, $bCalculateSpecificity = false)
         }
     }
 
+    /**
+     * @return string
+     */
     public function getSelector()
     {
         return $this->sSelector;
     }
 
+    /**
+     * @param string $sSelector
+     *
+     * @return void
+     */
     public function setSelector($sSelector)
     {
         $this->sSelector = trim($sSelector);
         $this->iSpecificity = null;
     }
 
+    /**
+     * @return string
+     */
     public function __toString()
     {
         return $this->getSelector();
     }
 
+    /**
+     * @return int
+     */
     public function getSpecificity()
     {
         if ($this->iSpecificity === null) {

src/RuleSet/RuleSet.php

@@ -2,6 +2,7 @@
 
 namespace Sabberworm\CSS\RuleSet;
 
+use Sabberworm\CSS\Comment\Comment;
 use Sabberworm\CSS\Comment\Commentable;
 use Sabberworm\CSS\OutputFormat;
 use Sabberworm\CSS\Parsing\ParserState;
@@ -19,6 +20,9 @@ abstract class RuleSet implements Renderable, Commentable
 
     protected $iLineNo;
 
+    /**
+     * @var array<array-key, Comment>
+     */
     protected $aComments;
 
     public function __construct($iLineNo = 0)
@@ -265,23 +269,27 @@ public function render(OutputFormat $oOutputFormat)
     }
 
     /**
-     * @param array $aComments Array of comments.
+     * @param array<array-key, Comment> $aComments
+     *
+     * @return void
      */
     public function addComments(array $aComments)
     {
         $this->aComments = array_merge($this->aComments, $aComments);
     }
 
     /**
-     * @return array
+     * @return array<array-key, Comment>
      */
     public function getComments()
     {
         return $this->aComments;
     }
 
     /**
-     * @param array $aComments Array containing Comment objects.
+     * @param array<array-key, Comment> $aComments
+     *
+     * @return void
      */
     public function setComments(array $aComments)
     {