Skip to content

Commit 5892b06

Browse files
committed
minor #47390 [CS] Remove @inheritdoc PHPDoc (lyrixx)
This PR was merged into the 6.2 branch. Discussion ---------- [CS] Remove `@inheritdoc` PHPDoc | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | --- It looks like this PHP Doc is useless. IDEs are able to inherit the doc (at least VS Code and PHP Storm). And tools like PHP Stan are able to too https://phpstan.org/r/74a2c008-ff2b-42c0-8edf-8da87c1a7b5f I could have open an RFC before doing the PR, but it was easy :) So let's discuss here Commits ------- 015d5015e3 [CS] Remove `@inheritdoc` PHPDoc
2 parents 3996def + aa35a62 commit 5892b06

File tree

56 files changed

+0
-571
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+0
-571
lines changed

CacheWarmer/CompiledClassMetadataCacheWarmer.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,6 @@ public function __construct(array $classesToCompile, ClassMetadataFactoryInterfa
3737
$this->filesystem = $filesystem;
3838
}
3939

40-
/**
41-
* {@inheritdoc}
42-
*/
4340
public function warmUp(string $cacheDir): array
4441
{
4542
$metadatas = [];
@@ -55,9 +52,6 @@ public function warmUp(string $cacheDir): array
5552
return [];
5653
}
5754

58-
/**
59-
* {@inheritdoc}
60-
*/
6155
public function isOptional(): bool
6256
{
6357
return true;

DataCollector/SerializerDataCollector.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,11 @@ public function reset(): void
3333
$this->collected = [];
3434
}
3535

36-
/**
37-
* {@inheritDoc}
38-
*/
3936
public function collect(Request $request, Response $response, \Throwable $exception = null): void
4037
{
4138
// Everything is collected during the request, and formatted on kernel terminate.
4239
}
4340

44-
/**
45-
* {@inheritDoc}
46-
*/
4741
public function getName(): string
4842
{
4943
return 'serializer';
@@ -164,9 +158,6 @@ public function collectDecoding(string $traceId, string $encoder, float $time):
164158
$this->collected[$traceId]['encoding'][] = compact('encoder', 'method', 'time');
165159
}
166160

167-
/**
168-
* {@inheritDoc}
169-
*/
170161
public function lateCollect(): void
171162
{
172163
$this->data = [

Debug/TraceableEncoder.php

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,6 @@ public function __construct(
3333
) {
3434
}
3535

36-
/**
37-
* {@inheritDoc}
38-
*/
3936
public function encode(mixed $data, string $format, array $context = []): string
4037
{
4138
if (!$this->encoder instanceof EncoderInterface) {
@@ -53,9 +50,6 @@ public function encode(mixed $data, string $format, array $context = []): string
5350
return $encoded;
5451
}
5552

56-
/**
57-
* {@inheritDoc}
58-
*/
5953
public function supportsEncoding(string $format, array $context = []): bool
6054
{
6155
if (!$this->encoder instanceof EncoderInterface) {
@@ -65,9 +59,6 @@ public function supportsEncoding(string $format, array $context = []): bool
6559
return $this->encoder->supportsEncoding($format, $context);
6660
}
6761

68-
/**
69-
* {@inheritDoc}
70-
*/
7162
public function decode(string $data, string $format, array $context = []): mixed
7263
{
7364
if (!$this->encoder instanceof DecoderInterface) {
@@ -85,9 +76,6 @@ public function decode(string $data, string $format, array $context = []): mixed
8576
return $encoded;
8677
}
8778

88-
/**
89-
* {@inheritDoc}
90-
*/
9179
public function supportsDecoding(string $format, array $context = []): bool
9280
{
9381
if (!$this->encoder instanceof DecoderInterface) {
@@ -97,9 +85,6 @@ public function supportsDecoding(string $format, array $context = []): bool
9785
return $this->encoder->supportsDecoding($format, $context);
9886
}
9987

100-
/**
101-
* {@inheritDoc}
102-
*/
10388
public function setSerializer(SerializerInterface $serializer)
10489
{
10590
if (!$this->encoder instanceof SerializerAwareInterface) {

Debug/TraceableNormalizer.php

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,6 @@ public function __construct(
3535
) {
3636
}
3737

38-
/**
39-
* {@inheritDoc}
40-
*/
4138
public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
4239
{
4340
if (!$this->normalizer instanceof NormalizerInterface) {
@@ -55,9 +52,6 @@ public function normalize(mixed $object, string $format = null, array $context =
5552
return $normalized;
5653
}
5754

58-
/**
59-
* {@inheritDoc}
60-
*/
6155
public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
6256
{
6357
if (!$this->normalizer instanceof NormalizerInterface) {
@@ -67,9 +61,6 @@ public function supportsNormalization(mixed $data, string $format = null, array
6761
return $this->normalizer->supportsNormalization($data, $format, $context);
6862
}
6963

70-
/**
71-
* {@inheritDoc}
72-
*/
7364
public function denormalize(mixed $data, string $type, string $format = null, array $context = []): mixed
7465
{
7566
if (!$this->normalizer instanceof DenormalizerInterface) {
@@ -87,9 +78,6 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
8778
return $denormalized;
8879
}
8980

90-
/**
91-
* {@inheritDoc}
92-
*/
9381
public function supportsDenormalization(mixed $data, string $type, string $format = null, array $context = []): bool
9482
{
9583
if (!$this->normalizer instanceof DenormalizerInterface) {
@@ -99,9 +87,6 @@ public function supportsDenormalization(mixed $data, string $type, string $forma
9987
return $this->normalizer->supportsDenormalization($data, $type, $format, $context);
10088
}
10189

102-
/**
103-
* {@inheritDoc}
104-
*/
10590
public function setSerializer(SerializerInterface $serializer)
10691
{
10792
if (!$this->normalizer instanceof SerializerAwareInterface) {
@@ -111,9 +96,6 @@ public function setSerializer(SerializerInterface $serializer)
11196
$this->normalizer->setSerializer($serializer);
11297
}
11398

114-
/**
115-
* {@inheritDoc}
116-
*/
11799
public function setNormalizer(NormalizerInterface $normalizer)
118100
{
119101
if (!$this->normalizer instanceof NormalizerAwareInterface) {
@@ -123,9 +105,6 @@ public function setNormalizer(NormalizerInterface $normalizer)
123105
$this->normalizer->setNormalizer($normalizer);
124106
}
125107

126-
/**
127-
* {@inheritDoc}
128-
*/
129108
public function setDenormalizer(DenormalizerInterface $denormalizer)
130109
{
131110
if (!$this->normalizer instanceof DenormalizerAwareInterface) {
@@ -135,9 +114,6 @@ public function setDenormalizer(DenormalizerInterface $denormalizer)
135114
$this->normalizer->setDenormalizer($denormalizer);
136115
}
137116

138-
/**
139-
* {@inheritDoc}
140-
*/
141117
public function hasCacheableSupportsMethod(): bool
142118
{
143119
return $this->normalizer instanceof CacheableSupportsMethodInterface && $this->normalizer->hasCacheableSupportsMethod();

Debug/TraceableSerializer.php

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@ public function __construct(
3838
) {
3939
}
4040

41-
/**
42-
* {@inheritdoc}
43-
*/
4441
public function serialize(mixed $data, string $format, array $context = []): string
4542
{
4643
$context[self::DEBUG_TRACE_ID] = $traceId = uniqid();
@@ -56,9 +53,6 @@ public function serialize(mixed $data, string $format, array $context = []): str
5653
return $result;
5754
}
5855

59-
/**
60-
* {@inheritdoc}
61-
*/
6256
public function deserialize(mixed $data, string $type, string $format, array $context = []): mixed
6357
{
6458
$context[self::DEBUG_TRACE_ID] = $traceId = uniqid();
@@ -74,9 +68,6 @@ public function deserialize(mixed $data, string $type, string $format, array $co
7468
return $result;
7569
}
7670

77-
/**
78-
* {@inheritdoc}
79-
*/
8071
public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
8172
{
8273
$context[self::DEBUG_TRACE_ID] = $traceId = uniqid();
@@ -92,9 +83,6 @@ public function normalize(mixed $object, string $format = null, array $context =
9283
return $result;
9384
}
9485

95-
/**
96-
* {@inheritdoc}
97-
*/
9886
public function denormalize(mixed $data, string $type, string $format = null, array $context = []): mixed
9987
{
10088
$context[self::DEBUG_TRACE_ID] = $traceId = uniqid();
@@ -110,9 +98,6 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
11098
return $result;
11199
}
112100

113-
/**
114-
* {@inheritdoc}
115-
*/
116101
public function encode(mixed $data, string $format, array $context = []): string
117102
{
118103
$context[self::DEBUG_TRACE_ID] = $traceId = uniqid();
@@ -128,9 +113,6 @@ public function encode(mixed $data, string $format, array $context = []): string
128113
return $result;
129114
}
130115

131-
/**
132-
* {@inheritdoc}
133-
*/
134116
public function decode(string $data, string $format, array $context = []): mixed
135117
{
136118
$context[self::DEBUG_TRACE_ID] = $traceId = uniqid();
@@ -146,33 +128,21 @@ public function decode(string $data, string $format, array $context = []): mixed
146128
return $result;
147129
}
148130

149-
/**
150-
* {@inheritdoc}
151-
*/
152131
public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
153132
{
154133
return $this->serializer->supportsNormalization($data, $format, $context);
155134
}
156135

157-
/**
158-
* {@inheritdoc}
159-
*/
160136
public function supportsDenormalization(mixed $data, string $type, string $format = null, array $context = []): bool
161137
{
162138
return $this->serializer->supportsDenormalization($data, $type, $format, $context);
163139
}
164140

165-
/**
166-
* {@inheritdoc}
167-
*/
168141
public function supportsEncoding(string $format, array $context = []): bool
169142
{
170143
return $this->serializer->supportsEncoding($format, $context);
171144
}
172145

173-
/**
174-
* {@inheritdoc}
175-
*/
176146
public function supportsDecoding(string $format, array $context = []): bool
177147
{
178148
return $this->serializer->supportsDecoding($format, $context);

Encoder/ChainDecoder.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,11 @@ public function __construct(array $decoders = [])
3232
$this->decoders = $decoders;
3333
}
3434

35-
/**
36-
* {@inheritdoc}
37-
*/
3835
final public function decode(string $data, string $format, array $context = []): mixed
3936
{
4037
return $this->getDecoder($format, $context)->decode($data, $format, $context);
4138
}
4239

43-
/**
44-
* {@inheritdoc}
45-
*/
4640
public function supportsDecoding(string $format, array $context = []): bool
4741
{
4842
try {

Encoder/ChainEncoder.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,11 @@ public function __construct(array $encoders = [])
3333
$this->encoders = $encoders;
3434
}
3535

36-
/**
37-
* {@inheritdoc}
38-
*/
3936
final public function encode(mixed $data, string $format, array $context = []): string
4037
{
4138
return $this->getEncoder($format, $context)->encode($data, $format, $context);
4239
}
4340

44-
/**
45-
* {@inheritdoc}
46-
*/
4741
public function supportsEncoding(string $format, array $context = []): bool
4842
{
4943
try {

Encoder/ContextAwareDecoderInterface.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@
2121
interface ContextAwareDecoderInterface extends DecoderInterface
2222
{
2323
/**
24-
* {@inheritdoc}
25-
*
2624
* @param array $context options that decoders have access to
2725
*/
2826
public function supportsDecoding(string $format, array $context = []): bool;

Encoder/ContextAwareEncoderInterface.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@
2121
interface ContextAwareEncoderInterface extends EncoderInterface
2222
{
2323
/**
24-
* {@inheritdoc}
25-
*
2624
* @param array $context options that encoders have access to
2725
*/
2826
public function supportsEncoding(string $format, array $context = []): bool;

Encoder/CsvEncoder.php

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,6 @@ public function __construct(array $defaultContext = [])
5656
$this->defaultContext = array_merge($this->defaultContext, $defaultContext);
5757
}
5858

59-
/**
60-
* {@inheritdoc}
61-
*/
6259
public function encode(mixed $data, string $format, array $context = []): string
6360
{
6461
$handle = fopen('php://temp,', 'w+');
@@ -123,18 +120,13 @@ public function encode(mixed $data, string $format, array $context = []): string
123120
}
124121

125122
/**
126-
* {@inheritdoc}
127-
*
128123
* @param array $context
129124
*/
130125
public function supportsEncoding(string $format /* , array $context = [] */): bool
131126
{
132127
return self::FORMAT === $format;
133128
}
134129

135-
/**
136-
* {@inheritdoc}
137-
*/
138130
public function decode(string $data, string $format, array $context = []): mixed
139131
{
140132
$handle = fopen('php://temp', 'r+');
@@ -211,8 +203,6 @@ public function decode(string $data, string $format, array $context = []): mixed
211203
}
212204

213205
/**
214-
* {@inheritdoc}
215-
*
216206
* @param array $context
217207
*/
218208
public function supportsDecoding(string $format /* , array $context = [] */): bool

0 commit comments

Comments
 (0)