From 082c811880e2dab6f3b44f8331e5e093076d5ca3 Mon Sep 17 00:00:00 2001 From: TomasVotruba Date: Mon, 27 Nov 2017 00:40:48 +0100 Subject: [PATCH] remove unused docblocks --- src/DocBlock.php | 3 --- src/DocBlock/DescriptionFactory.php | 2 -- src/DocBlock/ExampleFinder.php | 2 -- src/DocBlock/StandardTagFactory.php | 2 -- src/DocBlock/Tags/Covers.php | 1 - src/DocBlock/Tags/Deprecated.php | 1 - src/DocBlock/Tags/Formatter.php | 2 -- src/DocBlock/Tags/Param.php | 2 -- src/DocBlock/Tags/Property.php | 1 - src/DocBlock/Tags/PropertyRead.php | 1 - src/DocBlock/Tags/PropertyWrite.php | 1 - src/DocBlock/Tags/See.php | 1 - src/DocBlock/Tags/Throws.php | 1 - src/DocBlock/Tags/Uses.php | 1 - src/DocBlock/Tags/Var_.php | 1 - src/DocBlockFactory.php | 2 -- src/DocBlockFactoryInterface.php | 2 -- 17 files changed, 26 deletions(-) diff --git a/src/DocBlock.php b/src/DocBlock.php index ca7ab88..ff2e4b7 100644 --- a/src/DocBlock.php +++ b/src/DocBlock.php @@ -83,7 +83,6 @@ final class DocBlock /** * Returns the current context. - * */ public function getContext(): Types\Context { @@ -116,7 +115,6 @@ final class DocBlock * elements that follow until another DocBlock is found that contains the closing marker (`#@-`). * * @see self::isTemplateEnd() for the check whether a closing marker was provided. - * */ public function isTemplateStart(): bool { @@ -127,7 +125,6 @@ final class DocBlock * Returns whether this DocBlock is the end of a Template section. * * @see self::isTemplateStart() for a more complete description of the Docblock Template functionality. - * */ public function isTemplateEnd(): bool { diff --git a/src/DocBlock/DescriptionFactory.php b/src/DocBlock/DescriptionFactory.php index 1aafb4d..39d91b7 100644 --- a/src/DocBlock/DescriptionFactory.php +++ b/src/DocBlock/DescriptionFactory.php @@ -47,8 +47,6 @@ class DescriptionFactory /** * Returns the parsed text of this description. - * - * */ public function create(string $contents, ?TypeContext $context = null): Description { diff --git a/src/DocBlock/ExampleFinder.php b/src/DocBlock/ExampleFinder.php index 2ac7b45..d404a20 100644 --- a/src/DocBlock/ExampleFinder.php +++ b/src/DocBlock/ExampleFinder.php @@ -87,8 +87,6 @@ class ExampleFinder * 2. Checks the source folder for the given filename * 3. Checks the 'examples' folder in the current working directory for examples * 4. Checks the path relative to the current working directory for the given filename - * - * */ private function getExampleFileContents(string $filename): ?string { diff --git a/src/DocBlock/StandardTagFactory.php b/src/DocBlock/StandardTagFactory.php index 237d3c3..5feab3d 100644 --- a/src/DocBlock/StandardTagFactory.php +++ b/src/DocBlock/StandardTagFactory.php @@ -182,8 +182,6 @@ final class StandardTagFactory implements TagFactory /** * Creates a new tag object with the given name and body or returns null if the tag name was recognized but the * body was invalid. - * - * */ private function createTag(string $body, string $name, TypeContext $context): ?Tag { diff --git a/src/DocBlock/Tags/Covers.php b/src/DocBlock/Tags/Covers.php index e92ee68..d35a4bf 100644 --- a/src/DocBlock/Tags/Covers.php +++ b/src/DocBlock/Tags/Covers.php @@ -60,7 +60,6 @@ final class Covers extends BaseTag implements Factory\StaticMethod /** * Returns the structural element this tag refers to. - * */ public function getReference(): Fqsen { diff --git a/src/DocBlock/Tags/Deprecated.php b/src/DocBlock/Tags/Deprecated.php index daddd11..8f36729 100644 --- a/src/DocBlock/Tags/Deprecated.php +++ b/src/DocBlock/Tags/Deprecated.php @@ -80,7 +80,6 @@ final class Deprecated extends BaseTag implements Factory\StaticMethod /** * Gets the version section of the tag. - * */ public function getVersion(): ?string { diff --git a/src/DocBlock/Tags/Formatter.php b/src/DocBlock/Tags/Formatter.php index ce285f5..16a424f 100644 --- a/src/DocBlock/Tags/Formatter.php +++ b/src/DocBlock/Tags/Formatter.php @@ -19,8 +19,6 @@ interface Formatter { /** * Formats a tag into a string representation according to a specific format, such as Markdown. - * - * */ public function format(Tag $tag): string; } diff --git a/src/DocBlock/Tags/Param.php b/src/DocBlock/Tags/Param.php index e6fcbdc..189831e 100644 --- a/src/DocBlock/Tags/Param.php +++ b/src/DocBlock/Tags/Param.php @@ -98,7 +98,6 @@ final class Param extends BaseTag implements Factory\StaticMethod /** * Returns the variable's type or null if unknown. - * */ public function getType(): ?Type { @@ -107,7 +106,6 @@ final class Param extends BaseTag implements Factory\StaticMethod /** * Returns whether this tag is variadic. - * */ public function isVariadic(): bool { diff --git a/src/DocBlock/Tags/Property.php b/src/DocBlock/Tags/Property.php index 8c4f59a..9a02143 100644 --- a/src/DocBlock/Tags/Property.php +++ b/src/DocBlock/Tags/Property.php @@ -88,7 +88,6 @@ class Property extends BaseTag implements Factory\StaticMethod /** * Returns the variable's type or null if unknown. - * */ public function getType(): ?Type { diff --git a/src/DocBlock/Tags/PropertyRead.php b/src/DocBlock/Tags/PropertyRead.php index 51d6d0d..c4d1733 100644 --- a/src/DocBlock/Tags/PropertyRead.php +++ b/src/DocBlock/Tags/PropertyRead.php @@ -88,7 +88,6 @@ class PropertyRead extends BaseTag implements Factory\StaticMethod /** * Returns the variable's type or null if unknown. - * */ public function getType(): ?Type { diff --git a/src/DocBlock/Tags/PropertyWrite.php b/src/DocBlock/Tags/PropertyWrite.php index 234ac7e..845acb3 100644 --- a/src/DocBlock/Tags/PropertyWrite.php +++ b/src/DocBlock/Tags/PropertyWrite.php @@ -88,7 +88,6 @@ class PropertyWrite extends BaseTag implements Factory\StaticMethod /** * Returns the variable's type or null if unknown. - * */ public function getType(): ?Type { diff --git a/src/DocBlock/Tags/See.php b/src/DocBlock/Tags/See.php index 453d313..6e94dba 100644 --- a/src/DocBlock/Tags/See.php +++ b/src/DocBlock/Tags/See.php @@ -65,7 +65,6 @@ class See extends BaseTag implements Factory\StaticMethod /** * Returns the ref of this tag. - * */ public function getReference(): Reference { diff --git a/src/DocBlock/Tags/Throws.php b/src/DocBlock/Tags/Throws.php index 829b014..3b82ead 100644 --- a/src/DocBlock/Tags/Throws.php +++ b/src/DocBlock/Tags/Throws.php @@ -57,7 +57,6 @@ final class Throws extends BaseTag implements Factory\StaticMethod /** * Returns the type section of the variable. - * */ public function getType(): Type { diff --git a/src/DocBlock/Tags/Uses.php b/src/DocBlock/Tags/Uses.php index 05acd80..5bed26f 100644 --- a/src/DocBlock/Tags/Uses.php +++ b/src/DocBlock/Tags/Uses.php @@ -60,7 +60,6 @@ final class Uses extends BaseTag implements Factory\StaticMethod /** * Returns the structural element this tag refers to. - * */ public function getReference(): Fqsen { diff --git a/src/DocBlock/Tags/Var_.php b/src/DocBlock/Tags/Var_.php index f6e0edf..0e487c1 100644 --- a/src/DocBlock/Tags/Var_.php +++ b/src/DocBlock/Tags/Var_.php @@ -88,7 +88,6 @@ class Var_ extends BaseTag implements Factory\StaticMethod /** * Returns the variable's type or null if unknown. - * */ public function getType(): ?Type { diff --git a/src/DocBlockFactory.php b/src/DocBlockFactory.php index 10e56ed..4ef6bc4 100644 --- a/src/DocBlockFactory.php +++ b/src/DocBlockFactory.php @@ -40,7 +40,6 @@ final class DocBlockFactory implements DocBlockFactoryInterface * Factory method for easy instantiation. * * @param string[] $additionalTags - * */ public static function createInstance(array $additionalTags = []): DocBlockFactory { @@ -62,7 +61,6 @@ final class DocBlockFactory implements DocBlockFactoryInterface /** * @param object|string $docblock A string containing the DocBlock to parse or an object supporting the * getDocComment method (such as a ReflectionClass object). - * */ public function create($docblock, ?Types\Context $context = null, ?Location $location = null): DocBlock { diff --git a/src/DocBlockFactoryInterface.php b/src/DocBlockFactoryInterface.php index 83742a1..4f665dd 100644 --- a/src/DocBlockFactoryInterface.php +++ b/src/DocBlockFactoryInterface.php @@ -8,13 +8,11 @@ interface DocBlockFactoryInterface * Factory method for easy instantiation. * * @param string[] $additionalTags - * */ public static function createInstance(array $additionalTags = []): DocBlockFactory; /** * @param string|object $docblock - * */ public function create($docblock, ?Types\Context $context = null, ?Location $location = null): DocBlock; }