Skip to content

Commit 33eff4d

Browse files
committed
ecs removed many param/return tags that are now explicit in the code;
1 parent 671dc2a commit 33eff4d

33 files changed

+27
-184
lines changed

src/phpDocumentor/Reflection/File/LocalFile.php

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ final class LocalFile implements File
2929

3030
/**
3131
* LocalFile constructor.
32-
* @param string $path
3332
*/
3433
public function __construct(string $path)
3534
{
@@ -38,8 +37,6 @@ public function __construct(string $path)
3837

3938
/**
4039
* Returns the content of the file as a string.
41-
*
42-
* @return string
4340
*/
4441
public function getContents(): string
4542
{
@@ -48,8 +45,6 @@ public function getContents(): string
4845

4946
/**
5047
* Returns md5 hash of the file.
51-
*
52-
* @return string
5348
*/
5449
public function md5(): string
5550
{
@@ -58,8 +53,6 @@ public function md5(): string
5853

5954
/**
6055
* Returns an relative path to the file.
61-
*
62-
* @return string
6356
*/
6457
public function path(): string
6558
{

src/phpDocumentor/Reflection/Middleware/ChainFactory.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@ final class ChainFactory
2020
{
2121
/**
2222
* @param Middleware[] $middlewareList
23-
*
2423
* @param callable $lastCallable
25-
* @return callable
2624
*/
2725
public static function createExecutionChain(array $middlewareList, callable $lastCallable): callable
2826
{

src/phpDocumentor/Reflection/NodeVisitor/ElementNameResolver.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,13 +105,12 @@ public function enterNode(Node $node): ?int
105105
$node->fqsen = new Fqsen($this->buildName());
106106
break;
107107
}
108+
108109
return null;
109110
}
110111

111112
/**
112113
* Resets the state of the object to an empty state.
113-
*
114-
* @param string $namespace
115114
*/
116115
private function resetState(string $namespace = null): void
117116
{
@@ -121,8 +120,6 @@ private function resetState(string $namespace = null): void
121120

122121
/**
123122
* Builds the name of the current node using the parts that are pushed to the parts list.
124-
*
125-
* @return null|string
126123
*/
127124
private function buildName(): ?string
128125
{

src/phpDocumentor/Reflection/Php/Argument.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,6 @@ final class Argument
3838

3939
/**
4040
* Initializes the object.
41-
*
42-
* @param string $name
43-
* @param string $default
44-
* @param bool $byReference
45-
* @param bool $isVariadic
4641
*/
4742
public function __construct(string $name, string $default = null, bool $byReference = false, bool $isVariadic = false)
4843
{
@@ -54,8 +49,6 @@ public function __construct(string $name, string $default = null, bool $byRefere
5449

5550
/**
5651
* Returns the name of this argument.
57-
*
58-
* @return string
5952
*/
6053
public function getName(): string
6154
{
@@ -97,8 +90,6 @@ public function isByReference(): bool
9790

9891
/**
9992
* Returns whether this argument represents a variadic argument.
100-
*
101-
* @return boolean
10293
*/
10394
public function isVariadic(): bool
10495
{

src/phpDocumentor/Reflection/Php/Class_.php

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,7 @@ final class Class_ implements Element
7070
/**
7171
* Initializes a number of properties with the given values. Others are initialized by definition.
7272
*
73-
* @param bool $abstract
74-
* @param bool $final
73+
*
7574
* @param Location|null $location
7675
*/
7776
public function __construct(
@@ -96,8 +95,6 @@ public function __construct(
9695

9796
/**
9897
* Returns true when this class is final. Otherwise returns false.
99-
*
100-
* @return bool
10198
*/
10299
public function isFinal(): bool
103100
{
@@ -106,8 +103,6 @@ public function isFinal(): bool
106103

107104
/**
108105
* Returns true when this class is abstract. Otherwise returns false.
109-
*
110-
* @return bool
111106
*/
112107
public function isAbstract(): bool
113108
{
@@ -116,8 +111,6 @@ public function isAbstract(): bool
116111

117112
/**
118113
* Returns the superclass this class is extending if available.
119-
*
120-
* @return null|Fqsen
121114
*/
122115
public function getParent(): ?Fqsen
123116
{
@@ -216,8 +209,6 @@ public function addUsedTrait(Fqsen $fqsen): void
216209

217210
/**
218211
* Returns the Fqsen of the element.
219-
*
220-
* @return Fqsen
221212
*/
222213
public function getFqsen(): Fqsen
223214
{
@@ -226,8 +217,6 @@ public function getFqsen(): Fqsen
226217

227218
/**
228219
* Returns the name of the element.
229-
*
230-
* @return string
231220
*/
232221
public function getName(): string
233222
{
@@ -242,9 +231,6 @@ public function getDocBlock(): ?DocBlock
242231
return $this->docBlock;
243232
}
244233

245-
/**
246-
* @return null|Location
247-
*/
248234
public function getLocation(): ?Location
249235
{
250236
return $this->location;

src/phpDocumentor/Reflection/Php/Constant.php

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ public function __construct(Fqsen $fqsen, DocBlock $docBlock = null, string $val
6464

6565
/**
6666
* Returns the value of this constant.
67-
*
68-
* @return null|string
6967
*/
7068
public function getValue(): ?string
7169
{
@@ -74,8 +72,6 @@ public function getValue(): ?string
7472

7573
/**
7674
* Returns the Fqsen of the element.
77-
*
78-
* @return Fqsen
7975
*/
8076
public function getFqsen(): Fqsen
8177
{
@@ -84,8 +80,6 @@ public function getFqsen(): Fqsen
8480

8581
/**
8682
* Returns the name of the element.
87-
*
88-
* @return string
8983
*/
9084
public function getName(): string
9185
{
@@ -94,17 +88,12 @@ public function getName(): string
9488

9589
/**
9690
* Returns DocBlock of this constant if available.
97-
*
98-
* @return null|DocBlock
9991
*/
10092
public function getDocBlock(): ?DocBlock
10193
{
10294
return $this->docBlock;
10395
}
10496

105-
/**
106-
* @return Location
107-
*/
10897
public function getLocation(): Location
10998
{
11099
return $this->location;

src/phpDocumentor/Reflection/Php/Factory/Argument.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ public function __construct(PrettyPrinter $prettyPrinter)
4545
/**
4646
* Returns true when the strategy is able to handle the object.
4747
*
48+
*
4849
* @param mixed $object object to check.
49-
* @return boolean
5050
*/
5151
public function matches($object): bool
5252
{

src/phpDocumentor/Reflection/Php/Factory/ClassConstantIterator.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ public function getLine(): int
5353

5454
/**
5555
* Returns the name of the current constant.
56-
*
57-
* @return string
5856
*/
5957
public function getName(): string
6058
{
@@ -63,8 +61,6 @@ public function getName(): string
6361

6462
/**
6563
* Returns the fqsen of the current constant.
66-
*
67-
* @return Fqsen
6864
*/
6965
public function getFqsen(): Fqsen
7066
{

src/phpDocumentor/Reflection/Php/Factory/Class_.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ final class Class_ extends AbstractFactory implements ProjectFactoryStrategy
3737
/**
3838
* Returns true when the strategy is able to handle the object.
3939
*
40+
*
4041
* @param mixed $object object to check.
41-
* @return boolean
4242
*/
4343
public function matches($object): bool
4444
{

src/phpDocumentor/Reflection/Php/Factory/Constant.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
use phpDocumentor\Reflection\PrettyPrinter;
2121
use phpDocumentor\Reflection\Types\Context;
2222

23-
2423
/**
2524
* Strategy to convert ClassConstantIterator to ConstantElement
2625
*
@@ -45,8 +44,8 @@ public function __construct(PrettyPrinter $prettyPrinter)
4544
/**
4645
* Returns true when the strategy is able to handle the object.
4746
*
47+
*
4848
* @param mixed $object object to check.
49-
* @return boolean
5049
*/
5150
public function matches($object): bool
5251
{

0 commit comments

Comments
 (0)