Skip to content

Commit d1b7e5b

Browse files
author
nod_
committed
Issue #3105950 by spokje, quietone, peterkokot, ankithashetty, longwave: [meta] Fix 'Drupal.Commenting.ClassComment.Missing' coding standard
1 parent e4fb38d commit d1b7e5b

20 files changed

+57
-9
lines changed

lib/Drupal/Component/Plugin/Discovery/DiscoveryCachedTrait.php

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace Drupal\Component\Plugin\Discovery;
44

5+
/**
6+
* Trait for accessing cached definitions of the plugin discovery component.
7+
*/
58
trait DiscoveryCachedTrait {
69

710
use DiscoveryTrait;

lib/Drupal/Core/Batch/BatchStorage.php

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
use Drupal\Core\Database\DatabaseException;
99
use Symfony\Component\HttpFoundation\Session\SessionInterface;
1010

11+
/**
12+
* Defines the storage handler class for batches.
13+
*/
1114
class BatchStorage implements BatchStorageInterface {
1215

1316
/**

lib/Drupal/Core/Cache/ApcuBackendFactory.php

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
use Drupal\Component\Datetime\TimeInterface;
66
use Drupal\Core\Site\Settings;
77

8+
/**
9+
* Defines the APCU backend factory.
10+
*/
811
class ApcuBackendFactory implements CacheFactoryInterface {
912

1013
/**

lib/Drupal/Core/Cache/CacheFactory.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
namespace Drupal\Core\Cache;
44

5-
/**
6-
* Defines the cache backend factory.
7-
*/
85
use Drupal\Core\Site\Settings;
96
use Psr\Container\ContainerInterface;
107

8+
/**
9+
* Defines the cache backend factory.
10+
*/
1111
class CacheFactory implements CacheFactoryInterface {
1212

1313
/**

lib/Drupal/Core/Cache/DatabaseBackendFactory.php

+3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
use Drupal\Core\Database\Connection;
88
use Drupal\Core\Site\Settings;
99

10+
/**
11+
* Defines a default cache backend factory.
12+
*/
1013
class DatabaseBackendFactory implements CacheFactoryInterface {
1114

1215
/**

lib/Drupal/Core/Cache/MemoryBackendFactory.php

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
use Drupal\Component\Datetime\TimeInterface;
66

7+
/**
8+
* Defines a memory cache backend factory.
9+
*/
710
class MemoryBackendFactory implements CacheFactoryInterface {
811

912
/**

lib/Drupal/Core/Cache/MemoryCache/MemoryCacheFactory.php

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
use Drupal\Component\Datetime\TimeInterface;
66
use Drupal\Core\Cache\CacheFactoryInterface;
77

8+
/**
9+
* The memory cache factory.
10+
*/
811
class MemoryCacheFactory implements CacheFactoryInterface {
912

1013
/**

lib/Drupal/Core/Cache/MemoryCounterBackendFactory.php

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
use Drupal\Component\Datetime\TimeInterface;
66

7+
/**
8+
* Defines the memory counter backend factory.
9+
*/
710
class MemoryCounterBackendFactory implements CacheFactoryInterface {
811

912
/**

lib/Drupal/Core/Cache/NullBackendFactory.php

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace Drupal\Core\Cache;
44

5+
/**
6+
* Defines a stub cache backend factory.
7+
*/
58
class NullBackendFactory implements CacheFactoryInterface {
69

710
/**

lib/Drupal/Core/Cache/PhpBackendFactory.php

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
use Drupal\Component\Datetime\TimeInterface;
66

7+
/**
8+
* Defines a PHP cache backend factory.
9+
*/
710
class PhpBackendFactory implements CacheFactoryInterface {
811

912
/**

lib/Drupal/Core/ClassLoader/BackwardsCompatibilityClassLoader.php

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
namespace Drupal\Core\ClassLoader;
66

7+
/**
8+
* Adds backwards compatibility support for deprecated classes.
9+
*/
710
final class BackwardsCompatibilityClassLoader {
811

912
public function __construct(protected array $movedClasses) {}

lib/Drupal/Core/Config/ConfigImporterEvent.php

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
use Drupal\Component\EventDispatcher\Event;
66

7+
/**
8+
* Configuration event fired when importing a configuration object.
9+
*/
710
class ConfigImporterEvent extends Event {
811
/**
912
* Configuration import object.

lib/Drupal/Core/Config/ConfigInstaller.php

+3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
use Drupal\Core\Installer\InstallerKernel;
1010
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
1111

12+
/**
13+
* The config installer.
14+
*/
1215
class ConfigInstaller implements ConfigInstallerInterface {
1316

1417
/**

lib/Drupal/Core/Config/Plugin/Validation/Constraint/LangcodeRequiredIfTranslatableValuesConstraint.php

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
use Drupal\Core\Validation\Attribute\Constraint;
99
use Symfony\Component\Validator\Constraint as SymfonyConstraint;
1010

11+
/**
12+
* Validation constraint for translatable configuration.
13+
*/
1114
#[Constraint(
1215
id: 'LangcodeRequiredIfTranslatableValues',
1316
label: new TranslatableMarkup('Translatable config has langcode', [], ['context' => 'Validation']),

lib/Drupal/Core/Entity/EntityAutocompleteMatcherInterface.php

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace Drupal\Core\Entity;
44

5+
/**
6+
* Provides an interface for the entity autocomplete matcher.
7+
*/
58
interface EntityAutocompleteMatcherInterface {
69

710
/**

lib/Drupal/Core/Recipe/InputCollectorInterface.php

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
use Drupal\Core\TypedData\DataDefinitionInterface;
88

9+
/**
10+
* The interface for classes collecting input values for recipes.
11+
*/
912
interface InputCollectorInterface {
1013

1114
public function collectValue(string $name, DataDefinitionInterface $definition, mixed $default_value): mixed;

lib/Drupal/Core/Routing/LazyRouteCollection.php

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
use Symfony\Component\Routing\Route;
77
use Symfony\Component\Routing\RouteCollection;
88

9+
/**
10+
* The lazy route collection.
11+
*/
912
class LazyRouteCollection extends RouteCollection {
1013
/**
1114
* The route provider for this generator.

lib/Drupal/Core/Validation/Plugin/Validation/Constraint/CountryCodeConstraint.php

+3
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
use Symfony\Component\DependencyInjection\ContainerInterface;
1212
use Symfony\Component\Validator\Constraints\Choice;
1313

14+
/**
15+
* Validation constraint for country codes.
16+
*/
1417
#[Constraint(
1518
id: 'CountryCode',
1619
label: new TranslatableMarkup('CountryCode', [], ['context' => 'Validation']),

phpcs.xml.dist

-6
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,6 @@
4949
<rule ref="Drupal.Classes.UseGlobalClass"/>
5050
<rule ref="Drupal.Classes.UseLeadingBackslash"/>
5151
<rule ref="Drupal.Commenting.ClassComment"/>
52-
<rule ref="Drupal.Commenting.ClassComment.Missing">
53-
<include-pattern>*/Functional/*</include-pattern>
54-
<include-pattern>*/tests/modules/*</include-pattern>
55-
<include-pattern>./core/tests/*</include-pattern>
56-
<include-pattern>./core/modules/*</include-pattern>
57-
</rule>
5852
<rule ref="Drupal.Commenting.DataTypeNamespace"/>
5953
<rule ref="Drupal.Commenting.Deprecated"/>
6054
<rule ref="Drupal.Commenting.DocComment">

themes/starterkit_theme/src/StarterKit.php

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
use Drupal\Core\Theme\StarterKitInterface;
66

7+
/**
8+
* Interacts with theme generation.
9+
*/
710
final class StarterKit implements StarterKitInterface {
811

912
/**

0 commit comments

Comments
 (0)