Merge pull request #10 from solcik/patch-1-annotations

Redundant annotations removed
Kdyby · Mar 11, 2018 · 5e5621a · 5e5621a
2 parents ae61310 + 75faa22
commit 5e5621a
Show file tree

Hide file tree

Showing 11 changed files with 7 additions and 109 deletions.
diff --git a/src/DI/WkhtmltopdfExtension.php b/src/DI/WkhtmltopdfExtension.php
@@ -28,9 +28,6 @@ class WkhtmltopdfExtension extends Nette\DI\CompilerExtension
 	];
 
 
-	/**
-	 * @return void
-	 */
 	public function loadConfiguration(): void
 	{
 		$builder = $this->getContainerBuilder();
@@ -48,10 +45,6 @@ public function loadConfiguration(): void
 	}
 
 
-	/**
-	 * @param Nette\Configurator
-	 * @return void
-	 */
 	public static function register(Nette\Configurator $configurator): void
 	{
 		$configurator->onCompile[] = function ($config, Nette\DI\Compiler $compiler) {

diff --git a/src/Document.php b/src/Document.php
@@ -66,20 +66,13 @@ class Document implements Nette\Application\IResponse
 	private $process;
 
 
-	/**
-	 * @param string
-	 * @param string
-	 */
-	public function __construct(string $tmpDir, string $executable = null)
+	public function __construct(string $tmpDir, ?string $executable = null)
 	{
 		$this->tmpDir = $tmpDir;
 		$this->process = new Process($executable);
 	}
 
 
-	/**
-	 * @return Kdyby\Wkhtmltopdf\PageMeta
-	 */
 	public function getHeader(): Kdyby\Wkhtmltopdf\PageMeta
 	{
 		if ($this->header === null) {
@@ -90,9 +83,6 @@ public function getHeader(): Kdyby\Wkhtmltopdf\PageMeta
 	}
 
 
-	/**
-	 * @return Kdyby\Wkhtmltopdf\PageMeta
-	 */
 	public function getFooter(): Kdyby\Wkhtmltopdf\PageMeta
 	{
 		if ($this->footer === null) {
@@ -104,9 +94,7 @@ public function getFooter(): Kdyby\Wkhtmltopdf\PageMeta
 
 
 	/**
-	 * @param string|Nette\Bridges\ApplicationLatte\Template
-	 * @param bool
-	 * @return Kdyby\Wkhtmltopdf\Page
+	 * @param string|Nette\Bridges\ApplicationLatte\Template $html
 	 */
 	public function addHtml($html, bool $isCover = false): Kdyby\Wkhtmltopdf\Page
 	{
@@ -122,11 +110,6 @@ public function addHtml($html, bool $isCover = false): Kdyby\Wkhtmltopdf\Page
 	}
 
 
-	/**
-	 * @param string
-	 * @param bool
-	 * @return Kdyby\Wkhtmltopdf\Page
-	 */
 	public function addFile(string $file, bool $isCover = false): Kdyby\Wkhtmltopdf\Page
 	{
 		$this->pages[] = $page = $this->createPage();
@@ -137,11 +120,7 @@ public function addFile(string $file, bool $isCover = false): Kdyby\Wkhtmltopdf\
 	}
 
 
-	/**
-	 * @param string
-	 * @return Kdyby\Wkhtmltopdf\Toc
-	 */
-	public function addToc(string $header = null): Kdyby\Wkhtmltopdf\Toc
+	public function addToc(?string $header = null): Kdyby\Wkhtmltopdf\Toc
 	{
 		$this->pages[] = $toc = new Toc;
 
@@ -153,20 +132,13 @@ public function addToc(string $header = null): Kdyby\Wkhtmltopdf\Toc
 	}
 
 
-	/**
-	 * @param Kdyby\Wkhtmltopdf\IDocumentPart
-	 * @return Kdyby\Wkhtmltopdf\Document
-	 */
 	public function addPart(IDocumentPart $part): Kdyby\Wkhtmltopdf\Document
 	{
 		$this->pages[] = $part;
 		return $this;
 	}
 
 
-	/**
-	 * @return Kdyby\Wkhtmltopdf\Page
-	 */
 	private function createPage(): Kdyby\Wkhtmltopdf\Page
 	{
 		$page = new Page;
@@ -180,8 +152,6 @@ private function createPage(): Kdyby\Wkhtmltopdf\Page
 
 	/**
 	 * @internal
-	 * @param string
-	 * @return string
 	 */
 	public function saveTempFile(string $content): string
 	{
@@ -199,7 +169,6 @@ public function saveTempFile(string $content): string
 	/**
 	 * Send headers and outputs PDF document to browser.
 	 *
-	 * @return void
 	 * @throws Nette\InvalidStateException
 	 */
 	public function send(Nette\Http\IRequest $httpRequest, Nette\Http\IResponse $httpResponse): void
@@ -228,8 +197,6 @@ public function send(Nette\Http\IRequest $httpRequest, Nette\Http\IResponse $htt
 	/**
 	 * Save PDF document to file.
 	 *
-	 * @param string
-	 * @return void
 	 * @throws Nette\InvalidStateException
 	 */
 	public function save(string $file): void
@@ -244,8 +211,6 @@ public function save(string $file): void
 
 	/**
 	 * Returns PDF document as string.
-	 *
-	 * @return string
 	 */
 	public function __toString(): string
 	{
@@ -261,9 +226,6 @@ public function __toString(): string
 	}
 
 
-	/**
-	 * @return void
-	 */
 	private function convert(): void
 	{
 		$args = [
@@ -303,9 +265,6 @@ private function convert(): void
 	}
 
 
-	/**
-	 * @return void
-	 */
 	private function close(): void
 	{
 		$this->process->close();

diff --git a/src/DocumentFactory.php b/src/DocumentFactory.php
@@ -31,20 +31,13 @@ class DocumentFactory
 	private $executable;
 
 
-	/**
-	 * @param string
-	 * @param string
-	 */
 	public function __construct(string $tempDir, string $executable)
 	{
 		$this->tempDir = $tempDir;
 		$this->executable = $executable;
 	}
 
 
-	/**
-	 * @return Kdyby\Wkhtmltopdf\Document
-	 */
 	public function create(): Kdyby\Wkhtmltopdf\Document
 	{
 		return new Document($this->tempDir, $this->executable);

diff --git a/src/IDocumentPart.php b/src/IDocumentPart.php
@@ -18,9 +18,5 @@
  */
 interface IDocumentPart
 {
-	/**
-	 * @param Kdyby\Wkhtmltopdf\Document
-	 * @return array
-	 */
 	function buildShellArgs(Document $document): array;
 }
diff --git a/src/Page.php b/src/Page.php
@@ -48,10 +48,6 @@ class Page implements Kdyby\Wkhtmltopdf\IDocumentPart
 	public $zoom = 1;
 
 
-	/**
-	 * @param Kdyby\Wkhtmltopdf\Document
-	 * @return array
-	 */
 	public function buildShellArgs(Document $document): array
 	{
 		$args = [];

diff --git a/src/PageMeta.php b/src/PageMeta.php
@@ -54,19 +54,12 @@ class PageMeta implements Kdyby\Wkhtmltopdf\IDocumentPart
 	private $type;
 
 
-	/**
-	 * @param string
-	 */
 	public function __construct(string $type)
 	{
 		$this->type = $type;
 	}
 
 
-	/**
-	 * @param Kdyby\Wkhtmltopdf\Document
-	 * @return array
-	 */
 	public function buildShellArgs(Document $document): array
 	{
 		$args = [];

diff --git a/src/Process.php b/src/Process.php
@@ -36,18 +36,13 @@ class Process
 	private $executedCommand;
 
 
-	/**
-	 * @param string
-	 */
-	public function __construct(string $executable = null)
+	public function __construct(?string $executable = null)
 	{
 		$this->executable = $executable;
 	}
 
 
 	/**
-	 * @param array
-	 * @return void
 	 * @throws RuntimeException
 	 */
 	public function open(array $args): void
@@ -83,20 +78,13 @@ public function open(array $args): void
 	}
 
 
-	/**
-	 * @return void
-	 */
 	public function printOutput(): void
 	{
 		fpassthru($this->pipes[1]);
 	}
 
 
-	/**
-	 * @param int
-	 * @return string
-	 */
-	public function getOutput(int $length = null): string
+	public function getOutput(?int $length = null): string
 	{
 		if ($length !== null) {
 			return fgets($this->pipes[1], $length);
@@ -108,25 +96,20 @@ public function getOutput(int $length = null): string
 
 	/**
 	 * @param resource
-	 * @return void
 	 */
 	public function copyOutputTo($stream): void
 	{
 		stream_copy_to_stream($this->pipes[1], $stream);
 	}
 
 
-	/**
-	 * @return string
-	 */
 	public function getErrorOutput(): string
 	{
 		return stream_get_contents($this->pipes[2]);
 	}
 
 
 	/**
-	 * @return void
 	 * @throws \RuntimeException
 	 */
 	public function close(): void

diff --git a/src/Toc.php b/src/Toc.php
@@ -33,10 +33,6 @@ class Toc implements Kdyby\Wkhtmltopdf\IDocumentPart
 	public $headersSizeShrink = 0.9;
 
 
-	/**
-	 * @param Kdyby\Wkhtmltopdf\Document
-	 * @return array
-	 */
 	public function buildShellArgs(Document $document): array
 	{
 		return [

diff --git a/src/Utils/XvfbWrapper.php b/src/Utils/XvfbWrapper.php
@@ -26,18 +26,12 @@ class XvfbWrapper
 	private $executable;
 
 
-	/**
-	 * @param string
-	 */
 	public function __construct(string $executable)
 	{
 		$this->executable = $executable;
 	}
 
 
-	/**
-	 * @return string
-	 */
 	public function __toString(): string
 	{
 		return sprintf('xvfb-run -a --server-args="-screen 0, 1024x768x24" %s', $this->executable);

diff --git a/tests/KdybyTests/Wkhtmltopdf/Extension.phpt b/tests/KdybyTests/Wkhtmltopdf/Extension.phpt
@@ -12,7 +12,6 @@ namespace KdybyTests\Translation;
 
 use Kdyby;
 use Nette;
-use Symfony;
 use Tester;
 use Tester\Assert;
 
@@ -27,8 +26,7 @@ class ExtensionTest extends Tester\TestCase
 {
 
 	/**
-	 * @param string $configFile
-	 * @return \SystemContainer|\Nette\DI\Container
+	 * @return \Nette\DI\Container
 	 */
 	public function createContainer()
 	{

diff --git a/tests/KdybyTests/Wkhtmltopdf/Functional.phpt b/tests/KdybyTests/Wkhtmltopdf/Functional.phpt
@@ -15,7 +15,6 @@ use Kdyby\Wkhtmltopdf\Document;
 use Kdyby\Wkhtmltopdf\Utils\ExecutableFinder;
 use Kdyby\Wkhtmltopdf\Utils\XvfbWrapper;
 use Nette;
-use Symfony;
 use Tester;
 use Tester\Assert;
 
@@ -29,9 +28,7 @@ require_once __DIR__ . '/../bootstrap.php';
 class FunctionalTest extends Tester\TestCase
 {
 
-	/**
-	 * @var string
-	 */
+	/** @var string */
 	private $binary;