Updated PHPDocs

- added missing param tags
- added missing return void
- fixed typos
- fixed types

Author: michalbundyra

src/NamespacedPathStackResolver.php

@@ -61,6 +61,7 @@ public function __construct($options = null)
      *
      * @param string $path
      * @param string $namespace
+     * @return void
      * @throws ViewException\InvalidArgumentException for an invalid path
      * @throws ViewException\InvalidArgumentException for an invalid namespace
      */
@@ -94,6 +95,7 @@ public function addPath($path, $namespace = self::DEFAULT_NAMESPACE)
      * Add many paths to the stack at once.
      *
      * @param array $paths
+     * @return void
      */
     public function addPaths(array $paths)
     {
@@ -110,6 +112,7 @@ public function addPaths(array $paths)
      * Overwrite all existing paths with the provided paths.
      *
      * @param array|Traversable $paths
+     * @return void
      * @throws ViewException\InvalidArgumentException for invalid path types.
      */
     public function setPaths($paths)
@@ -131,6 +134,8 @@ public function setPaths($paths)
 
     /**
      * Clear all paths.
+     *
+     * @return void
      */
     public function clearPaths()
     {
@@ -140,9 +145,9 @@ public function clearPaths()
     /**
      * Retrieve the filesystem path to a view script
      *
-     * @param  string $name
-     * @param  null|RendererInterface $renderer
-     * @return string
+     * @param string $name
+     * @param null|RendererInterface $renderer
+     * @return false|string
      * @throws ViewException\DomainException
      */
     public function resolve($name, RendererInterface $renderer = null)

src/ServerUrlHelper.php

@@ -45,6 +45,7 @@ public function __invoke($path = null)
     /**
      * Proxies to `Zend\Expressive\Helper\ServerUrlHelper::setUri()`
      * @param UriInterface $uri
+     * @return void
      */
     public function setUri(UriInterface $uri)
     {

src/UrlHelper.php

@@ -29,10 +29,10 @@ public function __construct(BaseHelper $helper)
      * Proxies to `Zend\Expressive\Helper\UrlHelper::generate()`
      *
      * @param null|string $routeName
-     * @param array  $routeParams
-     * @param array  $queryParams
+     * @param array $routeParams
+     * @param array $queryParams
      * @param null|string $fragmentIdentifier
-     * @param array  $options Can have the following keys:
+     * @param array $options Can have the following keys:
      *     - router (array): contains options to be passed to the router
      *     - reuse_result_params (bool): indicates if the current RouteResult
      *       parameters will be used, defaults to true

src/ZendViewRenderer.php

@@ -135,6 +135,7 @@ public function render($name, $params = [])
      *
      * @param string $path
      * @param string $namespace
+     * @return void
      */
     public function addPath($path, $namespace = null)
     {
@@ -230,7 +231,7 @@ private function createRenderer()
     /**
      * Get the default resolver
      *
-     * @return NamespacedPathStackResolver
+     * @return AggregateResolver
      */
     private function getDefaultResolver()
     {
@@ -245,6 +246,7 @@ private function getDefaultResolver()
      * A priority of 0 is used, to ensure it is the last queried.
      *
      * @param AggregateResolver $aggregate
+     * @return void
      */
     private function injectNamespacedResolver(AggregateResolver $aggregate)
     {

src/ZendViewRendererFactory.php

@@ -49,7 +49,7 @@ class ZendViewRendererFactory
 {
     /**
      * @param ContainerInterface $container
-     * @returns ZendViewRenderer
+     * @return ZendViewRenderer
      */
     public function __invoke(ContainerInterface $container)
     {
@@ -95,6 +95,8 @@ public function __invoke(ContainerInterface $container)
      *
      * @param PhpRenderer $renderer
      * @param ContainerInterface $container
+     * @return void
+     * @throws Exception\MissingHelperException
      */
     private function injectHelpers(PhpRenderer $renderer, ContainerInterface $container)
     {

test/ZendViewRendererFactoryTest.php

@@ -134,6 +134,8 @@ public function testCallingFactoryWithNoConfigReturnsZendViewInstance()
 
     /**
      * @depends testCallingFactoryWithNoConfigReturnsZendViewInstance
+     *
+     * @param ZendViewRenderer $view
      */
     public function testUnconfiguredZendViewInstanceContainsNoPaths(ZendViewRenderer $view)
     {
@@ -271,6 +273,8 @@ public function testWillUseHelperManagerFromContainer()
 
     /**
      * @depends testWillUseHelperManagerFromContainer
+     *
+     * @param HelperPluginManager $helpers
      */
     public function testInjectsCustomHelpersIntoHelperManagerFromContainer(HelperPluginManager $helpers)
     {

test/ZendViewRendererTest.php

@@ -140,6 +140,8 @@ public function invalidParameterValues()
 
     /**
      * @dataProvider invalidParameterValues
+     *
+     * @param mixed $params
      */
     public function testRenderRaisesExceptionForInvalidParameterTypes($params)
     {
@@ -172,6 +174,9 @@ public function objectParameterValues()
 
     /**
      * @dataProvider objectParameterValues
+     *
+     * @param object $params
+     * @param string $search
      */
     public function testCanRenderWithParameterObjects($params, $search)
     {
@@ -345,6 +350,8 @@ public function useArrayOrViewModel()
 
     /**
      * @dataProvider useArrayOrViewModel
+     *
+     * @param bool $viewAsModel
      */
     public function testOverrideSharedParametersAtRender($viewAsModel)
     {