Issue #3268818 by ravi.shankar, quietone: Fix class comment doc blocks in non tests 'Drupal.Commenting.DocComment.ShortSingleLine'

(cherry picked from commit eec3210128)

composer/Composer.php

@@ -11,10 +11,11 @@ use Drupal\Composer\Generator\PackageGenerator;
 use Symfony\Component\Finder\Finder;
 
 /**
- * Provides static functions for composer script events. See also
+ * Provides static functions for composer script events.
- * core/lib/Drupal/Composer/Composer.php, which contains similar
+ *
- * scripts needed by projects that include drupal/core. Scripts that
+ * See also core/lib/Drupal/Composer/Composer.php, which contains similar
- * are only needed by drupal/drupal go here.
+ * scripts needed by projects that include drupal/core. Scripts that are only
+ * needed by drupal/drupal go here.
  *
  * @see https://getcomposer.org/doc/articles/scripts.md
  */

core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php

@@ -3,8 +3,7 @@
 namespace Drupal\Component\Plugin\Discovery;
 
 /**
- * An interface defining the minimum requirements of building a plugin
+ * Defines the minimum requirements for a plugin discovery component.
- * discovery component.
  *
  * @ingroup plugin_api
  */

core/lib/Drupal/Component/Plugin/Discovery/StaticDiscovery.php

@@ -3,8 +3,7 @@
 namespace Drupal\Component\Plugin\Discovery;
 
 /**
- * A discovery mechanism that allows plugin definitions to be manually
+ * Allows plugin definitions to be manually registered.
- * registered rather than actively discovered.
  */
 class StaticDiscovery implements DiscoveryInterface {
 

core/lib/Drupal/Component/Plugin/Exception/InvalidDecoratedMethod.php

@@ -3,7 +3,6 @@
 namespace Drupal\Component\Plugin\Exception;
 
 /**
- * Exception thrown when a decorator's _call() method is triggered, but the
+ * Thrown when a decorator's _call() method uses a method that does not exist.
- * decorated object does not contain the requested method.
  */
 class InvalidDecoratedMethod extends \BadMethodCallException implements ExceptionInterface {}

core/lib/Drupal/Component/Plugin/Exception/PluginException.php

@@ -3,7 +3,6 @@
 namespace Drupal\Component\Plugin\Exception;
 
 /**
- * Generic Plugin exception class to be thrown when no more specific class
+ * Base class for plugin exceptions.
- * is applicable.
  */
 class PluginException extends \Exception implements ExceptionInterface {}

core/lib/Drupal/Core/Ajax/UpdateBuildIdCommand.php

@@ -3,9 +3,11 @@
 namespace Drupal\Core\Ajax;
 
 /**
- * AJAX command for updating the value of a hidden form_build_id input element
+ * Ajax command for updating the form build ID.
- * on a form. It requires the form passed in to have keys for both the old build
+ *
- * ID in #build_id_old and the new build ID in #build_id.
+ * Used for updating the value of a hidden form_build_id input element on a
+ * form. It requires the form passed in to have keys for both the old build ID
+ * in #build_id_old and the new build ID in #build_id.
  *
  * The primary use case for this Ajax command is to serve a new build ID to a
  * form served from the cache to an anonymous user, preventing one anonymous

core/lib/Drupal/Core/DependencyInjection/ClassResolverInterface.php

@@ -3,8 +3,7 @@
 namespace Drupal\Core\DependencyInjection;
 
 /**
- * Provides an interface to get an instance of a class with dependency
+ * Provides interface to get an instance of a class with dependency injection.
- * injection.
  */
 interface ClassResolverInterface {
 

core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterServicesForDestructionPass.php

@@ -6,8 +6,9 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 
 /**
- * Adds services tagged "needs_destruction" to the "kernel_destruct_subscriber"
+ * Adds services with specific tags to "kernel_destruct_subscriber" service.
- * service.
+ *
+ * Only services tagged with "needs_destruction" are added.
  *
  * @see \Drupal\Core\DestructableInterface
  */

core/lib/Drupal/Core/DependencyInjection/ContainerNotInitializedException.php

@@ -3,8 +3,7 @@
 namespace Drupal\Core\DependencyInjection;
 
 /**
- * Exception thrown when a method is called that requires a container, but the
+ * Exception, thrown when a method is called on a non-initialized container.
- * container is not initialized yet.
  *
  * @see \Drupal
  */

core/lib/Drupal/Core/Entity/Entity/EntityFormDisplay.php

@@ -13,8 +13,10 @@ use Symfony\Component\Validator\ConstraintViolationList;
 use Symfony\Component\Validator\ConstraintViolationListInterface;
 
 /**
- * Configuration entity that contains widget options for all components of an
+ * Configuration entity.
- * entity form in a given form mode.
+ *
+ * Contains widget options for all components of an entity form in a given
+ * form mode.
  *
  * @ConfigEntityType(
  *   id = "entity_form_display",

core/lib/Drupal/Core/Entity/Entity/EntityViewDisplay.php

@@ -12,8 +12,10 @@ use Drupal\Core\Render\Element;
 use Drupal\Core\TypedData\TranslatableInterface as TranslatableDataInterface;
 
 /**
- * Configuration entity that contains display options for all components of a
+ * Configuration entity.
- * rendered entity in a given view mode.
+ *
+ * Contains display options for all components of a rendered entity in a given
+ * view mode.
  *
  * @ConfigEntityType(
  *   id = "entity_view_display",

core/lib/Drupal/Core/Lock/PersistentDatabaseLockBackend.php

@@ -5,8 +5,9 @@ namespace Drupal\Core\Lock;
 use Drupal\Core\Database\Connection;
 
 /**
- * Defines the persistent database lock backend. This backend is global for this
+ * Defines the persistent database lock backend.
- * Drupal installation.
+ *
+ * This backend is global for this Drupal installation.
  *
  * @ingroup lock
  */

core/lib/Drupal/Core/Password/PhpassHashedPassword.php

@@ -3,8 +3,7 @@
 namespace Drupal\Core\Password;
 
 /**
- * Secure password hashing functions based on the Portable PHP password
+ * Secure hashing functions based on Portable PHP password hashing framework.
- * hashing framework.
  *
  * @see http://www.openwall.com/phpass/
  */

core/lib/Drupal/Core/Plugin/Discovery/ContainerDeriverInterface.php

@@ -6,8 +6,10 @@ use Drupal\Component\Plugin\Derivative\DeriverInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * Provides additional plugin definitions based on an existing definition using
+ * Creates additional plugin definitions.
- * service injection.
+ *
+ * The created definitions are based on an existing definition using service
+ * injection.
  */
 interface ContainerDeriverInterface extends DeriverInterface {
 

core/lib/Drupal/Core/Queue/BatchMemory.php

@@ -3,8 +3,9 @@
 namespace Drupal\Core\Queue;
 
 /**
- * Defines a batch queue handler used by the Batch API for non-progressive
+ * Defines a batch queue handler.
- * batches.
+ *
+ * Used by the Batch API for non-progressive batches.
  *
  * This implementation:
  * - Ensures FIFO ordering.

core/lib/Drupal/Core/Queue/QueueGarbageCollectionInterface.php

@@ -3,6 +3,8 @@
 namespace Drupal\Core\Queue;
 
 /**
+ * Queue garbage collection interface.
+ *
  * If the Drupal 'queue' service implements this interface, the
  * garbageCollection() method will be called during cron.
  *

core/lib/Drupal/Core/Updater/Module.php

@@ -5,8 +5,9 @@ namespace Drupal\Core\Updater;
 use Drupal\Core\Url;
 
 /**
- * Defines a class for updating modules using
+ * Defines a class for updating modules.
- * Drupal\Core\FileTransfer\FileTransfer classes via authorize.php.
+ *
+ * Uses Drupal\Core\FileTransfer\FileTransfer classes via authorize.php.
  */
 class Module extends Updater implements UpdaterInterface {
 

core/lib/Drupal/Core/Updater/Theme.php

@@ -5,8 +5,9 @@ namespace Drupal\Core\Updater;
 use Drupal\Core\Url;
 
 /**
- * Defines a class for updating themes using
+ * Defines a class for updating themes.
- * Drupal\Core\FileTransfer\FileTransfer classes via authorize.php.
+ *
+ * Uses Drupal\Core\FileTransfer\FileTransfer classes via authorize.php.
  */
 class Theme extends Updater implements UpdaterInterface {
 

core/lib/Drupal/Core/Updater/UpdaterException.php

@@ -3,8 +3,7 @@
 namespace Drupal\Core\Updater;
 
 /**
- * Defines an Exception class for the Drupal\Core\Updater\Updater class
+ * Defines an Exception class for Drupal\Core\Updater\Updater class hierarchy.
- * hierarchy.
  *
  * This is identical to the base Exception class, we just give it a more
  * specific name so that call sites that want to tell the difference can

core/lib/Drupal/Core/Updater/UpdaterFileTransferException.php

@@ -3,8 +3,9 @@
 namespace Drupal\Core\Updater;
 
 /**
- * Defines a child class of Drupal\Core\Updater\UpdaterException that indicates
+ * Defines a child class of Drupal\Core\Updater\UpdaterException.
- * a Drupal\Core\FileTransfer\FileTransfer exception.
+ *
+ * Indicates a Drupal\Core\FileTransfer\FileTransfer exception.
  *
  * We have to catch Drupal\Core\FileTransfer\FileTransfer exceptions
  * and wrap those in t(), since Drupal\Core\FileTransfer\FileTransfer

core/modules/book/src/BookUninstallValidator.php

@@ -8,8 +8,10 @@ use Drupal\Core\StringTranslation\StringTranslationTrait;
 use Drupal\Core\StringTranslation\TranslationInterface;
 
 /**
- * Prevents book module from being uninstalled whilst any book nodes exist or
+ * Prevents book module from being uninstalled under certain conditions.
- * there are any book outline stored.
+ *
+ * These conditions are when any book nodes exist or there are any book outline
+ * stored.
  */
 class BookUninstallValidator implements ModuleUninstallValidatorInterface {
 

core/modules/comment/src/Plugin/views/argument/UserUid.php

@@ -7,8 +7,9 @@ use Drupal\views\Plugin\views\argument\ArgumentPluginBase;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * Argument handler to accept a user id to check for nodes that
+ * The views user ID argument handler.
- * user posted or commented on.
+ *
+ * Accepts a user ID to check for nodes that the user posted or commented on.
  *
  * @ingroup views_argument_handlers
  *

core/modules/comment/src/Plugin/views/filter/UserUid.php

@@ -6,8 +6,7 @@ use Drupal\Core\Database\Database;
 use Drupal\views\Plugin\views\filter\FilterPluginBase;
 
 /**
- * Filter handler to accept a user id to check for nodes that user posted or
+ * Filter handler, accepts user ID to check for nodes user posted/commented on.
- * commented on.
  *
  * @ingroup views_filter_handlers
  *

core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php

@@ -5,8 +5,7 @@ namespace Drupal\comment\Plugin\views\sort;
 use Drupal\views\Plugin\views\sort\SortPluginBase;
 
 /**
- * Sort handler to sort by last comment name which might be in 2 different
+ * Sort handler, sorts by last comment name which can be in 2 different fields.
- * fields.
  *
  * @ingroup views_sort_handlers
  *

core/modules/forum/src/ForumUninstallValidator.php

@@ -10,8 +10,10 @@ use Drupal\Core\StringTranslation\TranslationInterface;
 use Drupal\taxonomy\VocabularyInterface;
 
 /**
- * Prevents forum module from being uninstalled whilst any forum nodes exist
+ * Prevents forum module from being uninstalled under certain conditions.
- * or there are any terms in the forum vocabulary.
+ *
+ * These conditions are when any forum nodes exist or there are any terms in the
+ * forum vocabulary.
  */
 class ForumUninstallValidator implements ModuleUninstallValidatorInterface {
 

core/modules/image/src/Plugin/migrate/destination/EntityImageStyle.php

@@ -8,6 +8,8 @@ use Drupal\migrate\Plugin\migrate\destination\EntityConfigBase;
 use Drupal\migrate\Row;
 
 /**
+ * Entity image style destination.
+ *
  * Every migration that uses this destination must have an optional
  * dependency on the d6_file migration to ensure it runs first.
  *

core/modules/language/src/Plugin/LanguageNegotiation/LanguageNegotiationUrlFallback.php

@@ -6,8 +6,7 @@ use Drupal\language\LanguageNegotiationMethodBase;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
- * Class that determines the language to be assigned to URLs when none is
+ * Determines the language to be assigned to URLs when none is detected.
- * detected.
  *
  * The language negotiation process has a fallback chain that ends with the
  * default language negotiation method. Each built-in language type has a

core/modules/layout_builder/src/EventSubscriber/PrepareLayout.php

@@ -11,7 +11,9 @@ use Drupal\layout_builder\OverridesSectionStorageInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
- * An event subscriber to prepare section storage via the
+ * An event subscriber to prepare section storage.
+ *
+ * Section storage works via the
  * \Drupal\layout_builder\Event\PrepareLayoutEvent.
  *
  * @see \Drupal\layout_builder\Event\PrepareLayoutEvent

core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php

@@ -5,8 +5,9 @@ namespace Drupal\migrate_drupal\Plugin\migrate\source\d7;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Base class for D7 source plugins which need to collect field values from
+ * Base class for D7 source plugins which need to collect field values.
- * the Field API.
+ *
+ * Field values are collected from the Field API.
  *
  * Refer to the existing implementations for examples:
  * @see \Drupal\node\Plugin\migrate\source\d7\Node

core/modules/node/src/Plugin/views/argument/UidRevision.php

@@ -5,8 +5,9 @@ namespace Drupal\node\Plugin\views\argument;
 use Drupal\user\Plugin\views\argument\Uid;
 
 /**
- * Filter handler to accept a user id to check for nodes that
+ * Filter handler, accepts a user ID.
- * user posted or created a revision on.
+ *
+ * Checks for nodes that a user posted or created a revision on.
  *
  * @ViewsArgument("node_uid_revision")
  */

core/modules/node/src/Plugin/views/row/Rss.php

@@ -5,8 +5,7 @@ namespace Drupal\node\Plugin\views\row;
 use Drupal\views\Plugin\views\row\RssPluginBase;
 
 /**
- * Plugin which performs a node_view on the resulting object
+ * Performs a node_view on the resulting object and formats it as an RSS item.
- * and formats it as an RSS item.
  *
  * @ViewsRow(
  *   id = "node_rss",

core/modules/options/src/Plugin/views/argument/NumberListField.php

@@ -10,8 +10,7 @@ use Drupal\views\Plugin\views\display\DisplayPluginBase;
 use Drupal\views\Plugin\views\argument\NumericArgument;
 
 /**
- * Argument handler for list field to show the human readable name in the
+ * Argument handler for list field to show human readable name in the summary.
- * summary.
  *
  * @ingroup views_argument_handlers
  *

core/modules/user/src/Access/PermissionAccessCheck.php

@@ -8,6 +8,8 @@ use Drupal\Core\Session\AccountInterface;
 use Symfony\Component\Routing\Route;
 
 /**
+ * Permission access check.
+ *
  * Determines access to routes based on permissions defined via
  * $module.permissions.yml files.
  */

core/modules/views/src/Analyzer.php

@@ -5,6 +5,8 @@ namespace Drupal\views;
 use Drupal\Core\Extension\ModuleHandlerInterface;
 
 /**
+ * View analyzer plugin manager.
+ *
  * This tool is a small plugin manager to perform analysis on a view and
  * report results to the user. This tool is meant to let modules that
  * provide data to Views also help users properly use that data by

core/modules/views/src/Plugin/views/argument/ManyToOne.php

@@ -8,6 +8,8 @@ use Drupal\views\Plugin\views\display\DisplayPluginBase;
 use Drupal\views\ManyToOneHelper;
 
 /**
+ * Argument handler for many to one relationships.
+ *
  * An argument handler for use in fields that have a many to one relationship
  * with the table(s) to the left. This adds a bunch of options that are
  * reasonably common with this type of relationship.
@@ -92,8 +94,7 @@ class ManyToOne extends ArgumentPluginBase {
   }
 
   /**
-   * Override ensureMyTable so we can control how this joins in.
+   * {@inheritdoc}
-   * The operator actually has influence over joining.
    */
   public function ensureMyTable() {
     $this->helper->ensureMyTable();

core/modules/views/src/Plugin/views/argument/NumericArgument.php

@@ -6,8 +6,9 @@ use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Plugin\Context\ContextDefinition;
 
 /**
- * Basic argument handler for arguments that are numeric. Incorporates
+ * Basic argument handler for arguments that are numeric.
- * break_phrase.
+ *
+ * Incorporates break_phrase.
  *
  * @ingroup views_argument_handlers
  *

core/modules/views/src/Plugin/views/argument/StringArgument.php

@@ -10,6 +10,8 @@ use Drupal\views\Plugin\views\display\DisplayPluginBase;
 use Drupal\views\ManyToOneHelper;
 
 /**
+ * Argument handler for string.
+ *
  * Basic argument handler to implement string arguments that may have length
  * limits.
  *

core/modules/views/src/Plugin/views/field/Markup.php

@@ -7,8 +7,7 @@ use Drupal\views\ResultRow;
 use Drupal\views\ViewExecutable;
 
 /**
- * A handler to run a field through check_markup, using a companion
+ * Handler to run a field through check_markup, using a companion format field.
- * format field.
  *
  * - format: (REQUIRED) Either a string format id to use for this field or an
  *           array('field' => {$field}) where $field is the field in this table

core/modules/views/src/Plugin/views/filter/ManyToOne.php

@@ -8,8 +8,9 @@ use Drupal\views\Plugin\views\display\DisplayPluginBase;
 use Drupal\views\ManyToOneHelper;
 
 /**
- * Complex filter to handle filtering for many to one relationships,
+ * Complex filter to handle filtering for many to one relationships.
- * such as terms (many terms per node) or roles (many roles per user).
+ *
+ * Examples are terms (many terms per node) or roles (many roles per user).
  *
  * The construct method needs to be overridden to provide a list of options;
  * alternately, the valueForm and adminSummary methods need to be overridden

core/modules/views/src/Plugin/views/filter/StringFilter.php

@@ -7,8 +7,9 @@ use Drupal\Core\Form\FormStateInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * Basic textfield filter to handle string filtering commands
+ * Basic textfield filter to handle string filtering commands.
- * including equality, like, not like, etc.
+ *
+ * Including equality, like, not like, etc.
  *
  * @ingroup views_filter_handlers
  *

core/modules/views/src/Plugin/views/relationship/GroupwiseMax.php

@@ -8,7 +8,9 @@ use Drupal\views\Views;
 use Drupal\views\Entity\View;
 
 /**
- * Relationship handler that allows a groupwise maximum of the linked in table.
+ * The relationship handler for groupwise maximum queries.
+ *
+ * It allows a groupwise maximum of the linked in table.
  * For a definition, see:
  * http://dev.mysql.com/doc/refman/5.0/en/example-maximum-column-group-row.html
  * In lay terms, instead of joining to get all matching records in the linked

core/modules/views/src/Plugin/views/style/DefaultStyle.php

@@ -3,8 +3,9 @@
 namespace Drupal\views\Plugin\views\style;
 
 /**
- * Unformatted style plugin to render rows one after another with no
+ * Unformatted style plugin to render rows.
- * decorations.
+ *
+ * Row are rendered one after another with no decorations.
  *
  * @ingroup views_style_plugins
  *