Add "@ignore" tag support

Author: Kirill Nesmeyanov

README.md

@@ -43,7 +43,7 @@ composer require type-lang/phpdoc
 - [ ] `@filesource` - TODO
 - [x] `@final` - Declare any _Symbol_ as final
 - [ ] `@global` - TODO
-- [ ] `@ignore` - TODO
+- [x] `@ignore` - Used to tell documentation systems that _Symbol_ are not to be processed.
 - [x] `@implements` - Allows to extend templated interfaces
 - [ ] `@inheritdoc` - TODO
 - [x] `@inherits` - An alias of `@extends` tag

src/DocBlock/Tag/AbstractTag/AbstractTagFactory.php

@@ -11,7 +11,7 @@
 /**
  * This class is responsible for creating "`@abstract`" tags.
  *
- * See {@see AbstractTag} for details about this tag.
+ * See {@see IgnoreTag} for details about this tag.
  */
 final class AbstractTagFactory implements TagFactoryInterface
 {

src/DocBlock/Tag/IgnoreTag/IgnoreTag.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\PHPDoc\DocBlock\Tag\IgnoreTag;
+
+use TypeLang\PHPDoc\DocBlock\Tag\Tag;
+
+/**
+ * Used to tell documentation systems that _Symbol_ are not to be processed.
+ *
+ * ```
+ * "@ignore" [<description>]
+ * ```
+ */
+final class IgnoreTag extends Tag
+{
+    public function __construct(
+        string $name,
+        \Stringable|string|null $description = null,
+    ) {
+        parent::__construct($name, $description);
+    }
+}

src/DocBlock/Tag/IgnoreTag/IgnoreTagFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\PHPDoc\DocBlock\Tag\IgnoreTag;
+
+use TypeLang\PHPDoc\DocBlock\Tag\Factory\TagFactoryInterface;
+use TypeLang\PHPDoc\Parser\Content\Stream;
+use TypeLang\PHPDoc\Parser\Description\DescriptionParserInterface;
+
+/**
+ * This class is responsible for creating "`@ignore`" tags.
+ *
+ * See {@see IgnoreTag} for details about this tag.
+ */
+final class IgnoreTagFactory implements TagFactoryInterface
+{
+    public function create(string $tag, string $content, DescriptionParserInterface $descriptions): IgnoreTag
+    {
+        $stream = new Stream($tag, $content);
+
+        return new IgnoreTag(
+            name: $tag,
+            description: $stream->toOptionalDescription($descriptions),
+        );
+    }
+}

src/Platform/StandardPlatform.php

@@ -8,6 +8,7 @@
 use TypeLang\PHPDoc\DocBlock\Tag\AbstractTag\AbstractTagFactory;
 use TypeLang\PHPDoc\DocBlock\Tag\Factory\TagFactoryInterface;
 use TypeLang\PHPDoc\DocBlock\Tag\FinalTag\FinalTagFactory;
+use TypeLang\PHPDoc\DocBlock\Tag\IgnoreTag\IgnoreTagFactory;
 use TypeLang\PHPDoc\DocBlock\Tag\LinkTag\LinkTagFactory;
 use TypeLang\PHPDoc\DocBlock\Tag\MethodTag\MethodTagFactory;
 use TypeLang\PHPDoc\DocBlock\Tag\ParamTag\ParamTagFactory;
@@ -37,6 +38,7 @@ protected function load(TypesParserInterface $types): iterable
         yield 'extends' => new TemplateExtendsTagFactory($types);
         yield 'final' => new FinalTagFactory();
         yield 'implements' => new TemplateImplementsTagFactory($types);
+        yield 'ignore' => new IgnoreTagFactory();
         yield 'link' => new LinkTagFactory();
         yield 'method' => new MethodTagFactory($types);
         yield 'param' => new ParamTagFactory($types);