improved phpDoc

Author: dg

src/Application/Helpers.php

@@ -34,7 +34,7 @@ public static function splitName(string $name): array
 
 
 	/**
-	 * return string[]
+	 * @return array<string, class-string>
 	 */
 	public static function getClassesAndTraits(string $class): array
 	{

src/Application/PresenterFactory.php

@@ -18,7 +18,7 @@
  */
 class PresenterFactory implements IPresenterFactory
 {
-	/** @var array[] of module => splited mask */
+	/** @var array<string, array{string, string, string}>  module => splited mask */
 	private array $mapping = [
 		'*' => ['', '*Module\\', '*Presenter'],
 		'Nette' => ['NetteModule\\', '*\\', '*Presenter'],
@@ -78,6 +78,7 @@ public function getPresenterClass(string &$name): string
 
 	/**
 	 * Sets mapping as pairs [module => mask]
+	 * @param array<string, string|array{string, string, string}>  $mapping
 	 */
 	public function setMapping(array $mapping): static
 	{
@@ -123,6 +124,7 @@ public function formatPresenterClass(string $presenter): string
 
 	/**
 	 * Sets pairs [alias => destination]
+	 * @param array<string, string>  $aliases
 	 */
 	public function setAliases(array $aliases): static
 	{

src/Application/Request.php

@@ -20,7 +20,7 @@
  * @property array $parameters
  * @property array $post
  * @property array $files
- * @property string|null $method
+ * @property ?string $method
  */
 final class Request
 {

src/Application/Responses/CallbackResponse.php

@@ -22,7 +22,7 @@ final class CallbackResponse implements Nette\Application\Response
 
 
 	/**
-	 * @param  callable(Nette\Http\IRequest, Nette\Http\Response): void  $callback
+	 * @param  callable(Nette\Http\IRequest, Nette\Http\IResponse): void  $callback
 	 */
 	public function __construct(callable $callback)
 	{

src/Application/Routers/CliRouter.php

@@ -22,6 +22,7 @@ final class CliRouter implements Nette\Routing\Router
 
 
 	public function __construct(
+		/** @var array<string, mixed> */
 		private readonly array $defaults = [],
 	) {
 	}
@@ -99,6 +100,7 @@ public function constructUrl(array $params, Nette\Http\UrlScript $refUrl): ?stri
 
 	/**
 	 * Returns default values.
+	 * @return array<string, mixed>
 	 */
 	public function getDefaults(): array
 	{

src/Application/Routers/Route.php

@@ -98,6 +98,7 @@ public function match(Nette\Http\IRequest $httpRequest): ?array
 
 	/**
 	 * Constructs absolute URL from array.
+	 * @param  array<string, mixed>  $params
 	 */
 	public function constructUrl(array $params, Nette\Http\UrlScript $refUrl): ?string
 	{
@@ -121,7 +122,10 @@ public function constructUrl(array $params, Nette\Http\UrlScript $refUrl): ?stri
 	}
 
 
-	/** @internal */
+	/**
+	 * @return array<string, mixed>
+	 * @internal
+	 */
 	public function getConstantParameters(): array
 	{
 		$res = parent::getConstantParameters();

src/Application/Routers/RouteList.php

@@ -33,6 +33,8 @@ public function __construct(?string $module = null)
 
 	/**
 	 * Support for modules.
+	 * @param  array<string, mixed>  $params
+	 * @return ?array<string, mixed>
 	 */
 	protected function completeParameters(array $params): ?array
 	{
@@ -47,6 +49,7 @@ protected function completeParameters(array $params): ?array
 
 	/**
 	 * Constructs absolute URL from array.
+	 * @param  array<string, mixed>  $params
 	 */
 	public function constructUrl(array $params, Nette\Http\UrlScript $refUrl): ?string
 	{

src/Application/UI/AccessPolicy.php

@@ -63,7 +63,8 @@ private function getAttributes(): array
 
 
 	/**
-	 * @param  Requires[]  $attrs
+	 * @param  Attributes\Requires[]  $attrs
+	 * @return Attributes\Requires[]
 	 */
 	private function applyInternalRules(array $attrs, Component $component): array
 	{

src/Application/UI/Component.php

@@ -29,6 +29,8 @@ abstract class Component extends Nette\ComponentModel\Container implements Signa
 
 	/** @var array<callable(self): void>  Occurs when component is attached to presenter */
 	public array $onAnchor = [];
+
+	/** @var array<string, mixed> */
 	protected array $params = [];
 
 
@@ -99,6 +101,7 @@ protected function validateParent(Nette\ComponentModel\IContainer $parent): void
 
 	/**
 	 * Calls public method if exists.
+	 * @param  array<string, mixed>  $params
 	 */
 	protected function tryCall(string $method, array $params): bool
 	{
@@ -146,6 +149,7 @@ public static function getReflection(): ComponentReflection
 
 	/**
 	 * Loads state information.
+	 * @param  array<string, mixed>  $params
 	 */
 	public function loadState(array $params): void
 	{
@@ -174,6 +178,7 @@ public function loadState(array $params): void
 
 	/**
 	 * Saves state information for next request.
+	 * @param  array<string, mixed>  $params
 	 */
 	public function saveState(array &$params): void
 	{
@@ -235,6 +240,7 @@ final public function getParameter(string $name): mixed
 
 	/**
 	 * Returns component parameters.
+	 * @return array<string, mixed>
 	 */
 	final public function getParameters(): array
 	{

src/Application/UI/ComponentReflection.php

@@ -30,7 +30,7 @@ final class ComponentReflection extends \ReflectionClass
 
 	/**
 	 * Returns array of class properties that are public and have attribute #[Persistent] or #[Parameter] or annotation @persistent.
-	 * @return array<string, array{def: mixed, type: string, since: ?class-string}>
+	 * @return array<string, array{def: mixed, type: string, since?: ?class-string}>
 	 */
 	public function getParameters(): array
 	{
@@ -78,7 +78,7 @@ public function getParameters(): array
 
 	/**
 	 * Returns array of persistent properties. They are public and have attribute #[Persistent] or annotation @persistent.
-	 * @return array<string, array{def: mixed, type: string, since: class-string}>
+	 * @return array<string, array{def: mixed, type: string, since: ?class-string}>
 	 */
 	public function getPersistentParams(): array
 	{
@@ -115,6 +115,9 @@ public function getPersistentComponents(): array
 	}
 
 
+	/**
+	 * @return string[] names of public properties with #[TemplateVariable] attribute
+	 */
 	public function getTemplateVariables(Control $control): array
 	{
 		$res = [];