Skip to content

Commit 57ef7d3

Browse files
fabpotfabpot
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 083ba7f + fb7ade8 commit 57ef7d3

Some content is hidden

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

49 files changed

+0
-301
lines changed

‎CacheWarmer/AbstractPhpFileCacheWarmer.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,12 @@ public function __construct(string $phpArrayFile)
2929
$this->phpArrayFile = $phpArrayFile;
3030
}
3131

32-
/**
33-
* {@inheritdoc}
34-
*/
3532
public function isOptional(): bool
3633
{
3734
return true;
3835
}
3936

4037
/**
41-
* {@inheritdoc}
42-
*
4338
* @return string[] A list of classes to preload on PHP 7.4+
4439
*/
4540
public function warmUp(string $cacheDir): array

‎CacheWarmer/AnnotationsCacheWarmer.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,6 @@ public function __construct(Reader $annotationReader, string $phpArrayFile, stri
4040
$this->debug = $debug;
4141
}
4242

43-
/**
44-
* {@inheritdoc}
45-
*/
4643
protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool
4744
{
4845
$annotatedClassPatterns = $cacheDir.'/annotations.map';

‎CacheWarmer/CachePoolClearerCacheWarmer.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ public function __construct(Psr6CacheClearer $poolClearer, array $pools = [])
3838
}
3939

4040
/**
41-
* {@inheritdoc}
42-
*
4341
* @return string[]
4442
*/
4543
public function warmUp(string $cacheDirectory): array
@@ -53,9 +51,6 @@ public function warmUp(string $cacheDirectory): array
5351
return [];
5452
}
5553

56-
/**
57-
* {@inheritdoc}
58-
*/
5954
public function isOptional(): bool
6055
{
6156
// optional cache warmers are not run when handling the request

‎CacheWarmer/ConfigBuilderCacheWarmer.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ public function __construct(KernelInterface $kernel, LoggerInterface $logger = n
3838
}
3939

4040
/**
41-
* {@inheritdoc}
42-
*
4341
* @return string[]
4442
*/
4543
public function warmUp(string $cacheDir): array
@@ -79,9 +77,6 @@ private function dumpExtension(ExtensionInterface $extension, ConfigBuilderGener
7977
$generator->build($configuration);
8078
}
8179

82-
/**
83-
* {@inheritdoc}
84-
*/
8580
public function isOptional(): bool
8681
{
8782
return true;

‎CacheWarmer/RouterCacheWarmer.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,6 @@ public function __construct(ContainerInterface $container)
3434
$this->container = $container;
3535
}
3636

37-
/**
38-
* {@inheritdoc}
39-
*/
4037
public function warmUp(string $cacheDir): array
4138
{
4239
$router = $this->container->get('router');
@@ -48,17 +45,11 @@ public function warmUp(string $cacheDir): array
4845
throw new \LogicException(sprintf('The router "%s" cannot be warmed up because it does not implement "%s".', get_debug_type($router), WarmableInterface::class));
4946
}
5047

51-
/**
52-
* {@inheritdoc}
53-
*/
5448
public function isOptional(): bool
5549
{
5650
return true;
5751
}
5852

59-
/**
60-
* {@inheritdoc}
61-
*/
6253
public static function getSubscribedServices(): array
6354
{
6455
return [

‎CacheWarmer/SerializerCacheWarmer.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@ public function __construct(array $loaders, string $phpArrayFile)
3939
$this->loaders = $loaders;
4040
}
4141

42-
/**
43-
* {@inheritdoc}
44-
*/
4542
protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool
4643
{
4744
if (!class_exists(CacheClassMetadataFactory::class) || !method_exists(XmlFileLoader::class, 'getMappedClasses') || !method_exists(YamlFileLoader::class, 'getMappedClasses')) {

‎CacheWarmer/TranslationsCacheWarmer.php

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ public function __construct(ContainerInterface $container)
3434
}
3535

3636
/**
37-
* {@inheritdoc}
38-
*
3937
* @return string[]
4038
*/
4139
public function warmUp(string $cacheDir): array
@@ -49,17 +47,11 @@ public function warmUp(string $cacheDir): array
4947
return [];
5048
}
5149

52-
/**
53-
* {@inheritdoc}
54-
*/
5550
public function isOptional(): bool
5651
{
5752
return true;
5853
}
5954

60-
/**
61-
* {@inheritdoc}
62-
*/
6355
public static function getSubscribedServices(): array
6456
{
6557
return [

‎CacheWarmer/ValidatorCacheWarmer.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@ public function __construct(ValidatorBuilder $validatorBuilder, string $phpArray
3939
$this->validatorBuilder = $validatorBuilder;
4040
}
4141

42-
/**
43-
* {@inheritdoc}
44-
*/
4542
protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool
4643
{
4744
if (!method_exists($this->validatorBuilder, 'getLoaders')) {

‎Command/AboutCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@
3131
#[AsCommand(name: 'about', description: 'Display information about the current project')]
3232
class AboutCommand extends Command
3333
{
34-
/**
35-
* {@inheritdoc}
36-
*/
3734
protected function configure()
3835
{
3936
$this
@@ -47,9 +44,6 @@ protected function configure()
4744
;
4845
}
4946

50-
/**
51-
* {@inheritdoc}
52-
*/
5347
protected function execute(InputInterface $input, OutputInterface $output): int
5448
{
5549
$io = new SymfonyStyle($input, $output);

‎Command/AssetsInstallCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,6 @@ public function __construct(Filesystem $filesystem, string $projectDir)
5252
$this->projectDir = $projectDir;
5353
}
5454

55-
/**
56-
* {@inheritdoc}
57-
*/
5855
protected function configure()
5956
{
6057
$this
@@ -87,9 +84,6 @@ protected function configure()
8784
;
8885
}
8986

90-
/**
91-
* {@inheritdoc}
92-
*/
9387
protected function execute(InputInterface $input, OutputInterface $output): int
9488
{
9589
/** @var KernelInterface $kernel */

‎Command/CacheClearCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,6 @@ public function __construct(CacheClearerInterface $cacheClearer, Filesystem $fil
4848
$this->filesystem = $filesystem ?? new Filesystem();
4949
}
5050

51-
/**
52-
* {@inheritdoc}
53-
*/
5451
protected function configure()
5552
{
5653
$this
@@ -69,9 +66,6 @@ protected function configure()
6966
;
7067
}
7168

72-
/**
73-
* {@inheritdoc}
74-
*/
7569
protected function execute(InputInterface $input, OutputInterface $output): int
7670
{
7771
$fs = $this->filesystem;

‎Command/CachePoolClearCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,6 @@ public function __construct(Psr6CacheClearer $poolClearer, array $poolNames = nu
4545
$this->poolNames = $poolNames;
4646
}
4747

48-
/**
49-
* {@inheritdoc}
50-
*/
5148
protected function configure()
5249
{
5350
$this
@@ -63,9 +60,6 @@ protected function configure()
6360
;
6461
}
6562

66-
/**
67-
* {@inheritdoc}
68-
*/
6963
protected function execute(InputInterface $input, OutputInterface $output): int
7064
{
7165
$io = new SymfonyStyle($input, $output);

‎Command/CachePoolDeleteCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ public function __construct(Psr6CacheClearer $poolClearer, array $poolNames = nu
4343
$this->poolNames = $poolNames;
4444
}
4545

46-
/**
47-
* {@inheritdoc}
48-
*/
4946
protected function configure()
5047
{
5148
$this
@@ -62,9 +59,6 @@ protected function configure()
6259
;
6360
}
6461

65-
/**
66-
* {@inheritdoc}
67-
*/
6862
protected function execute(InputInterface $input, OutputInterface $output): int
6963
{
7064
$io = new SymfonyStyle($input, $output);

‎Command/CachePoolInvalidateTagsCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,6 @@ public function __construct(ServiceProviderInterface $pools)
4141
$this->poolNames = array_keys($pools->getProvidedServices());
4242
}
4343

44-
/**
45-
* {@inheritdoc}
46-
*/
4744
protected function configure(): void
4845
{
4946
$this
@@ -59,9 +56,6 @@ protected function configure(): void
5956
;
6057
}
6158

62-
/**
63-
* {@inheritdoc}
64-
*/
6559
protected function execute(InputInterface $input, OutputInterface $output): int
6660
{
6761
$io = new SymfonyStyle($input, $output);

‎Command/CachePoolListCommand.php

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

40-
/**
41-
* {@inheritdoc}
42-
*/
4340
protected function configure()
4441
{
4542
$this
@@ -50,9 +47,6 @@ protected function configure()
5047
;
5148
}
5249

53-
/**
54-
* {@inheritdoc}
55-
*/
5650
protected function execute(InputInterface $input, OutputInterface $output): int
5751
{
5852
$io = new SymfonyStyle($input, $output);

‎Command/CachePoolPruneCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@ public function __construct(iterable $pools)
3838
$this->pools = $pools;
3939
}
4040

41-
/**
42-
* {@inheritdoc}
43-
*/
4441
protected function configure()
4542
{
4643
$this
@@ -53,9 +50,6 @@ protected function configure()
5350
;
5451
}
5552

56-
/**
57-
* {@inheritdoc}
58-
*/
5953
protected function execute(InputInterface $input, OutputInterface $output): int
6054
{
6155
$io = new SymfonyStyle($input, $output);

‎Command/CacheWarmupCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@ public function __construct(CacheWarmerAggregate $cacheWarmer)
3939
$this->cacheWarmer = $cacheWarmer;
4040
}
4141

42-
/**
43-
* {@inheritdoc}
44-
*/
4542
protected function configure()
4643
{
4744
$this
@@ -63,9 +60,6 @@ protected function configure()
6360
;
6461
}
6562

66-
/**
67-
* {@inheritdoc}
68-
*/
6963
protected function execute(InputInterface $input, OutputInterface $output): int
7064
{
7165
$io = new SymfonyStyle($input, $output);

‎Command/ConfigDebugCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@
3838
#[AsCommand(name: 'debug:config', description: 'Dump the current configuration for an extension')]
3939
class ConfigDebugCommand extends AbstractConfigCommand
4040
{
41-
/**
42-
* {@inheritdoc}
43-
*/
4441
protected function configure()
4542
{
4643
$this
@@ -67,9 +64,6 @@ protected function configure()
6764
;
6865
}
6966

70-
/**
71-
* {@inheritdoc}
72-
*/
7367
protected function execute(InputInterface $input, OutputInterface $output): int
7468
{
7569
$io = new SymfonyStyle($input, $output);

‎Command/ConfigDumpReferenceCommand.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@
3939
#[AsCommand(name: 'config:dump-reference', description: 'Dump the default configuration for an extension')]
4040
class ConfigDumpReferenceCommand extends AbstractConfigCommand
4141
{
42-
/**
43-
* {@inheritdoc}
44-
*/
4542
protected function configure()
4643
{
4744
$this
@@ -75,8 +72,6 @@ protected function configure()
7572
}
7673

7774
/**
78-
* {@inheritdoc}
79-
*
8075
* @throws \LogicException
8176
*/
8277
protected function execute(InputInterface $input, OutputInterface $output): int

‎Command/ContainerDebugCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@ class ContainerDebugCommand extends Command
3838
{
3939
use BuildDebugContainerTrait;
4040

41-
/**
42-
* {@inheritdoc}
43-
*/
4441
protected function configure()
4542
{
4643
$this
@@ -114,9 +111,6 @@ protected function configure()
114111
;
115112
}
116113

117-
/**
118-
* {@inheritdoc}
119-
*/
120114
protected function execute(InputInterface $input, OutputInterface $output): int
121115
{
122116
$io = new SymfonyStyle($input, $output);

‎Command/ContainerLintCommand.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,13 @@ final class ContainerLintCommand extends Command
3333
{
3434
private ContainerBuilder $containerBuilder;
3535

36-
/**
37-
* {@inheritdoc}
38-
*/
3936
protected function configure()
4037
{
4138
$this
4239
->setHelp('This command parses service definitions and ensures that injected values match the type declarations of each services\' class.')
4340
;
4441
}
4542

46-
/**
47-
* {@inheritdoc}
48-
*/
4943
protected function execute(InputInterface $input, OutputInterface $output): int
5044
{
5145
$io = new SymfonyStyle($input, $output);

0 commit comments

Comments
 (0)