From f8144f44e22d06ca661d55dddb395a6ce6518cea Mon Sep 17 00:00:00 2001 From: Alex Pott Date: Tue, 29 Nov 2022 12:13:59 +0000 Subject: [PATCH] Issue #3268818 by ravi.shankar, quietone: Fix class comment doc blocks in non tests 'Drupal.Commenting.DocComment.ShortSingleLine' (cherry picked from commit eec3210128300d06c6a41987935c74ddfd982a97) --- composer/Composer.php | 9 +++++---- .../Component/Plugin/Discovery/DiscoveryInterface.php | 3 +-- .../Component/Plugin/Discovery/StaticDiscovery.php | 3 +-- .../Plugin/Exception/InvalidDecoratedMethod.php | 3 +-- .../Component/Plugin/Exception/PluginException.php | 3 +-- core/lib/Drupal/Core/Ajax/UpdateBuildIdCommand.php | 8 +++++--- .../Core/DependencyInjection/ClassResolverInterface.php | 3 +-- .../Compiler/RegisterServicesForDestructionPass.php | 5 +++-- .../ContainerNotInitializedException.php | 3 +-- core/lib/Drupal/Core/Entity/Entity/EntityFormDisplay.php | 6 ++++-- core/lib/Drupal/Core/Entity/Entity/EntityViewDisplay.php | 6 ++++-- .../Drupal/Core/Lock/PersistentDatabaseLockBackend.php | 5 +++-- core/lib/Drupal/Core/Password/PhpassHashedPassword.php | 3 +-- .../Core/Plugin/Discovery/ContainerDeriverInterface.php | 6 ++++-- core/lib/Drupal/Core/Queue/BatchMemory.php | 5 +++-- .../Core/Queue/QueueGarbageCollectionInterface.php | 2 ++ core/lib/Drupal/Core/Updater/Module.php | 5 +++-- core/lib/Drupal/Core/Updater/Theme.php | 5 +++-- core/lib/Drupal/Core/Updater/UpdaterException.php | 3 +-- .../Drupal/Core/Updater/UpdaterFileTransferException.php | 5 +++-- core/modules/book/src/BookUninstallValidator.php | 6 ++++-- .../comment/src/Plugin/views/argument/UserUid.php | 5 +++-- core/modules/comment/src/Plugin/views/filter/UserUid.php | 3 +-- .../src/Plugin/views/sort/StatisticsLastCommentName.php | 3 +-- core/modules/forum/src/ForumUninstallValidator.php | 6 ++++-- .../src/Plugin/migrate/destination/EntityImageStyle.php | 2 ++ .../LanguageNegotiationUrlFallback.php | 3 +-- .../layout_builder/src/EventSubscriber/PrepareLayout.php | 4 +++- .../src/Plugin/migrate/source/d7/FieldableEntity.php | 5 +++-- .../node/src/Plugin/views/argument/UidRevision.php | 5 +++-- core/modules/node/src/Plugin/views/row/Rss.php | 3 +-- .../src/Plugin/views/argument/NumberListField.php | 3 +-- core/modules/user/src/Access/PermissionAccessCheck.php | 2 ++ core/modules/views/src/Analyzer.php | 2 ++ .../views/src/Plugin/views/argument/ManyToOne.php | 5 +++-- .../views/src/Plugin/views/argument/NumericArgument.php | 5 +++-- .../views/src/Plugin/views/argument/StringArgument.php | 2 ++ core/modules/views/src/Plugin/views/field/Markup.php | 3 +-- core/modules/views/src/Plugin/views/filter/ManyToOne.php | 5 +++-- .../views/src/Plugin/views/filter/StringFilter.php | 5 +++-- .../views/src/Plugin/views/relationship/GroupwiseMax.php | 4 +++- .../views/src/Plugin/views/style/DefaultStyle.php | 5 +++-- 42 files changed, 102 insertions(+), 75 deletions(-) diff --git a/composer/Composer.php b/composer/Composer.php index 68222ae3e6c..aa3e507915a 100644 --- a/composer/Composer.php +++ b/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 - * core/lib/Drupal/Composer/Composer.php, which contains similar - * scripts needed by projects that include drupal/core. Scripts that - * are only needed by drupal/drupal go here. + * Provides static functions for composer script events. + * + * See also core/lib/Drupal/Composer/Composer.php, which contains similar + * 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 */ diff --git a/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php b/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php index 66e6a2ec038..00f35e4d209 100644 --- a/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php +++ b/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 - * discovery component. + * Defines the minimum requirements for a plugin discovery component. * * @ingroup plugin_api */ diff --git a/core/lib/Drupal/Component/Plugin/Discovery/StaticDiscovery.php b/core/lib/Drupal/Component/Plugin/Discovery/StaticDiscovery.php index 281860254dd..3ff0a21d128 100644 --- a/core/lib/Drupal/Component/Plugin/Discovery/StaticDiscovery.php +++ b/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 - * registered rather than actively discovered. + * Allows plugin definitions to be manually registered. */ class StaticDiscovery implements DiscoveryInterface { diff --git a/core/lib/Drupal/Component/Plugin/Exception/InvalidDecoratedMethod.php b/core/lib/Drupal/Component/Plugin/Exception/InvalidDecoratedMethod.php index ed91f35ac37..b4eb4ad019a 100644 --- a/core/lib/Drupal/Component/Plugin/Exception/InvalidDecoratedMethod.php +++ b/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 - * decorated object does not contain the requested method. + * Thrown when a decorator's _call() method uses a method that does not exist. */ class InvalidDecoratedMethod extends \BadMethodCallException implements ExceptionInterface {} diff --git a/core/lib/Drupal/Component/Plugin/Exception/PluginException.php b/core/lib/Drupal/Component/Plugin/Exception/PluginException.php index 0551125b66c..192362581d6 100644 --- a/core/lib/Drupal/Component/Plugin/Exception/PluginException.php +++ b/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 - * is applicable. + * Base class for plugin exceptions. */ class PluginException extends \Exception implements ExceptionInterface {} diff --git a/core/lib/Drupal/Core/Ajax/UpdateBuildIdCommand.php b/core/lib/Drupal/Core/Ajax/UpdateBuildIdCommand.php index 65c32af0956..9ecce60dc66 100644 --- a/core/lib/Drupal/Core/Ajax/UpdateBuildIdCommand.php +++ b/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 - * 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. + * Ajax command for updating the form 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 diff --git a/core/lib/Drupal/Core/DependencyInjection/ClassResolverInterface.php b/core/lib/Drupal/Core/DependencyInjection/ClassResolverInterface.php index 16440c141c3..dc7daa5dcb5 100644 --- a/core/lib/Drupal/Core/DependencyInjection/ClassResolverInterface.php +++ b/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 - * injection. + * Provides interface to get an instance of a class with dependency injection. */ interface ClassResolverInterface { diff --git a/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterServicesForDestructionPass.php b/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterServicesForDestructionPass.php index 5e13eea0260..af11c39ca3a 100644 --- a/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterServicesForDestructionPass.php +++ b/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" - * service. + * Adds services with specific tags to "kernel_destruct_subscriber" service. + * + * Only services tagged with "needs_destruction" are added. * * @see \Drupal\Core\DestructableInterface */ diff --git a/core/lib/Drupal/Core/DependencyInjection/ContainerNotInitializedException.php b/core/lib/Drupal/Core/DependencyInjection/ContainerNotInitializedException.php index 66c58558158..7558b0c19b7 100644 --- a/core/lib/Drupal/Core/DependencyInjection/ContainerNotInitializedException.php +++ b/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 - * container is not initialized yet. + * Exception, thrown when a method is called on a non-initialized container. * * @see \Drupal */ diff --git a/core/lib/Drupal/Core/Entity/Entity/EntityFormDisplay.php b/core/lib/Drupal/Core/Entity/Entity/EntityFormDisplay.php index 3dcffd2cfa4..2384062319e 100644 --- a/core/lib/Drupal/Core/Entity/Entity/EntityFormDisplay.php +++ b/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 - * entity form in a given form mode. + * Configuration entity. + * + * Contains widget options for all components of an entity form in a given + * form mode. * * @ConfigEntityType( * id = "entity_form_display", diff --git a/core/lib/Drupal/Core/Entity/Entity/EntityViewDisplay.php b/core/lib/Drupal/Core/Entity/Entity/EntityViewDisplay.php index 00800b58395..0124b0f5b5c 100644 --- a/core/lib/Drupal/Core/Entity/Entity/EntityViewDisplay.php +++ b/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 - * rendered entity in a given view mode. + * Configuration entity. + * + * Contains display options for all components of a rendered entity in a given + * view mode. * * @ConfigEntityType( * id = "entity_view_display", diff --git a/core/lib/Drupal/Core/Lock/PersistentDatabaseLockBackend.php b/core/lib/Drupal/Core/Lock/PersistentDatabaseLockBackend.php index eba5c475e2c..bdac0ec30b2 100644 --- a/core/lib/Drupal/Core/Lock/PersistentDatabaseLockBackend.php +++ b/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 - * Drupal installation. + * Defines the persistent database lock backend. + * + * This backend is global for this Drupal installation. * * @ingroup lock */ diff --git a/core/lib/Drupal/Core/Password/PhpassHashedPassword.php b/core/lib/Drupal/Core/Password/PhpassHashedPassword.php index cb109785112..de702d3ff57 100644 --- a/core/lib/Drupal/Core/Password/PhpassHashedPassword.php +++ b/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 - * hashing framework. + * Secure hashing functions based on Portable PHP password hashing framework. * * @see http://www.openwall.com/phpass/ */ diff --git a/core/lib/Drupal/Core/Plugin/Discovery/ContainerDeriverInterface.php b/core/lib/Drupal/Core/Plugin/Discovery/ContainerDeriverInterface.php index 3a91e33dcea..1c1661daebb 100644 --- a/core/lib/Drupal/Core/Plugin/Discovery/ContainerDeriverInterface.php +++ b/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 - * service injection. + * Creates additional plugin definitions. + * + * The created definitions are based on an existing definition using service + * injection. */ interface ContainerDeriverInterface extends DeriverInterface { diff --git a/core/lib/Drupal/Core/Queue/BatchMemory.php b/core/lib/Drupal/Core/Queue/BatchMemory.php index bf4ba55913f..4ae6c9986b1 100644 --- a/core/lib/Drupal/Core/Queue/BatchMemory.php +++ b/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 - * batches. + * Defines a batch queue handler. + * + * Used by the Batch API for non-progressive batches. * * This implementation: * - Ensures FIFO ordering. diff --git a/core/lib/Drupal/Core/Queue/QueueGarbageCollectionInterface.php b/core/lib/Drupal/Core/Queue/QueueGarbageCollectionInterface.php index 281627ba550..5b6afb32b3b 100644 --- a/core/lib/Drupal/Core/Queue/QueueGarbageCollectionInterface.php +++ b/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. * diff --git a/core/lib/Drupal/Core/Updater/Module.php b/core/lib/Drupal/Core/Updater/Module.php index 66e92517560..7cc3f3f66e1 100644 --- a/core/lib/Drupal/Core/Updater/Module.php +++ b/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 - * Drupal\Core\FileTransfer\FileTransfer classes via authorize.php. + * Defines a class for updating modules. + * + * Uses Drupal\Core\FileTransfer\FileTransfer classes via authorize.php. */ class Module extends Updater implements UpdaterInterface { diff --git a/core/lib/Drupal/Core/Updater/Theme.php b/core/lib/Drupal/Core/Updater/Theme.php index 18b46150644..cd913fb7619 100644 --- a/core/lib/Drupal/Core/Updater/Theme.php +++ b/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 - * Drupal\Core\FileTransfer\FileTransfer classes via authorize.php. + * Defines a class for updating themes. + * + * Uses Drupal\Core\FileTransfer\FileTransfer classes via authorize.php. */ class Theme extends Updater implements UpdaterInterface { diff --git a/core/lib/Drupal/Core/Updater/UpdaterException.php b/core/lib/Drupal/Core/Updater/UpdaterException.php index 2d1f828eb6e..e8a4994133e 100644 --- a/core/lib/Drupal/Core/Updater/UpdaterException.php +++ b/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 - * hierarchy. + * Defines an Exception class for Drupal\Core\Updater\Updater class 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 diff --git a/core/lib/Drupal/Core/Updater/UpdaterFileTransferException.php b/core/lib/Drupal/Core/Updater/UpdaterFileTransferException.php index 9deec3c94ab..8c24701023b 100644 --- a/core/lib/Drupal/Core/Updater/UpdaterFileTransferException.php +++ b/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 - * a Drupal\Core\FileTransfer\FileTransfer exception. + * Defines a child class of Drupal\Core\Updater\UpdaterException. + * + * 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 diff --git a/core/modules/book/src/BookUninstallValidator.php b/core/modules/book/src/BookUninstallValidator.php index 181b9f2bdf6..d1eb1b15a6e 100644 --- a/core/modules/book/src/BookUninstallValidator.php +++ b/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 - * there are any book outline stored. + * Prevents book module from being uninstalled under certain conditions. + * + * These conditions are when any book nodes exist or there are any book outline + * stored. */ class BookUninstallValidator implements ModuleUninstallValidatorInterface { diff --git a/core/modules/comment/src/Plugin/views/argument/UserUid.php b/core/modules/comment/src/Plugin/views/argument/UserUid.php index 2ddc3798c8f..e6c063b9efe 100644 --- a/core/modules/comment/src/Plugin/views/argument/UserUid.php +++ b/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 - * user posted or commented on. + * The views user ID argument handler. + * + * Accepts a user ID to check for nodes that the user posted or commented on. * * @ingroup views_argument_handlers * diff --git a/core/modules/comment/src/Plugin/views/filter/UserUid.php b/core/modules/comment/src/Plugin/views/filter/UserUid.php index f683df40fd7..8e05ca92c06 100644 --- a/core/modules/comment/src/Plugin/views/filter/UserUid.php +++ b/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 - * commented on. + * Filter handler, accepts user ID to check for nodes user posted/commented on. * * @ingroup views_filter_handlers * diff --git a/core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php b/core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php index 1c873389834..ea6a5c356d7 100644 --- a/core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php +++ b/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 - * fields. + * Sort handler, sorts by last comment name which can be in 2 different fields. * * @ingroup views_sort_handlers * diff --git a/core/modules/forum/src/ForumUninstallValidator.php b/core/modules/forum/src/ForumUninstallValidator.php index a67caac3169..7f1d68738c3 100644 --- a/core/modules/forum/src/ForumUninstallValidator.php +++ b/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 - * or there are any terms in the forum vocabulary. + * Prevents forum module from being uninstalled under certain conditions. + * + * These conditions are when any forum nodes exist or there are any terms in the + * forum vocabulary. */ class ForumUninstallValidator implements ModuleUninstallValidatorInterface { diff --git a/core/modules/image/src/Plugin/migrate/destination/EntityImageStyle.php b/core/modules/image/src/Plugin/migrate/destination/EntityImageStyle.php index 51c73b5ad6d..84a390e4c05 100644 --- a/core/modules/image/src/Plugin/migrate/destination/EntityImageStyle.php +++ b/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. * diff --git a/core/modules/language/src/Plugin/LanguageNegotiation/LanguageNegotiationUrlFallback.php b/core/modules/language/src/Plugin/LanguageNegotiation/LanguageNegotiationUrlFallback.php index d37e9bcd704..61a3ecc4714 100644 --- a/core/modules/language/src/Plugin/LanguageNegotiation/LanguageNegotiationUrlFallback.php +++ b/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 - * detected. + * Determines the language to be assigned to URLs when none is detected. * * The language negotiation process has a fallback chain that ends with the * default language negotiation method. Each built-in language type has a diff --git a/core/modules/layout_builder/src/EventSubscriber/PrepareLayout.php b/core/modules/layout_builder/src/EventSubscriber/PrepareLayout.php index ec8122b2fd9..d4000648921 100644 --- a/core/modules/layout_builder/src/EventSubscriber/PrepareLayout.php +++ b/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 diff --git a/core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php b/core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php index 4ddc36e8471..ba724872192 100644 --- a/core/modules/migrate_drupal/src/Plugin/migrate/source/d7/FieldableEntity.php +++ b/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 - * the Field API. + * Base class for D7 source plugins which need to collect field values. + * + * Field values are collected from the Field API. * * Refer to the existing implementations for examples: * @see \Drupal\node\Plugin\migrate\source\d7\Node diff --git a/core/modules/node/src/Plugin/views/argument/UidRevision.php b/core/modules/node/src/Plugin/views/argument/UidRevision.php index 0f989a7a332..15fb4380e57 100644 --- a/core/modules/node/src/Plugin/views/argument/UidRevision.php +++ b/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 - * user posted or created a revision on. + * Filter handler, accepts a user ID. + * + * Checks for nodes that a user posted or created a revision on. * * @ViewsArgument("node_uid_revision") */ diff --git a/core/modules/node/src/Plugin/views/row/Rss.php b/core/modules/node/src/Plugin/views/row/Rss.php index db5ab7dfdb9..a8fe007502f 100644 --- a/core/modules/node/src/Plugin/views/row/Rss.php +++ b/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 - * and formats it as an RSS item. + * Performs a node_view on the resulting object and formats it as an RSS item. * * @ViewsRow( * id = "node_rss", diff --git a/core/modules/options/src/Plugin/views/argument/NumberListField.php b/core/modules/options/src/Plugin/views/argument/NumberListField.php index 3a94c7bdd89..74700cf9758 100644 --- a/core/modules/options/src/Plugin/views/argument/NumberListField.php +++ b/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 - * summary. + * Argument handler for list field to show human readable name in the summary. * * @ingroup views_argument_handlers * diff --git a/core/modules/user/src/Access/PermissionAccessCheck.php b/core/modules/user/src/Access/PermissionAccessCheck.php index 22320859b04..e96a5da092c 100644 --- a/core/modules/user/src/Access/PermissionAccessCheck.php +++ b/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. */ diff --git a/core/modules/views/src/Analyzer.php b/core/modules/views/src/Analyzer.php index 42ae3ccb630..98089926f8b 100644 --- a/core/modules/views/src/Analyzer.php +++ b/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 diff --git a/core/modules/views/src/Plugin/views/argument/ManyToOne.php b/core/modules/views/src/Plugin/views/argument/ManyToOne.php index 18c0a4965cb..7abce4e8c2b 100644 --- a/core/modules/views/src/Plugin/views/argument/ManyToOne.php +++ b/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. - * The operator actually has influence over joining. + * {@inheritdoc} */ public function ensureMyTable() { $this->helper->ensureMyTable(); diff --git a/core/modules/views/src/Plugin/views/argument/NumericArgument.php b/core/modules/views/src/Plugin/views/argument/NumericArgument.php index ab1ad7fa8e0..b40817b1a2a 100644 --- a/core/modules/views/src/Plugin/views/argument/NumericArgument.php +++ b/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 - * break_phrase. + * Basic argument handler for arguments that are numeric. + * + * Incorporates break_phrase. * * @ingroup views_argument_handlers * diff --git a/core/modules/views/src/Plugin/views/argument/StringArgument.php b/core/modules/views/src/Plugin/views/argument/StringArgument.php index 2962bf9f116..8a021af49ff 100644 --- a/core/modules/views/src/Plugin/views/argument/StringArgument.php +++ b/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. * diff --git a/core/modules/views/src/Plugin/views/field/Markup.php b/core/modules/views/src/Plugin/views/field/Markup.php index 5ddd5a514fc..4fa5df88b52 100644 --- a/core/modules/views/src/Plugin/views/field/Markup.php +++ b/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 - * format field. + * Handler to run a field through check_markup, using a companion 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 diff --git a/core/modules/views/src/Plugin/views/filter/ManyToOne.php b/core/modules/views/src/Plugin/views/filter/ManyToOne.php index 9fd8a42fe8a..846f37b42fc 100644 --- a/core/modules/views/src/Plugin/views/filter/ManyToOne.php +++ b/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, - * such as terms (many terms per node) or roles (many roles per user). + * Complex filter to handle filtering for many to one relationships. + * + * 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 diff --git a/core/modules/views/src/Plugin/views/filter/StringFilter.php b/core/modules/views/src/Plugin/views/filter/StringFilter.php index 5d027309a4a..a4cc9eb76e3 100644 --- a/core/modules/views/src/Plugin/views/filter/StringFilter.php +++ b/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 - * including equality, like, not like, etc. + * Basic textfield filter to handle string filtering commands. + * + * Including equality, like, not like, etc. * * @ingroup views_filter_handlers * diff --git a/core/modules/views/src/Plugin/views/relationship/GroupwiseMax.php b/core/modules/views/src/Plugin/views/relationship/GroupwiseMax.php index ab202b06bbd..ab6becbdd68 100644 --- a/core/modules/views/src/Plugin/views/relationship/GroupwiseMax.php +++ b/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 diff --git a/core/modules/views/src/Plugin/views/style/DefaultStyle.php b/core/modules/views/src/Plugin/views/style/DefaultStyle.php index fe67d9beed2..7c6afea00e4 100644 --- a/core/modules/views/src/Plugin/views/style/DefaultStyle.php +++ b/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 - * decorations. + * Unformatted style plugin to render rows. + * + * Row are rendered one after another with no decorations. * * @ingroup views_style_plugins *