tighten up docblocks and types;

Author: ashnazg

src/phpDocumentor/Reflection/Php/Argument.php

@@ -64,7 +64,7 @@ public function getName(): string
     }
 
     /**
-     * {@inheritDoc}
+     * @return mixed[]
      */
     public function getTypes(): array
     {
@@ -80,25 +80,16 @@ public function addType($type): void
         $this->types[] = $type;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function getDefault(): ?string
     {
         return $this->default;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function isByReference(): bool
     {
         return $this->byReference;
     }
 
-    /**
-     * Returns whether this argument represents a variadic argument.
-     */
     public function isVariadic(): bool
     {
         return $this->isVariadic;

src/phpDocumentor/Reflection/Php/Class_.php

@@ -77,15 +77,12 @@ final class Class_ implements Element
     private $usedTraits = [];
 
     /**
-     * @var null|Location
+     * @var Location
      */
     private $location;
 
     /**
      * Initializes a number of properties with the given values. Others are initialized by definition.
-     *
-     *
-     * @param Location|null $location
      */
     public function __construct(
         Fqsen $fqsen,
@@ -237,15 +234,12 @@ public function getName(): string
         return $this->fqsen->getName();
     }
 
-    /**
-     * @returns null|DocBlock
-     */
     public function getDocBlock(): ?DocBlock
     {
         return $this->docBlock;
     }
 
-    public function getLocation(): ?Location
+    public function getLocation(): Location
     {
         return $this->location;
     }

src/phpDocumentor/Reflection/Php/Factory/ClassConstantIterator.php

@@ -30,7 +30,9 @@ final class ClassConstantIterator implements Iterator
      */
     private $classConstants;
 
-    /** @var int index of the current ClassConst to use */
+    /**
+     * @var int index of the current ClassConst to use
+     */
     private $index = 0;
 
     /**
@@ -90,8 +92,6 @@ public function getValue()
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Return the current element
      * @link http://php.net/manual/en/iterator.current.php
      */
     public function current(): self
@@ -100,8 +100,6 @@ public function current(): self
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Move forward to next element
      * @link http://php.net/manual/en/iterator.next.php
      */
     public function next(): void
@@ -110,8 +108,6 @@ public function next(): void
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Return the key of the current element
      * @link http://php.net/manual/en/iterator.key.php
      */
     public function key(): ?int
@@ -120,20 +116,14 @@ public function key(): ?int
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Checks if current position is valid
      * @link http://php.net/manual/en/iterator.valid.php
-     * @return boolean The return value will be casted to boolean and then evaluated.
-     * Returns true on success or false on failure.
      */
     public function valid(): bool
     {
         return isset($this->classConstants->consts[$this->index]);
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Rewind the Iterator to the first element
      * @link http://php.net/manual/en/iterator.rewind.php
      */
     public function rewind(): void

src/phpDocumentor/Reflection/Php/Factory/File.php

@@ -14,6 +14,7 @@
 
 namespace phpDocumentor\Reflection\Php\Factory;
 
+use phpDocumentor\Reflection\DocBlock;
 use phpDocumentor\Reflection\File as FileSystemFile;
 use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\Middleware\ChainFactory;
@@ -117,7 +118,7 @@ private function createFile(CreateCommand $command)
     /**
      * @param Node[] $nodes
      */
-    private function createElements(Fqsen $namespace, $nodes, FileElement $file, StrategyContainer $strategies)
+    private function createElements(Fqsen $namespace, array $nodes, FileElement $file, StrategyContainer $strategies): void
     {
         $contextFactory = new ContextFactory();
         $context = $contextFactory->createForNamespace((string) $namespace, $file->getSource());
@@ -153,14 +154,13 @@ private function createElements(Fqsen $namespace, $nodes, FileElement $file, Str
 
     /**
      * @param Node[] $nodes
-     * @return null|\phpDocumentor\Reflection\DocBlock
      */
     protected function createFileDocBlock(
-        Doc $docBlock = null,
-        StrategyContainer $strategies = null,
-        Context $context = null,
-        $nodes = []
-    ) {
+        ?Doc $docBlock = null,
+        ?StrategyContainer $strategies = null,
+        ?Context $context = null,
+        array $nodes = []
+    ): ?DocBlock {
         $node = current($nodes);
         if (!$node instanceof Node) {
             return null;

src/phpDocumentor/Reflection/Php/Factory/Method.php

@@ -78,10 +78,8 @@ protected function doCreate($object, StrategyContainer $strategies, ?Context $co
 
     /**
      * Converts the visibility of the method to a valid Visibility object.
-     *
-     * @return Visibility
      */
-    private function buildVisibility(ClassMethod $node)
+    private function buildVisibility(ClassMethod $node): Visibility
     {
         if ($node->isPrivate()) {
             return new Visibility(Visibility::PRIVATE_);

src/phpDocumentor/Reflection/Php/Factory/Property.php

@@ -80,10 +80,8 @@ protected function doCreate($object, StrategyContainer $strategies, ?Context $co
 
     /**
      * Converts the visibility of the property to a valid Visibility object.
-     *
-     * @return Visibility
      */
-    private function buildVisibility(PropertyIterator $node)
+    private function buildVisibility(PropertyIterator $node): Visibility
     {
         if ($node->isPrivate()) {
             return new Visibility(Visibility::PRIVATE_);

src/phpDocumentor/Reflection/Php/Factory/PropertyIterator.php

@@ -78,8 +78,6 @@ public function isStatic(): bool
 
     /**
      * Gets line the node started in.
-     *
-     * @return int Line
      */
     public function getLine(): int
     {
@@ -130,19 +128,14 @@ public function getFqsen(): Fqsen
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Return the current element
      * @link http://php.net/manual/en/iterator.current.php
-     * @return PropertyIterator Can return any type.
      */
     public function current(): self
     {
         return $this;
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Move forward to next element
      * @link http://php.net/manual/en/iterator.next.php
      */
     public function next(): void
@@ -151,31 +144,22 @@ public function next(): void
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Return the key of the current element
      * @link http://php.net/manual/en/iterator.key.php
-     * @return integer scalar on success, or null on failure.
      */
     public function key(): ?int
     {
         return $this->index;
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Checks if current position is valid
      * @link http://php.net/manual/en/iterator.valid.php
-     * @return boolean The return value will be casted to boolean and then evaluated.
-     * Returns true on success or false on failure.
      */
     public function valid(): bool
     {
         return isset($this->property->props[$this->index]);
     }
 
     /**
-     * (PHP 5 &gt;= 5.0.0)<br/>
-     * Rewind the Iterator to the first element
      * @link http://php.net/manual/en/iterator.rewind.php
      */
     public function rewind(): void

src/phpDocumentor/Reflection/Php/Function_.php

@@ -33,7 +33,9 @@ final class Function_ implements Element
      */
     private $fqsen;
 
-    /** @var Argument[] $arguments */
+    /**
+     * @var Argument[]
+     */
     private $arguments = [];
 
     /**
@@ -60,9 +62,9 @@ final class Function_ implements Element
      */
     public function __construct(
         Fqsen $fqsen,
-        DocBlock $docBlock = null,
-        Location $location = null,
-        Type $returnType = null
+        ?DocBlock $docBlock = null,
+        ?Location $location = null,
+        ?Type $returnType = null
     ) {
         if ($location === null) {
             $location = new Location(-1);

src/phpDocumentor/Reflection/Php/Method.php

@@ -74,10 +74,7 @@ final class Method implements Element
     /**
      * Initializes the all properties.
      *
-     *
      * @param Visibility|null $visibility when null is provided a default 'public' is set.
-     * @param DocBlock|null $docBlock
-     * @param Location|null $location
      */
     public function __construct(
         Fqsen $fqsen,

src/phpDocumentor/Reflection/Php/NodesFactory.php

@@ -15,6 +15,7 @@
 namespace phpDocumentor\Reflection\Php;
 
 use phpDocumentor\Reflection\NodeVisitor\ElementNameResolver;
+use PhpParser\Node;
 use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitor\NameResolver;
 use PhpParser\Parser;
@@ -72,7 +73,7 @@ public static function createInstance($kind = ParserFactory::PREFER_PHP7): self
      * Will convert the provided code to nodes.
      *
      * @param string $code code to process.
-     * @return \PhpParser\Node[]
+     * @return Node[]
      */
     public function create(string $code): array
     {

src/phpDocumentor/Reflection/Php/Project.php

@@ -46,7 +46,7 @@ final class Project implements ProjectInterface
      * Initializes this descriptor.
      *
      * @param string $name Name of the current project.
-     * @param Namespace_ $namespace Root namespace of the project.
+     * @param null|Namespace_ $namespace Root namespace of the project.
      */
     public function __construct(string $name, ?Namespace_ $namespace = null)
     {

src/phpDocumentor/Reflection/Php/Property.php

@@ -83,8 +83,6 @@ public function __construct(
 
     /**
      * returns the default value of this property.
-     *
-     * @return string
      */
     public function getDefault(): ?string
     {

src/phpDocumentor/Reflection/Php/Trait_.php

@@ -52,8 +52,6 @@ final class Trait_ implements Element
 
     /**
      * Initializes the all properties
-     *
-     * @param DocBlock|null $docBlock
      */
     public function __construct(Fqsen $fqsen, ?DocBlock $docBlock = null, ?Location $location = null)
     {