phpDocumentor / phpDocumentor

src/phpDocumentor/Compiler/Pass/ResolveInlineLinkAndSeeTags.php

Doc Comments +3 added lines, -2 removed lines

@@ -172,7 +172,7 @@ 
      * If a relative QSEN is provided then this method will attempt to resolve it given the current namespace and
      * namespace aliases.
      *
-     * @param Fqsen|string $link
+     * @param string|null $link
      *
      * @return Fqsen|string
      */
@@ -190,6 +190,7 @@ 
      * be matched.
      *
      * @param Fqsen|string $link
+     * @param string $description
      */
     private function resolveElement(DescriptorAbstract $element, $link, ?string $description = null) : string
     {
@@ -248,7 +249,7 @@ 
     /**
      * Generates a Markdown-formatted string representing a link with a description.
      *
-     * @param Fqsen|string $link
+     * @param string|null $link
      */
     private function generateMarkdownLink($link, string $description) : string
     {

src/phpDocumentor/Descriptor/Builder/Reflector/FileAssembler.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     /**
      * Creates a Descriptor from the provided data.
      *
-     * @param mixed $data
+     * @param File $data
      */
     public function create($data) : FileDescriptor
     {

src/phpDocumentor/Descriptor/Interfaces/ArgumentInterface.php

Doc Comments +4 added lines

@@ -36,6 +36,7 @@ 
      * @param ?Type $type Type of this agument represented as a reflection type.
      *
      * @todo update link to point to the final destination for the PHPDoc Standard.
+     * @return void
      */
     public function setType(?Type $type) : void;
 
@@ -43,6 +44,7 @@ 
      * Returns a normalized Types.
      *
      * @see self::setTypes() for details on what types represent.
+     * @return Type|null
      */
     public function getType() : ?Type;
 
@@ -50,6 +52,7 @@ 
      * Sets the default value for an argument expressed as a string.
      *
      * @param string $value A textual representation of the default value.
+     * @return void
      */
     public function setDefault(string $value) : void;
 
@@ -64,6 +67,7 @@ 
      * Sets whether this argument passes its parameter by reference or by value.
      *
      * @param bool $byReference True if the parameter is passed by reference, otherwise it is by value.
+     * @return void
      */
     public function setByReference(bool $byReference) : void;
 

src/phpDocumentor/Descriptor/Interfaces/ChildInterface.php

Doc Comments +1 added lines

@@ -32,6 +32,7 @@
      * Sets the parent for this Descriptor.
      *
      * @param ?DescriptorAbstract $parent
+     * @return void
      */
     public function setParent(?DescriptorAbstract $parent) : void;
 }

src/phpDocumentor/Descriptor/PropertyDescriptor.php

Doc Comments +1 added lines

@@ -61,6 +61,7 @@
 
     /**
      * {@inheritDoc}
+     * @param null|string $default
      */
     public function setDefault(?string $default) : void
     {

tests/unit/phpDocumentor/Configuration/ConfigurationFactoryTest.php

Doc Comments +10 added lines

@@ -161,6 +161,9 @@ 
         new ConfigurationFactory(['this_is_not_a_strategy'], []);
     }
 
+    /**
+     * @param string $content
+     */
     private function givenExampleConfigurationFileWithContent($content) : string
     {
         vfsStream::newFile('foo.xml')
@@ -170,6 +173,10 @@ 
         return vfsStream::url('dir/foo.xml');
     }
 
+    /**
+     * @param string[] $expectedInputValue
+     * @param string[] $returnValue
+     */
     private function givenAMiddlewareThatReturns($expectedInputValue, $returnValue) : Closure
     {
         return function ($value) use ($expectedInputValue, $returnValue) {
@@ -179,6 +186,9 @@ 
         };
     }
 
+    /**
+     * @param string[] $result
+     */
     private function givenAValidStrategyThatReturns($result) : Strategy
     {
         /** @var m\Mock $strategy */

tests/unit/phpDocumentor/Descriptor/Builder/Reflector/MethodAssemblerTest.php

Doc Comments +2 added lines

@@ -169,6 +169,7 @@ 
 
     /**
      * Creates a sample method reflector for the tests with the given data.
+     * @param DocBlock $docBlockMock
      */
     protected function givenAMethodReflector(
         string $namespace,
@@ -189,6 +190,7 @@ 
 
     /**
      * Generates a DocBlock object with applicable defaults for these tests.
+     * @param boolean $withTags
      */
     protected function givenADocBlockObject($withTags) : DocBlock
     {

tests/unit/phpDocumentor/Descriptor/Builder/Reflector/Tags/SeeAssemblerTest.php

Doc Comments +3 added lines

@@ -88,6 +88,9 @@
         $this->assertSame([], $descriptor->getErrors()->getAll());
     }
 
+    /**
+     * @param string $description
+     */
     protected function givenASeeTag($reference, $description) : See
     {
         return new DocBlock\Tags\See(

tests/unit/phpDocumentor/Descriptor/ConstantDescriptorTest.php

Doc Comments +3 added lines, -3 removed lines

@@ -342,7 +342,7 @@ 
      * The created ParentClass can be used to test the inheritance of properties of a constant descriptor, such as
      * inheriting type information.
      *
-     * @return m\MockInterface|ClassDescriptor
+     * @return m\LegacyMockInterface
      */
     protected function createParentClassWithSuperClassAndConstant(Type $type, string $constantName)
     {
@@ -372,7 +372,7 @@ 
     /**
      * Sets up mocks as such that the fixture has a file.
      *
-     * @return m\MockInterface|FileDescriptor
+     * @return m\LegacyMockInterface
      */
     protected function whenFixtureIsDirectlyRelatedToAFile()
     {
@@ -384,7 +384,7 @@ 
     /**
      * Sets up mocks as such that the fixture has a parent class, with a file.
      *
-     * @return m\MockInterface|FileDescriptor
+     * @return m\LegacyMockInterface
      */
     protected function whenFixtureIsRelatedToAClassWithFile()
     {