improved PHPDoc descriptions

Author: dg

src/Application/Application.php

@@ -58,7 +58,7 @@ public function __construct(
 
 
 	/**
-	 * Dispatch a HTTP request to a front controller.
+	 * Dispatches an HTTP request to a front controller.
 	 */
 	public function run(): void
 	{
@@ -87,6 +87,10 @@ public function run(): void
 	}
 
 
+	/**
+	 * Creates request from the current HTTP request via router.
+	 * @throws BadRequestException
+	 */
 	public function createInitialRequest(): Request
 	{
 		$params = $this->router->match($this->httpRequest);
@@ -111,6 +115,9 @@ public function createInitialRequest(): Request
 	}
 
 
+	/**
+	 * Processes a presenter request and dispatches the response.
+	 */
 	public function processRequest(Request $request): void
 	{
 		process:
@@ -150,6 +157,9 @@ public function processRequest(Request $request): void
 	}
 
 
+	/**
+	 * Creates a forward request to the error presenter, or returns null if not configured.
+	 */
 	public function createErrorRequest(\Throwable $e): ?Request
 	{
 		$errorPresenter = $e instanceof BadRequestException
@@ -207,18 +217,12 @@ final public function getPresenter(): ?IPresenter
 	/********************* services ****************d*g**/
 
 
-	/**
-	 * Returns router.
-	 */
 	public function getRouter(): Router
 	{
 		return $this->router;
 	}
 
 
-	/**
-	 * Returns presenter factory.
-	 */
 	public function getPresenterFactory(): IPresenterFactory
 	{
 		return $this->presenterFactory;

src/Application/Helpers.php

@@ -32,6 +32,7 @@ public static function splitName(string $name): array
 
 
 	/**
+	 * Returns all classes, parent classes, and traits used by the given class, keyed by name.
 	 * @return array<string, class-string>
 	 */
 	public static function getClassesAndTraits(string $class): array

src/Application/MicroPresenter.php

@@ -32,9 +32,6 @@ public function __construct(
 	}
 
 
-	/**
-	 * Gets the context.
-	 */
 	public function getContext(): ?Nette\DI\Container
 	{
 		return $this->context;
@@ -107,7 +104,7 @@ public function run(Application\Request $request): Application\Response
 
 
 	/**
-	 * Template factory.
+	 * Creates a template instance with default variables pre-populated.
 	 * @param  ?callable(): Latte\Engine  $latteFactory
 	 */
 	public function createTemplate(?string $class = null, ?callable $latteFactory = null): Application\UI\Template

src/Application/PresenterFactory.php

@@ -136,6 +136,9 @@ public function setAliases(array $aliases): static
 	}
 
 
+	/**
+	 * Returns the destination registered under the given alias, or throws if not found.
+	 */
 	public function getAlias(string $alias): string
 	{
 		return $this->aliases[$alias] ?? throw new Nette\InvalidStateException("Link alias '$alias' was not found.");

src/Application/Request.php

@@ -60,7 +60,7 @@ public function setPresenterName(string $name): static
 
 
 	/**
-	 * Retrieve the presenter name.
+	 * Returns the presenter name.
 	 */
 	public function getPresenterName(): string
 	{

src/Application/Responses/JsonResponse.php

@@ -28,9 +28,6 @@ public function getPayload(): mixed
 	}
 
 
-	/**
-	 * Returns the MIME content type of a downloaded file.
-	 */
 	public function getContentType(): string
 	{
 		return $this->contentType;

src/Application/Routers/RouteList.php

@@ -77,6 +77,9 @@ public function addRoute(
 	}
 
 
+	/**
+	 * Creates a sub-router scoped to the given module and attaches it to this list.
+	 */
 	public function withModule(string $module): static
 	{
 		$router = new static;

src/Application/UI/Component.php

@@ -34,7 +34,7 @@ abstract class Component extends Nette\ComponentModel\Container implements Signa
 
 
 	/**
-	 * Returns the presenter where this component belongs to.
+	 * Returns the presenter where this component belongs to. Throws if not attached.
 	 */
 	public function getPresenter(): ?Presenter
 	{
@@ -48,7 +48,7 @@ public function getPresenter(): ?Presenter
 
 
 	/**
-	 * Returns the presenter where this component belongs to.
+	 * Returns the presenter where this component belongs to, or null if not attached.
 	 */
 	public function getPresenterIfExists(): ?Presenter
 	{

src/Application/UI/Form.php

@@ -20,9 +20,6 @@ class Form extends Nette\Forms\Form implements SignalReceiver
 	public array $onAnchor = [];
 
 
-	/**
-	 * Application form constructor.
-	 */
 	public function __construct(?Nette\ComponentModel\IContainer $parent = null, ?string $name = null)
 	{
 		parent::__construct();
@@ -58,7 +55,7 @@ protected function validateParent(Nette\ComponentModel\IContainer $parent): void
 
 
 	/**
-	 * Returns the presenter where this component belongs to.
+	 * Returns the presenter where this component belongs to. Throws if not attached.
 	 */
 	final public function getPresenter(): ?Presenter
 	{
@@ -72,7 +69,7 @@ final public function getPresenter(): ?Presenter
 
 
 	/**
-	 * Returns the presenter where this component belongs to.
+	 * Returns the presenter where this component belongs to, or null if not attached.
 	 */
 	final public function getPresenterIfExists(): ?Presenter
 	{

src/Application/UI/ParameterConverter.php

@@ -64,7 +64,7 @@ public static function toArguments(\ReflectionFunctionAbstract $method, array $a
 	 * Converts list of arguments to named parameters & check types.
 	 * @param  mixed[]  $args
 	 * @param  array<string, mixed>  $supplemental
-	 * @param  \ReflectionParameter[]  $missing arguments
+	 * @param  \ReflectionParameter[]|null  $missing  collects parameters with missing values
 	 * @throws InvalidLinkException
 	 * @internal
 	 */