remove unused docblocks

Author: TomasVotruba

src/DocBlock.php

@@ -40,12 +40,9 @@ final class DocBlock
     private $isTemplateEnd = false;
 
     /**
-     * @param string $summary
      * @param DocBlock\Tag[] $tags
      * @param Types\Context $context The context in which the DocBlock occurs.
      * @param Location $location The location within the file that this DocBlock occurs in.
-     * @param bool $isTemplateStart
-     * @param bool $isTemplateEnd
      */
     public function __construct(
         string $summary = '',
@@ -71,9 +68,6 @@ public function __construct(
         $this->isTemplateStart = $isTemplateStart;
     }
 
-    /**
-     * @return string
-     */
     public function getSummary(): string
     {
         return $this->summary;
@@ -181,8 +175,6 @@ public function getTagsByName(string $name)
      * Checks if a tag of a certain type is present in this DocBlock.
      *
      * @param string $name Tag name to check for.
-     *
-     * @return bool
      */
     public function hasTag(string $name): bool
     {
@@ -200,7 +192,6 @@ public function hasTag(string $name): bool
      * Remove a tag from this DocBlock.
      *
      * @param Tag $tag The tag to remove.
-     *
      */
     public function removeTag(Tag $tagToRemove)
     {
@@ -216,7 +207,6 @@ public function removeTag(Tag $tagToRemove)
      * Adds a tag to this DocBlock.
      *
      * @param Tag $tag The tag to add.
-     *
      */
     private function addTag(Tag $tag)
     {

src/DocBlock/Description.php

@@ -59,7 +59,6 @@ class Description
     /**
      * Initializes a Description with its body (template) and a listing of the tags used in the body template.
      *
-     * @param string $bodyTemplate
      * @param Tag[] $tags
      */
     public function __construct(string $bodyTemplate, array $tags = [])
@@ -81,9 +80,6 @@ public function getTags()
     /**
      * Renders this description as a string where the provided formatter will format the tags in the expected string
      * format.
-     *
-     *
-     * @return string
      */
     public function render(Formatter $formatter = null): string
     {
@@ -101,8 +97,6 @@ public function render(Formatter $formatter = null): string
 
     /**
      * Returns a plain string representation of this description.
-     *
-     * @return string
      */
     public function __toString(): string
     {

src/DocBlock/DescriptionFactory.php

@@ -39,7 +39,6 @@ class DescriptionFactory
 
     /**
      * Initializes this factory with the means to construct (inline) tags.
-     *
      */
     public function __construct(TagFactory $tagFactory)
     {
@@ -49,7 +48,6 @@ public function __construct(TagFactory $tagFactory)
     /**
      * Returns the parsed text of this description.
      *
-     * @param string $contents
      *
      * @return Description
      */
@@ -63,7 +61,6 @@ public function create(string $contents, TypeContext $context = null): Descripti
     /**
      * Strips the contents from superfluous whitespace and splits the description into a series of tokens.
      *
-     * @param string $contents
      *
      * @return string[] A series of tokens of which the description text is composed.
      */
@@ -149,10 +146,6 @@ private function parse($tokens, TypeContext $context)
      *
      * If we do not normalize the indentation then we have superfluous whitespace on the second and subsequent
      * lines and this may cause rendering issues when, for example, using a Markdown converter.
-     *
-     * @param string $contents
-     *
-     * @return string
      */
     private function removeSuperfluousStartingWhitespace(string $contents): string
     {

src/DocBlock/ExampleFinder.php

@@ -28,9 +28,6 @@ class ExampleFinder
 
     /**
      * Attempts to find the example contents for the given descriptor.
-     *
-     *
-     * @return string
      */
     public function find(Example $example): string
     {
@@ -46,9 +43,6 @@ public function find(Example $example): string
 
     /**
      * Registers the project's root directory where an 'examples' folder can be expected.
-     *
-     * @param string $directory
-     *
      */
     public function setSourceDirectory(string $directory = '')
     {
@@ -57,8 +51,6 @@ public function setSourceDirectory(string $directory = '')
 
     /**
      * Returns the project's root directory where an 'examples' folder can be expected.
-     *
-     * @return string
      */
     public function getSourceDirectory(): string
     {
@@ -96,7 +88,6 @@ public function getExampleDirectories()
      * 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
      *
-     * @param string $filename
      *
      * @return string|null
      */
@@ -127,10 +118,6 @@ private function getExampleFileContents(string $filename)
 
     /**
      * Get example filepath based on the example directory inside your project.
-     *
-     * @param string $file
-     *
-     * @return string
      */
     private function getExamplePathFromExampleDirectory(string $file): string
     {
@@ -139,11 +126,6 @@ private function getExamplePathFromExampleDirectory(string $file): string
 
     /**
      * Returns a path to the example file in the given directory..
-     *
-     * @param string $directory
-     * @param string $file
-     *
-     * @return string
      */
     private function constructExamplePath(string $directory, string $file): string
     {
@@ -152,10 +134,6 @@ private function constructExamplePath(string $directory, string $file): string
 
     /**
      * Get example filepath based on sourcecode.
-     *
-     * @param string $file
-     *
-     * @return string
      */
     private function getExamplePathFromSource(string $file): string
     {

src/DocBlock/Serializer.php

@@ -88,8 +88,6 @@ public function getDocComment(DocBlock $docblock): string
     }
 
     /**
-     * @param $indent
-     * @param $text
      * @return mixed
      */
     private function removeTrailingSpaces($indent, $text)
@@ -98,19 +96,13 @@ private function removeTrailingSpaces($indent, $text)
     }
 
     /**
-     * @param $indent
-     * @param $text
      * @return mixed
      */
     private function addAsterisksForEachLine($indent, $text)
     {
         return str_replace("\n", "\n{$indent} * ", $text);
     }
 
-    /**
-     * @param $wrapLength
-     * @return string
-     */
     private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, $wrapLength): string
     {
         $text = $docblock->getSummary() . ((string)$docblock->getDescription() ? "\n\n" . $docblock->getDescription()
@@ -123,12 +115,6 @@ private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, $wrapLeng
         return $text;
     }
 
-    /**
-     * @param $wrapLength
-     * @param $indent
-     * @param $comment
-     * @return string
-     */
     private function addTagBlock(DocBlock $docblock, $wrapLength, $indent, $comment): string
     {
         foreach ($docblock->getTags() as $tag) {

src/DocBlock/StandardTagFactory.php

@@ -160,7 +160,6 @@ public function registerTagHandler(string $tagName, string $handler)
     /**
      * Extracts all components for a tag.
      *
-     * @param string $tagLine
      *
      * @return string[]
      */
@@ -184,8 +183,6 @@ private function extractTagParts(string $tagLine)
      * 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.
      *
-     * @param string  $body
-     * @param string  $name
      *
      * @return Tag|null
      */
@@ -202,10 +199,6 @@ private function createTag(string $body, string $name, TypeContext $context)
 
     /**
      * Determines the Fully Qualified Class Name of the Factory or Tag (containing a Factory Method `create`).
-     *
-     * @param string  $tagName
-     *
-     * @return string
      */
     private function findHandlerClassName(string $tagName, TypeContext $context): string
     {
@@ -258,7 +251,6 @@ private function getArgumentsForParametersFromWiring($parameters, $locator)
      * Retrieves a series of ReflectionParameter objects for the static 'create' method of the given
      * tag handler class name.
      *
-     * @param string $handlerClassName
      *
      * @return \ReflectionParameter[]
      */
@@ -299,11 +291,8 @@ private function getServiceLocatorWithDynamicParameters(TypeContext $context, st
     /**
      * Returns whether the given tag belongs to an annotation.
      *
-     * @param string $tagContent
      *
      * @todo this method should be populated once we implement Annotation notation support.
-     *
-     * @return bool
      */
     private function isAnnotation(string $tagContent): bool
     {

src/DocBlock/TagFactory.php

@@ -37,8 +37,6 @@ interface TagFactory
      *
      * @param string $name
      * @param mixed  $value
-     *
-     * @return void
      */
     public function addParameter(string $name, $value);
 
@@ -52,9 +50,6 @@ public function addParameter(string $name, $value);
      * interface is passed as alias then every time that interface is requested the provided service will be returned.
      *
      * @param object $service
-     * @param string $alias
-     *
-     * @return void
      */
     public function addService($service);
 
@@ -86,8 +81,6 @@ public function create(string $tagLine, TypeContext $context = null): ?Tag;
      * @throws \InvalidArgumentException if the handler is not a string
      * @throws \InvalidArgumentException if the handler is not an existing class
      * @throws \InvalidArgumentException if the handler does not implement the {@see Tag} interface
-     *
-     * @return void
      */
     public function registerTagHandler(string $tagName, string $handler);
 }

src/DocBlock/Tags/Author.php

@@ -30,9 +30,6 @@ final class Author extends BaseTag implements Factory\StaticMethod
 
     /**
      * Initializes this tag with the author name and e-mail.
-     *
-     * @param string $authorName
-     * @param string $authorEmail
      */
     public function __construct(string $authorName, string $authorEmail)
     {
@@ -66,8 +63,6 @@ public function getEmail(): string
 
     /**
      * Returns this tag in string form.
-     *
-     * @return string
      */
     public function __toString(): string
     {
@@ -77,7 +72,6 @@ public function __toString(): string
     /**
      * Attempts to create a new Author object based on †he tag body.
      *
-     * @param string $body
      *
      * @return static
      */

src/DocBlock/Tags/Covers.php

@@ -32,8 +32,6 @@ final class Covers extends BaseTag implements Factory\StaticMethod
 
     /**
      * Initializes this tag.
-     *
-     * @param Description $description
      */
     public function __construct(Fqsen $refers, Description $description = null)
     {
@@ -72,8 +70,6 @@ public function getReference(): Fqsen
 
     /**
      * Returns a string representation of this tag.
-     *
-     * @return string
      */
     public function __toString(): string
     {

src/DocBlock/Tags/Example.php

@@ -138,8 +138,6 @@ public function getFilePath(): string
 
     /**
      * Returns a string representation for this tag.
-     *
-     * @return string
      */
     public function __toString(): string
     {
@@ -148,27 +146,17 @@ public function __toString(): string
 
     /**
      * Returns true if the provided URI is relative or contains a complete scheme (and thus is absolute).
-     *
-     * @param string $uri
-     *
-     * @return bool
      */
     private function isUriRelative(string $uri): bool
     {
         return false === strpos($uri, ':');
     }
 
-    /**
-     * @return int
-     */
     public function getStartingLine(): int
     {
         return $this->startingLine;
     }
 
-    /**
-     * @return int
-     */
     public function getLineCount(): int
     {
         return $this->lineCount;