Issue #3498158 by quietone, borisson_: Fix 'Drupal.Commenting.ClassComment.Missing' in core/tests

core/phpcs.xml.dist

@@ -48,6 +48,7 @@
   <rule ref="Drupal.Commenting.ClassComment.Missing">
     <include-pattern>*/Functional/*</include-pattern>
     <include-pattern>*/tests/modules/*</include-pattern>
+    <include-pattern>./core/tests/Drupal/Tests/Core/*</include-pattern>
   </rule>
   <rule ref="Drupal.Commenting.DataTypeNamespace"/>
   <rule ref="Drupal.Commenting.Deprecated"/>

core/tests/Drupal/Tests/Core/Access/AccessResultTest.php

@@ -973,6 +973,9 @@ public static function providerTestAllowedIfHasPermissions() {
 
 }
 
+/**
+ * Stub class for testing AccessResult.
+ */
 class UncacheableTestAccessResult implements AccessResultInterface {
 
   /**

core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php

@@ -139,6 +139,9 @@ public function testAccessException(): void {
 
 }
 
+/**
+ * Controller for testing custom access.
+ */
 class TestController {
 
   public function accessAllow() {

core/tests/Drupal/Tests/Core/Asset/AssetResolverTest.php

@@ -301,6 +301,9 @@ public function testJsAssetsOrder(): void {
   define('JS_DEFAULT', 0);
 }
 
+/**
+ * Stub class with memory cache implementation for testing.
+ */
 class TestMemoryBackend extends MemoryBackend {
 
   public function getAllCids() {

core/tests/Drupal/Tests/Core/Cache/CacheTagsInvalidatorTest.php

@@ -55,4 +55,7 @@ public function testInvalidateTags(): void {
 
 }
 
+/**
+ * Test interface for testing the cache tags validator.
+ */
 interface InvalidatingCacheBackendInterface extends CacheTagsInvalidatorInterface, CacheBackendInterface {}

core/tests/Drupal/Tests/Core/Condition/ConditionAccessResolverTraitTest.php

@@ -77,6 +77,9 @@ public static function providerTestResolveConditions() {
 
 }
 
+/**
+ * Stub class for testing trait.
+ */
 class TestConditionAccessResolverTrait {
   use \Drupal\Core\Condition\ConditionAccessResolverTrait {
     resolveConditions as public;

core/tests/Drupal/Tests/Core/Config/ConfigFactoryOverrideBaseTest.php

@@ -82,7 +82,9 @@ public static function providerTestFilterNestedArray() {
 
 }
 
-
+/**
+ * Stub class for testing ConfigFactoryOverrideBase.
+ */
 class TestConfigFactoryOverrideBase extends ConfigFactoryOverrideBase {
 
   public function doFilterNestedArray(array $original_data, array &$override_data) {

core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityBaseUnitTest.php

@@ -721,6 +721,9 @@ public static function providerTestSetAndPreSaveWithPluginCollections(): array {
 
 }
 
+/**
+ * Stub class for testing.
+ */
 class TestConfigEntityWithPluginCollections extends ConfigEntityBaseWithPluginCollections {
 
   /**

core/tests/Drupal/Tests/Core/Controller/ControllerResolverTest.php

@@ -181,6 +181,9 @@ protected function assertCallableController(callable $controller, ?string $class
 
 }
 
+/**
+ * Mock for the controller.
+ */
 class MockController {
 
   public function getResult() {
@@ -192,6 +195,10 @@ public function getControllerWithRequestAndRouteMatch(RouteMatchInterface $route
   }
 
 }
+
+/**
+ * Mock for the PSR-7 controller.
+ */
 class MockControllerPsr7 {
 
   public function getResult() {
@@ -204,6 +211,9 @@ public function getControllerWithRequestAndRouteMatch(RouteMatchInterface $route
 
 }
 
+/**
+ * Mock for the injected service.
+ */
 class MockContainerInjection implements ContainerInjectionInterface {
 
   /**
@@ -227,6 +237,9 @@ public function getResult() {
 
 }
 
+/**
+ * Test class used for testing the Controller resolver class.
+ */
 class MockInvokeController {
 
   public function __invoke() {

core/tests/Drupal/Tests/Core/Database/Stub/Select.php

@@ -6,6 +6,9 @@
 
 use Drupal\Core\Database\Query\Select as QuerySelect;
 
+/**
+ * A stub of the MySQL query builder for SELECT statements.
+ */
 class Select extends QuerySelect {
 
 }

core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php

@@ -156,17 +156,32 @@ protected function getDriverTestMysqlContainer($service) {
 
 }
 
+/**
+ * A class used for testing the backend compiler passes.
+ */
 class ServiceClassDefault {
 }
 
+/**
+ * A class used for testing the backend compiler passes.
+ */
 class ServiceClassMysql extends ServiceClassDefault {
 }
 
+/**
+ * A class used for testing the backend compiler passes.
+ */
 class ServiceClassMariaDb extends ServiceClassMysql {
 }
 
+/**
+ * A class used for testing the backend compiler passes.
+ */
 class ServiceClassSqlite extends ServiceClassDefault {
 }
 
+/**
+ * A class used for testing the backend compiler passes.
+ */
 class ServiceClassDriverTestMysql extends ServiceClassDefault {
 }

core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/TaggedHandlersPassTest.php

@@ -430,8 +430,15 @@ public function testProcessWithDifferentArgumentsOrderAndDefaultValue(): void {
 
 }
 
+/**
+ * Interface for test handlers.
+ */
 interface HandlerInterface {
 }
+
+/**
+ * Test class of a valid consumer.
+ */
 class ValidConsumer {
 
   public function addHandler(HandlerInterface $instance, $priority = 0) {
@@ -444,12 +451,20 @@ public function addWithId(HandlerInterface $instance, $id, $priority = 0) {
   }
 
 }
+
+/**
+ * Test class of an invalid consumer.
+ */
 class InvalidConsumer {
 
   public function addHandler($instance, $priority = 0) {
   }
 
 }
+
+/**
+ * Test class of a valid consumer with extra arguments.
+ */
 class ValidConsumerWithExtraArguments {
 
   public function addHandler(HandlerInterface $instance, $priority = 0, $extra1 = '', $extra2 = '') {
@@ -465,7 +480,15 @@ public function addWithDifferentOrder(HandlerInterface $instance, $extra1, $prio
   }
 
 }
+
+/**
+ * Test handler class with interface implemented.
+ */
 class ValidHandler implements HandlerInterface {
 }
+
+/**
+ * Invalid test handler class.
+ */
 class InvalidHandler {
 }

core/tests/Drupal/Tests/Core/Entity/EntityFieldManagerTest.php

@@ -866,6 +866,9 @@ public function testGetFieldMapByFieldType(): void {
 
 }
 
+/**
+ * Stub class for testing EntityFieldManager.
+ */
 class TestEntityFieldManager extends EntityFieldManager {
 
   /**

core/tests/Drupal/Tests/Core/Entity/EntityListBuilderTest.php

@@ -146,6 +146,9 @@ public function testGetOperations(): void {
 
 }
 
+/**
+ * Stub class for testing EntityListBuilder.
+ */
 class TestEntityListBuilder extends EntityTestListBuilder {
 
   public function buildOperations(EntityInterface $entity) {

core/tests/Drupal/Tests/Core/Entity/EntityResolverManagerTest.php

@@ -559,6 +559,9 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
 
 }
 
+/**
+ * A basic form without a container injection interface implemented.
+ */
 class BasicFormNoContainerInjectionInterface implements FormInterface {
 
   /**

core/tests/Drupal/Tests/Core/Entity/EntityTypeRepositoryTest.php

@@ -219,14 +219,26 @@ public function testGetEntityTypeFromClassAmbiguousBundleClass(): void {
 
 }
 
+/**
+ * A simple entity for testing.
+ */
 class Fruit extends EntityBase {
 }
 
+/**
+ * A Fruit class for testing.
+ */
 class Apple extends Fruit {
 }
 
+/**
+ * An Apple class for testing.
+ */
 class RoyalGala extends Apple {
 }
 
+/**
+ * A Fruit class for testing.
+ */
 class Blackcurrant extends Fruit {
 }

core/tests/Drupal/Tests/Core/Entity/KeyValueStore/KeyValueEntityStorageTest.php

@@ -638,6 +638,9 @@ protected function getMockEntity(string $class = EntityBaseTest::class, array $a
 
 }
 
+/**
+ * A simple entity class for testing key value entity storage.
+ */
 class EntityBaseTest extends EntityBase {
 
   /**

core/tests/Drupal/Tests/Core/Entity/Routing/DefaultHtmlRouteProviderTest.php

@@ -399,6 +399,9 @@ protected static function getEntityType(?ObjectProphecy $base_entity_type = NULL
 
 }
 
+/**
+ * Stub class for testing DefaultHtmlRouteProvider.
+ */
 class TestDefaultHtmlRouteProvider extends DefaultHtmlRouteProvider {
 
   public function getEntityTypeIdKeyType(EntityTypeInterface $entity_type) {

core/tests/Drupal/Tests/Core/EventSubscriber/FinalExceptionSubscriberTest.php

@@ -46,6 +46,9 @@ public function testOnExceptionWithUnknownFormat(): void {
 
 }
 
+/**
+ * Test class for testing the final exception subscriber.
+ */
 class TestDefaultExceptionSubscriber extends FinalExceptionSubscriber {
 
   protected function isErrorDisplayable($error): bool {

core/tests/Drupal/Tests/Core/Extension/ExtensionListTest.php

@@ -321,6 +321,9 @@ protected function getMocks(): array {
 
 }
 
+/**
+ * Stub class for testing ExtensionList.
+ */
 class TestExtension extends ExtensionList {
 
   /**