phpDocumentor / phpDocumentor

tests/ReferenceImplementation.php

Doc Comments +7 added lines

@@ -174,6 +174,9 @@ 
     {
         const INTERFACE_CONSTANT = 'test';
 
+        /**
+         * @return SubInterface|null
+         */
         public function publicMethod();
     }
 
@@ -183,6 +186,10 @@ 
      */
     interface AnotherSuperInterface
     {
+
+        /**
+         * @return void
+         */
         static public function staticMethod();
     }
 }

src/Application/Application.php

Doc Comments +4 added lines

@@ -60,6 +60,10 @@
     }
 
     // TODO: Change this; plugins are not read from a config file provided on runtime
+
+    /**
+     * @param \DI\Container $container
+     */
     private function registerPlugins($container)
     {
         //TODO: refactor this method. Previously config was used here.

src/DomainModel/Dsn.php

Doc Comments +1 added lines, -1 removed lines

@@ -117,7 +117,7 @@
     /**
      * Returns the path part of the DSN
      *
-     * @return string
+     * @return Path
      */
     public function getPath()
     {

src/Infrastructure/Reflection/Middleware/CacheMiddleware.php

Doc Comments +1 added lines

@@ -81,6 +81,7 @@
      * Convert path to ItemName
      *
      * @param path
+     * @param string $path
      * @return string
      */
     private function getItemName($path)

src/Application/Console/Command/RunCommand.php

Unused Use Statements -5 removed lines

@@ -25,12 +25,7 @@
 use phpDocumentor\Renderer\RenderActionCompleted;
 use phpDocumentor\Renderer\RenderingFinished;
 use phpDocumentor\Renderer\RenderingStarted;
-use Stash\Driver\FileSystem;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Helper\HelperInterface;
-use Symfony\Component\Console\Helper\ProgressBar;
-use Symfony\Component\Console\Helper\ProgressHelper;
-use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;

Doc Comments +4 added lines, -4 removed lines

@@ -400,9 +400,9 @@ 
     }
 
     /**
-     * @param $definition
+     * @param \phpDocumentor\DomainModel\Parser\Version\Definition $definition
      *
-     * @return null|\phpDocumentor\DomainModel\Parser\Documentation
+     * @return \phpDocumentor\DomainModel\Parser\Documentation
      */
     private function parse($definition)
     {
@@ -420,8 +420,8 @@ 
     }
 
     /**
-     * @param $documentation
-     * @param $destinationFilesystem
+     * @param \phpDocumentor\DomainModel\Parser\Documentation $documentation
+     * @param \League\Flysystem\Filesystem $destinationFilesystem
      * @param $templates
      */
     private function render($documentation, $destinationFilesystem, $templates)

src/Application/Renderer/StructureXmlRenderer.php

Unused Use Statements -2 removed lines

@@ -13,8 +13,6 @@
 
 use DomainModel\Renderer;
 use phpDocumentor\DomainModel\Path;
-use phpDocumentor\Application\Renderer\Template\Action;
-use phpDocumentor\Application\Renderer\Template\Action\Xml;
 use phpDocumentor\Application\Renderer\StructureXmlRenderer\ArgumentConverter;
 use phpDocumentor\Application\Renderer\StructureXmlRenderer\ConstantConverter;
 use phpDocumentor\Application\Renderer\StructureXmlRenderer\DocBlockConverter;

src/Application/Renderer/StructureXmlRenderer/ArgumentConverter.php

Unused Use Statements -1 removed lines

@@ -15,7 +15,6 @@
 use phpDocumentor\Descriptor\DescriptorAbstract;
 use PhpParser\Node;
 use PhpParser\PrettyPrinter\Standard;
-use PhpParser\PrettyPrinterTest;
 
 /**
  * Converter used to create an XML Element representing a method or function argument.

src/Application/Renderer/TwigRenderer/Extension.php

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
      * See the Class' DocBlock for a listing of functionality added by this
      * Extension.
      *
-     * @return \Twig_FunctionInterface[]
+     * @return \Twig_SimpleFunction[]
      */
     public function getFunctions()
     {

src/Application/Renderer/XslRenderer.php

Doc Comments +4 added lines, -4 removed lines

@@ -227,7 +227,7 @@ 
     }
 
     /**
-     * @param $structureFilename
+     * @param string $structureFilename
      * @return \DOMDocument
      */
     private function loadAst($structureFilename)
@@ -268,9 +268,9 @@ 
     }
 
     /**
-     * @param $filename
+     * @param string|null $filename
      * @param $proc
-     * @param $structure
+     * @param \DOMDocument $structure
      */
     private function writeToFile($filename, $proc, $structure)
     {
@@ -292,7 +292,7 @@ 
     /**
      * @param ProjectInterface $project
      * @param $element
-     * @return false|string
+     * @return string
      */
     private function generateUrlForXmlElement(ProjectInterface $project, $element)
     {