thephpleague / commonmark

src/Input/MarkdownInputInterface.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
     public function getContent(): string;
 
     /**
-     * @return iterable<int, string>
+     * @return \Generator string>
      */
     public function getLines(): iterable;
 

src/Extension/CommonMark/Parser/Inline/CloseBracketParser.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -22,8 +22,8 @@
 use League\CommonMark\Extension\CommonMark\Node\Inline\Link;
 use League\CommonMark\Node\Inline\AdjacentTextMerger;
 use League\CommonMark\Parser\Cursor;
-use League\CommonMark\Parser\Inline\InlineParserInterface;
 use League\CommonMark\Parser\InlineParserContext;
+use League\CommonMark\Parser\Inline\InlineParserInterface;
 use League\CommonMark\Reference\ReferenceInterface;
 use League\CommonMark\Reference\ReferenceMapInterface;
 use League\CommonMark\Util\LinkParserHelper;

src/Extension/SmartPunct/QuoteParser.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -15,8 +15,8 @@
 namespace League\CommonMark\Extension\SmartPunct;
 
 use League\CommonMark\Delimiter\Delimiter;
-use League\CommonMark\Parser\Inline\InlineParserInterface;
 use League\CommonMark\Parser\InlineParserContext;
+use League\CommonMark\Parser\Inline\InlineParserInterface;
 use League\CommonMark\Util\RegexHelper;
 
 final class QuoteParser implements InlineParserInterface

src/Extension/CommonMark/Parser/Inline/BacktickParser.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -16,8 +16,8 @@
 
 use League\CommonMark\Extension\CommonMark\Node\Inline\Code;
 use League\CommonMark\Node\Inline\Text;
-use League\CommonMark\Parser\Inline\InlineParserInterface;
 use League\CommonMark\Parser\InlineParserContext;
+use League\CommonMark\Parser\Inline\InlineParserInterface;
 
 final class BacktickParser implements InlineParserInterface
 {

src/Extension/TaskList/TaskListItemMarkerParser.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -13,8 +13,8 @@
 
 use League\CommonMark\Extension\CommonMark\Node\Block\ListItem;
 use League\CommonMark\Node\Block\Paragraph;
-use League\CommonMark\Parser\Inline\InlineParserInterface;
 use League\CommonMark\Parser\InlineParserContext;
+use League\CommonMark\Parser\Inline\InlineParserInterface;
 
 final class TaskListItemMarkerParser implements InlineParserInterface
 {

src/Environment/EnvironmentInterface.php

Doc Comments +2 added lines, -1 removed lines

@@ -30,7 +30,7 @@ 
     public function getConfig(?string $key = null, $default = null);
 
     /**
-     * @return iterable<BlockStartParserInterface>
+     * @return \Traversable
      */
     public function getBlockStartParsers(): iterable;
 
@@ -55,6 +55,7 @@ 
 
     /**
      * Dispatches the given event to listeners
+     * @return void
      */
     public function dispatch(AbstractEvent $event): void;
 }

src/Node/Block/Document.php

Doc Comments +3 added lines

@@ -29,6 +29,9 @@
      */
     protected $referenceMap;
 
+    /**
+     * @param ReferenceMapInterface $referenceMap
+     */
     public function __construct(?ReferenceMapInterface $referenceMap = null)
     {
         $this->setStartLine(1);

src/Parser/Cursor.php

Doc Comments +3 added lines

@@ -141,6 +141,9 @@
         return $this->getIndent() >= self::INDENT_LEVEL;
     }
 
+    /**
+     * @param integer $index
+     */
     public function getCharacter(?int $index = null): ?string
     {
         if ($index === null) {

src/Util/ArrayCollection.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
     }
 
     /**
-     * @return mixed|false
+     * @return string
      *
      * @phpstan-return T|false
      */