Skip to content

Commit 0a58ff5

Browse files
gapplegapple
committed
Cleanup PHPDoc types covered by type hints
1 parent fd43948 commit 0a58ff5

10 files changed

+5
-43
lines changed

‎src/Dictionary.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ public static function fromArray(array $array): self
3737
}
3838

3939
/**
40-
* @param string $name
4140
* @return TupleInterface|array{mixed, object}|null
4241
*/
4342
public function __get(string $name): mixed
@@ -46,9 +45,7 @@ public function __get(string $name): mixed
4645
}
4746

4847
/**
49-
* @param string $name
5048
* @param TupleInterface|array{mixed, object} $value
51-
* @return void
5249
*/
5350
public function __set(string $name, mixed $value): void
5451
{

‎src/InnerList.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ class InnerList implements TupleInterface
1010

1111
/**
1212
* @param array<TupleInterface|array{mixed, object}> $value
13-
* @param object|null $parameters
1413
*/
1514
public function __construct(array $value, ?object $parameters = null)
1615
{
@@ -25,11 +24,10 @@ public function __construct(array $value, ?object $parameters = null)
2524
*
2625
* @param array<mixed> $array
2726
* An array of bare items or TupleInterface objects.
28-
* @return InnerList
2927
*/
3028
public static function fromArray(array $array): InnerList
3129
{
32-
array_walk($array, function (&$item) {
30+
array_walk($array, function (&$item): void {
3331
if (!$item instanceof TupleInterface) {
3432
$item = new Item($item);
3533
} elseif ($item instanceof InnerList) {
@@ -43,7 +41,6 @@ public static function fromArray(array $array): InnerList
4341

4442
/**
4543
* @param TupleInterface|array{mixed, object} $value
46-
* @return void
4744
*/
4845
private static function validateItemType(mixed $value): void
4946
{

‎src/Item.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ class Item implements TupleInterface
88
{
99
use TupleTrait;
1010

11-
/**
12-
* @param mixed $value
13-
* @param object|null $parameters
14-
*/
1511
public function __construct(mixed $value, ?object $parameters = null)
1612
{
1713
$this->value = $value;

‎src/OuterList.php

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,10 @@ public function __construct(array $value = [])
3131
* Create an OuterList from an array of bare values.
3232
*
3333
* @param array<mixed> $array
34-
* @return OuterList
3534
*/
3635
public static function fromArray(array $array): OuterList
3736
{
38-
array_walk($array, function (&$item) {
37+
array_walk($array, function (&$item): void {
3938
if (!$item instanceof TupleInterface) {
4039
if (is_array($item)) {
4140
$item = InnerList::fromArray($item);
@@ -51,7 +50,6 @@ public static function fromArray(array $array): OuterList
5150

5251
/**
5352
* @param TupleInterface|array{mixed, object} $value
54-
* @return void
5553
*/
5654
private static function validateItemType(mixed $value): void
5755
{
@@ -77,7 +75,6 @@ public function getIterator(): \Iterator
7775

7876
/**
7977
* @param int $offset
80-
* @return bool
8178
*/
8279
public function offsetExists($offset): bool
8380
{
@@ -86,7 +83,6 @@ public function offsetExists($offset): bool
8683

8784
/**
8885
* @param int $offset
89-
* @return mixed
9086
* @phpstan-return TupleInterface|array{mixed, object}|null
9187
*/
9288
public function offsetGet($offset): mixed
@@ -97,7 +93,6 @@ public function offsetGet($offset): mixed
9793
/**
9894
* @param int|null $offset
9995
* @param TupleInterface|array{mixed, object} $value
100-
* @return void
10196
*/
10297
public function offsetSet($offset, $value): void
10398
{
@@ -112,7 +107,6 @@ public function offsetSet($offset, $value): void
112107

113108
/**
114109
* @param int $offset
115-
* @return void
116110
*/
117111
public function offsetUnset($offset): void
118112
{

‎src/Parameters.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,11 @@ public static function fromArray(array $array): self
2626
return $parameters;
2727
}
2828

29-
/**
30-
* @param string $name
31-
* @return mixed|null
32-
*/
3329
public function __get(string $name): mixed
3430
{
3531
return $this->value[$name] ?? null;
3632
}
3733

38-
/**
39-
* @param string $name
40-
* @param mixed $value
41-
* @return void
42-
*/
4334
public function __set(string $name, mixed $value): void
4435
{
4536
$this->value[$name] = $value;

‎src/Parser.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,6 @@ private static function parseInnerList(ParsingInput $input): InnerList
124124
}
125125

126126
/**
127-
* @param string $string
128-
*
129127
* @return Item
130128
* A [value, parameters] tuple.
131129
*/

‎src/ParsingInput.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ public function remainingLength(): int
4444
* @param bool $ows
4545
* Whether all Optional Whitespace characters should be trimmed. If false, only space characters are trimmed.
4646
* @see https://tools.ietf.org/html/rfc7230#section-3.2.3
47-
* @return void
4847
*/
4948
public function trim(bool $ows = false): void
5049
{

‎src/Serializer.php

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,10 @@ class Serializer
99
/**
1010
* Serialize an item with optional parameters.
1111
*
12-
* @param mixed $value
12+
* @param Item|mixed $value
1313
* A bare value, or an Item object.
1414
* @param object|null $parameters
15-
* An optional object containing parameter values if a bare value is provided.
16-
*
17-
* @return string
18-
* The serialized value.
15+
* If a bare value is provided, an optional object containing parameter values.
1916
*/
2017
public static function serializeItem(mixed $value, ?object $parameters = null): string
2118
{
@@ -43,7 +40,6 @@ public static function serializeItem(mixed $value, ?object $parameters = null):
4340

4441
/**
4542
* @param iterable<TupleInterface|array{mixed, object}> $value
46-
* @return string
4743
*/
4844
public static function serializeList(iterable $value): string
4945
{

‎src/TupleTrait.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ public function offsetExists($offset): bool
3939

4040
/**
4141
* @param 0|1 $offset
42-
* @return mixed
4342
* @phpstan-return ($offset is 0 ? mixed : $offset is 1 ? object : null)
4443
*/
4544
public function offsetGet($offset): mixed

‎tests/Httpwg/HttpwgRuleExpectedConverter.php

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ class HttpwgRuleExpectedConverter
2929
* Convert the expected value of an item tuple.
3030
*
3131
* @param ExpectedItem $item
32-
* @return Item
3332
*/
3433
public static function item(array $item): Item
3534
{
@@ -40,7 +39,6 @@ public static function item(array $item): Item
4039
* Convert the expected values of a dictionary.
4140
*
4241
* @param ExpectedDictionary $dictionary
43-
* @return Dictionary
4442
*/
4543
public static function dictionary(array $dictionary): Dictionary
4644
{
@@ -66,7 +64,6 @@ public static function dictionary(array $dictionary): Dictionary
6664
* Convert the expected values of a list.
6765
*
6866
* @param ExpectedOuterList $list
69-
* @return OuterList
7067
*/
7168
public static function list(array $list): OuterList
7269
{
@@ -86,8 +83,7 @@ public static function list(array $list): OuterList
8683
/**
8784
* Convert the expected values of a parameters map.
8885
*
89-
* @param ExpectedParameters $parameters
90-
* @return Parameters
86+
* @param ExpectedParameters $parameters
9187
*/
9288
private static function parameters(array $parameters): Parameters
9389
{
@@ -109,7 +105,6 @@ private static function parameters(array $parameters): Parameters
109105
* Convert the expected values of an inner list tuple.
110106
*
111107
* @param ExpectedInnerList $innerList
112-
* @return InnerList
113108
*/
114109
private static function innerList(array $innerList): InnerList
115110
{

0 commit comments

Comments
 (0)