removed useless annotations @param and @return

nette · Jan 20, 2017 · b6341f0 · b6341f0
1 parent eca4ae2
commit b6341f0
Show file tree

Hide file tree

Showing 19 changed files with 70 additions and 375 deletions.
diff --git a/src/Iterators/CachingIterator.php b/src/Iterators/CachingIterator.php
@@ -56,29 +56,24 @@ public function __construct($iterator)
 
 	/**
 	 * Is the current element the first one?
-	 * @param  int  grid width
-	 * @return bool
 	 */
-	public function isFirst(int $width = NULL): bool
+	public function isFirst(int $gridWidth = NULL): bool
 	{
-		return $this->counter === 1 || ($width && $this->counter !== 0 && (($this->counter - 1) % $width) === 0);
+		return $this->counter === 1 || ($gridWidth && $this->counter !== 0 && (($this->counter - 1) % $gridWidth) === 0);
 	}
 
 
 	/**
 	 * Is the current element the last one?
-	 * @param  int  grid width
-	 * @return bool
 	 */
-	public function isLast(int $width = NULL): bool
+	public function isLast(int $gridWidth = NULL): bool
 	{
-		return !$this->hasNext() || ($width && ($this->counter % $width) === 0);
+		return !$this->hasNext() || ($gridWidth && ($this->counter % $gridWidth) === 0);
 	}
 
 
 	/**
 	 * Is the iterator empty?
-	 * @return bool
 	 */
 	public function isEmpty(): bool
 	{
@@ -88,7 +83,6 @@ public function isEmpty(): bool
 
 	/**
 	 * Is the counter odd?
-	 * @return bool
 	 */
 	public function isOdd(): bool
 	{
@@ -98,7 +92,6 @@ public function isOdd(): bool
 
 	/**
 	 * Is the counter even?
-	 * @return bool
 	 */
 	public function isEven(): bool
 	{
@@ -108,7 +101,6 @@ public function isEven(): bool
 
 	/**
 	 * Returns the counter.
-	 * @return int
 	 */
 	public function getCounter(): int
 	{
@@ -118,7 +110,6 @@ public function getCounter(): int
 
 	/**
 	 * Returns the count of elements.
-	 * @return int
 	 */
 	public function count(): int
 	{

diff --git a/src/Utils/ArrayHash.php b/src/Utils/ArrayHash.php
@@ -19,8 +19,6 @@ class ArrayHash extends \stdClass implements \ArrayAccess, \Countable, \Iterator
 {
 
 	/**
-	 * @param  array to wrap
-	 * @param  bool
 	 * @return static
 	 */
 	public static function from(array $arr, bool $recursive = TRUE): self
@@ -39,7 +37,6 @@ public static function from(array $arr, bool $recursive = TRUE): self
 
 	/**
 	 * Returns an iterator over all items.
-	 * @return \RecursiveArrayIterator
 	 */
 	public function getIterator(): \RecursiveArrayIterator
 	{
@@ -49,7 +46,6 @@ public function getIterator(): \RecursiveArrayIterator
 
 	/**
 	 * Returns items count.
-	 * @return int
 	 */
 	public function count(): int
 	{
@@ -82,7 +78,6 @@ public function offsetGet($key)
 
 	/**
 	 * Determines whether a item exists.
-	 * @return bool
 	 */
 	public function offsetExists($key): bool
 	{

diff --git a/src/Utils/ArrayList.php b/src/Utils/ArrayList.php
@@ -24,7 +24,6 @@ class ArrayList implements \ArrayAccess, \Countable, \IteratorAggregate
 
 	/**
 	 * Returns an iterator over all items.
-	 * @return \ArrayIterator
 	 */
 	public function getIterator(): \ArrayIterator
 	{
@@ -34,7 +33,6 @@ public function getIterator(): \ArrayIterator
 
 	/**
 	 * Returns items count.
-	 * @return int
 	 */
 	public function count(): int
 	{
@@ -45,7 +43,6 @@ public function count(): int
 	/**
 	 * Replaces or appends a item.
 	 * @param  int|NULL
-	 * @param  mixed
 	 * @return void
 	 * @throws Nette\OutOfRangeException
 	 */
@@ -81,7 +78,6 @@ public function offsetGet($index)
 	/**
 	 * Determines whether a item exists.
 	 * @param  int
-	 * @return bool
 	 */
 	public function offsetExists($index): bool
 	{
@@ -106,7 +102,6 @@ public function offsetUnset($index)
 
 	/**
 	 * Prepends a item.
-	 * @param  mixed
 	 * @return void
 	 */
 	public function prepend($value)

diff --git a/src/Utils/Arrays.php b/src/Utils/Arrays.php
@@ -22,9 +22,7 @@ class Arrays
 
 	/**
 	 * Returns item from array or $default if item is not set.
-	 * @param  array
-	 * @param  string|int|array one or more keys
-	 * @param  mixed
+	 * @param  string|int|array $key one or more keys
 	 * @return mixed
 	 * @throws Nette\InvalidArgumentException if item does not exist and default value is not provided
 	 */
@@ -46,8 +44,7 @@ public static function get(array $arr, $key, $default = NULL)
 
 	/**
 	 * Returns reference to array item.
-	 * @param  array
-	 * @param  string|int|array one or more keys
+	 * @param  string|int|array $key one or more keys
 	 * @return mixed
 	 * @throws Nette\InvalidArgumentException if traversed item is not an array
 	 */
@@ -66,7 +63,6 @@ public static function &getRef(array &$arr, $key)
 
 	/**
 	 * Recursively appends elements of remaining keys from the second array to the first.
-	 * @return array
 	 */
 	public static function mergeTree(array $arr1, array $arr2): array
 	{
@@ -131,7 +127,6 @@ public static function renameKey(array &$arr, $oldKey, $newKey)
 
 	/**
 	 * Returns array entries that match the pattern.
-	 * @return array
 	 */
 	public static function grep(array $arr, string $pattern, int $flags = 0): array
 	{
@@ -141,7 +136,6 @@ public static function grep(array $arr, string $pattern, int $flags = 0): array
 
 	/**
 	 * Returns flattened array.
-	 * @return array
 	 */
 	public static function flatten(array $arr, bool $preserveKeys = FALSE): array
 	{
@@ -156,7 +150,6 @@ public static function flatten(array $arr, bool $preserveKeys = FALSE): array
 
 	/**
 	 * Finds whether a variable is a zero-based integer indexed array.
-	 * @return bool
 	 */
 	public static function isList($value): bool
 	{
@@ -218,7 +211,6 @@ public static function associate(array $arr, $path)
 
 	/**
 	 * Normalizes to associative array.
-	 * @return array
 	 */
 	public static function normalize(array $arr, $filling = NULL): array
 	{
@@ -232,9 +224,7 @@ public static function normalize(array $arr, $filling = NULL): array
 
 	/**
 	 * Picks element from the array by key and return its value.
-	 * @param  array
-	 * @param  string|int array key
-	 * @param  mixed
+	 * @param  string|int $key array key
 	 * @return mixed
 	 * @throws Nette\InvalidArgumentException if item does not exist and default value is not provided
 	 */
@@ -256,7 +246,6 @@ public static function pick(array &$arr, $key, $default = NULL)
 
 	/**
 	 * Tests whether some element in the array passes the callback test.
-	 * @return bool
 	 */
 	public static function some(array $arr, callable $callback): bool
 	{
@@ -271,7 +260,6 @@ public static function some(array $arr, callable $callback): bool
 
 	/**
 	 * Tests whether all elements in the array pass the callback test.
-	 * @return bool
 	 */
 	public static function every(array $arr, callable $callback): bool
 	{
@@ -286,7 +274,6 @@ public static function every(array $arr, callable $callback): bool
 
 	/**
 	 * Applies the callback to the elements of the array.
-	 * @return array
 	 */
 	public static function map(array $arr, callable $callback): array
 	{

diff --git a/src/Utils/Callback.php b/src/Utils/Callback.php
@@ -21,14 +21,12 @@ class Callback
 	use Nette\StaticClass;
 
 	/**
-	 * @param  mixed   class, object, callable
-	 * @param  string  method
-	 * @return \Closure
+	 * @param  string|object|callable  class, object, callable
 	 */
-	public static function closure($callable, string $m = NULL): \Closure
+	public static function closure($callable, string $method = NULL): \Closure
 	{
-		if ($m !== NULL) {
-			$callable = [$callable, $m];
+		if ($method !== NULL) {
+			$callable = [$callable, $method];
 
 		} elseif (is_string($callable) && count($tmp = explode('::', $callable)) === 2) {
 			$callable = $tmp;
@@ -79,7 +77,6 @@ public static function invokeArgs($callable, array $args = [])
 
 	/**
 	 * Invokes internal PHP function with own error handler.
-	 * @param  string
 	 * @return mixed
 	 */
 	public static function invokeSafe(string $function, array $args, callable $onError)
@@ -120,9 +117,6 @@ public static function check($callable, bool $syntax = FALSE)
 	}
 
 
-	/**
-	 * @return string
-	 */
 	public static function toString($callable): string
 	{
 		if ($callable instanceof \Closure) {
@@ -160,9 +154,6 @@ public static function toReflection($callable)
 	}
 
 
-	/**
-	 * @return bool
-	 */
 	public static function isStatic(callable $callable): bool
 	{
 		return is_array($callable) ? is_string($callable[0]) : is_string($callable);
@@ -172,7 +163,6 @@ public static function isStatic(callable $callable): bool
 	/**
 	 * Unwraps closure created by self::closure()
 	 * @internal
-	 * @return callable
 	 */
 	public static function unwrap(\Closure $closure): callable
 	{

diff --git a/src/Utils/DateTime.php b/src/Utils/DateTime.php
@@ -74,17 +74,13 @@ public static function fromParts(int $year, int $month, int $day, int $hour = 0,
 	}
 
 
-	/**
-	 * @return string
-	 */
 	public function __toString(): string
 	{
 		return $this->format('Y-m-d H:i:s');
 	}
 
 
 	/**
-	 * @param  string
 	 * @return static
 	 */
 	public function modifyClone(string $modify = ''): self
@@ -118,9 +114,9 @@ public function getTimestamp()
 
 	/**
 	 * Returns new DateTime object formatted according to the specified format.
-	 * @param string The format the $time parameter should be in
-	 * @param string String representing the time
-	 * @param string|\DateTimeZone desired timezone (default timezone is used if NULL is passed)
+	 * @param  string The format the $time parameter should be in
+	 * @param  string String representing the time
+	 * @param  string|\DateTimeZone desired timezone (default timezone is used if NULL is passed)
 	 * @return static|FALSE
 	 */
 	public static function createFromFormat($format, $time, $timezone = NULL)
@@ -142,7 +138,6 @@ public static function createFromFormat($format, $time, $timezone = NULL)
 
 	/**
 	 * Returns JSON representation in ISO 8601 (used by JavaScript).
-	 * @return string
 	 */
 	public function jsonSerialize(): string
 	{

diff --git a/src/Utils/FileSystem.php b/src/Utils/FileSystem.php
@@ -117,7 +117,6 @@ public static function rename(string $name, string $newName, bool $overwrite = T
 
 	/**
 	 * Reads file content.
-	 * @return string
 	 * @throws Nette\IOException
 	 */
 	public static function read(string $file): string
@@ -149,7 +148,6 @@ public static function write(string $file, string $content, int $mode = 0666)
 
 	/**
 	 * Is path absolute?
-	 * @return bool
 	 */
 	public static function isAbsolute(string $path): bool
 	{