thephpleague / commonmark

src/EnvironmentInterface.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
     public function getConfig($key = null, $default = null);
 
     /**
-     * @return iterable<BlockParserInterface>
+     * @return \ArrayIterator|null
      */
     public function getBlockParsers(): iterable;
 

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\Inline\Parser\InlineParserInterface;
 use League\CommonMark\InlineParserContext;
+use League\CommonMark\Inline\Parser\InlineParserInterface;
 use League\CommonMark\Util\RegexHelper;
 
 final class QuoteParser implements InlineParserInterface

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
      * @param string $charBefore
      * @param string $charAfter
      *
-     * @return bool[]
+     * @return boolean[]
      */
     private function determineFlanking(string $charBefore, string $charAfter)
     {

src/Inline/Parser/CloseBracketParser.php

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

@@ -18,11 +18,11 @@
 use League\CommonMark\Delimiter\DelimiterInterface;
 use League\CommonMark\EnvironmentAwareInterface;
 use League\CommonMark\EnvironmentInterface;
+use League\CommonMark\InlineParserContext;
 use League\CommonMark\Inline\AdjacentTextMerger;
 use League\CommonMark\Inline\Element\AbstractWebResource;
 use League\CommonMark\Inline\Element\Image;
 use League\CommonMark\Inline\Element\Link;
-use League\CommonMark\InlineParserContext;
 use League\CommonMark\Reference\ReferenceInterface;
 use League\CommonMark\Reference\ReferenceMapInterface;
 use League\CommonMark\Util\LinkParserHelper;

src/Util/ArrayCollection.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     }
 
     /**
-     * @return mixed|false
+     * @return string
      *
      * @phpstan-return TValue|false
      */

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/TableOfContents/TableOfContentsGeneratorInterface.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
 
 interface TableOfContentsGeneratorInterface
 {
+    /**
+     * @return null|TableOfContents
+     */
     public function generate(Document $document): ?TableOfContents;
 }
 

src/Extension/Autolink/InlineMentionParser.php

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

@@ -12,9 +12,9 @@
 namespace League\CommonMark\Extension\Autolink;
 
 use League\CommonMark\Extension\Mention\MentionParser;
+use League\CommonMark\InlineParserContext;
 use League\CommonMark\Inline\Element\Link;
 use League\CommonMark\Inline\Parser\InlineParserInterface;
-use League\CommonMark\InlineParserContext;
 
 @trigger_error(sprintf('%s is deprecated; use %s instead', InlineMentionParser::class, MentionParser::class), E_USER_DEPRECATED);
 

src/Extension/Attributes/Event/AttributesListener.php

Doc Comments +6 added lines

@@ -114,6 +114,9 @@ 
         return [$target, $direction];
     }
 
+    /**
+     * @param Node $node
+     */
     private static function getPrevious(?Node $node = null): ?Node
     {
         $previous = $node instanceof Node ? $node->previous() : null;
@@ -125,6 +128,9 @@ 
         return $previous;
     }
 
+    /**
+     * @param Node $node
+     */
     private static function getNext(?Node $node = null): ?Node
     {
         $next = $node instanceof Node ? $node->next() : null;