Issue #2722609 by anoopjohn, mfernea, Jo Fitzgerald, chishah92, druprad, martin107, Mile23: Fix Drupal.Commenting.FunctionComment.ParamNameNoMatch

core/lib/Drupal/Component/Assertion/Inspector.php

@@ -205,9 +205,9 @@ class Inspector {
    * @return bool
    *   TRUE if $traversable can be traversed and all members have all keys.
    */
-  public static function assertAllHaveKey() {
+  public static function assertAllHaveKey($traversable) {
     $args = func_get_args();
-    $traversable = array_shift($args);
+    unset($args[0]);
 
     if (static::assertTraversable($traversable)) {
       foreach ($traversable as $member) {
@@ -396,9 +396,9 @@ class Inspector {
    *   TRUE if $traversable can be traversed and all members are objects with
    *   at least one of the listed classes or interfaces.
    */
-  public static function assertAllObjects() {
+  public static function assertAllObjects($traversable) {
     $args = func_get_args();
-    $traversable = array_shift($args);
+    unset($args[0]);
 
     if (static::assertTraversable($traversable)) {
       foreach ($traversable as $member) {

core/lib/Drupal/Core/Config/StorageComparer.php

@@ -433,8 +433,8 @@ class StorageComparer implements StorageComparerInterface {
    *
    * @see \Drupal\Core\Config\StorageComparerInterface::extractRenameNames()
    */
-  protected function createRenameName($name1, $name2) {
-    return $name1 . '::' . $name2;
+  protected function createRenameName($old_name, $new_name) {
+    return $old_name . '::' . $new_name;
   }
 
   /**

core/lib/Drupal/Core/Executable/ExecutablePluginBase.php

@@ -60,8 +60,8 @@ abstract class ExecutablePluginBase extends ContextAwarePluginBase implements Ex
   /**
    * Sets the value of a particular configuration option.
    *
-   * @param string $name
-   *   The name of the configuration option to set.
+   * @param string $key
+   *   The key of the configuration option to set.
    * @param mixed $value
    *   The value to set.
    *

core/lib/Drupal/Core/Installer/Exception/InstallerException.php

@@ -20,10 +20,10 @@ class InstallerException extends \RuntimeException {
   /**
    * Constructs a new installer exception.
    *
-   * @param string $title
-   *   The page title.
    * @param string $message
-   *   (optional) The exception message. Defaults to 'Error'.
+   *   The exception message.
+   * @param string $title
+   *   (optional) The page title. Defaults to 'Error'.
    * @param int $code
    *   (optional) The exception code. Defaults to 0.
    * @param \Exception $previous

core/lib/Drupal/Core/Plugin/Context/Context.php

@@ -42,7 +42,7 @@ class Context extends ComponentContext implements ContextInterface {
    *
    * @param \Drupal\Core\Plugin\Context\ContextDefinitionInterface $context_definition
    *   The context definition.
-   * @param mixed $context_value|null
+   * @param mixed|null $context_value
    *   The context value object.
    */
   public function __construct(ContextDefinitionInterface $context_definition, $context_value = NULL) {

core/lib/Drupal/Core/Render/theme.api.php

@@ -728,7 +728,7 @@ function hook_themes_installed($theme_list) {
 /**
  * Respond to themes being uninstalled.
  *
- * @param array $theme_list
+ * @param array $themes
  *   Array containing the names of the themes being uninstalled.
  *
  * @see \Drupal\Core\Extension\ThemeHandler::uninstall()

core/lib/Drupal/Core/StreamWrapper/LocalReadOnlyStream.php

@@ -147,7 +147,7 @@ abstract class LocalReadOnlyStream extends LocalStream {
    *
    * The file will not be renamed as this is a read-only stream wrapper.
    *
-   * @param string $from_uri,
+   * @param string $from_uri
    *   The uri to the file to rename.
    * @param string $to_uri
    *   The new uri for file.

core/lib/Drupal/Core/StreamWrapper/LocalStream.php

@@ -380,7 +380,7 @@ abstract class LocalStream implements StreamWrapperInterface {
   /**
    * Support for rename().
    *
-   * @param string $from_uri,
+   * @param string $from_uri
    *   The URI to the file to rename.
    * @param string $to_uri
    *   The new URI for file.

core/lib/Drupal/Core/StreamWrapper/ReadOnlyStream.php

@@ -199,7 +199,7 @@ abstract class ReadOnlyStream implements StreamWrapperInterface {
    *
    * This file will not be renamed as this is a read-only stream wrapper.
    *
-   * @param string $from_uri,
+   * @param string $from_uri
    *   The uri to the file to rename.
    * @param string $to_uri
    *   The new uri for file.

core/lib/Drupal/Core/Utility/Token.php

@@ -155,7 +155,7 @@ class Token {
    *     array of token replacements after they are generated.
    *   - clear: A boolean flag indicating that tokens should be removed from the
    *     final text if no replacement value can be generated.
-   * @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata|null
+   * @param \Drupal\Core\Render\BubbleableMetadata|null $bubbleable_metadata
    *   (optional) An object to which static::generate() and the hooks and
    *   functions that it invokes will add their required bubbleable metadata.
    *

core/modules/block_content/tests/src/Kernel/Migrate/MigrateBlockContentEntityFormDisplayTest.php

@@ -35,7 +35,7 @@ class MigrateBlockContentEntityFormDisplayTest extends MigrateDrupal7TestBase {
    *
    * @param string $id
    *   The entity ID.
-   * @param string $component
+   * @param string $component_id
    *   The ID of the form component.
    */
   protected function assertDisplay($id, $component_id) {

core/modules/comment/tests/src/Kernel/Migrate/d7/MigrateCommentEntityFormDisplayTest.php

@@ -34,7 +34,7 @@ class MigrateCommentEntityFormDisplayTest extends MigrateDrupal7TestBase {
    *
    * @param string $id
    *   The entity ID.
-   * @param string $component
+   * @param string $component_id
    *   The ID of the form component.
    */
   protected function assertDisplay($id, $component_id) {

core/modules/editor/editor.api.php

@@ -51,7 +51,7 @@ function hook_editor_js_settings_alter(array &$settings) {
  * @param \Drupal\filter\FilterFormatInterface $format
  *   The text format configuration entity. Provides context based upon which
  *   one may want to adjust the filtering.
- * @param \Drupal\filter\FilterFormatInterface $original_format|null
+ * @param \Drupal\filter\FilterFormatInterface|null $original_format
  *   (optional) The original text format configuration entity (when switching
  *   text formats/editors). Also provides context based upon which one may want
  *   to adjust the filtering.

core/modules/editor/editor.module

@@ -278,7 +278,7 @@ function editor_load($format_id) {
  * @param \Drupal\filter\FilterFormatInterface|null $format
  *   The text format whose text editor will be used or NULL if the previously
  *   defined text format is now disabled.
- * @param \Drupal\filter\FilterFormatInterface $original_format|null
+ * @param \Drupal\filter\FilterFormatInterface|null $original_format
  *   (optional) The original text format (i.e. when switching text formats,
  *   $format is the text format that is going to be used, $original_format is
  *   the one that was being used initially, the one that is stored in the

core/modules/field/tests/src/Kernel/Migrate/d7/MigrateViewModesTest.php

@@ -34,8 +34,6 @@ class MigrateViewModesTest extends MigrateDrupal7TestBase {
    *   The expected label of the view mode.
    * @param string $entity_type
    *   The expected entity type ID which owns the view mode.
-   * @param bool $status
-   *   The expected status of the view mode.
    */
   protected function assertEntity($id, $label, $entity_type) {
     /** @var \Drupal\Core\Entity\EntityViewModeInterface $view_mode */

core/modules/hal/src/Normalizer/FieldItemNormalizer.php

@@ -110,7 +110,7 @@ class FieldItemNormalizer extends NormalizerBase {
    * entity. This is the reason for using target_instances, from which the
    * property path can be traversed up to the root.
    *
-   * @param \Drupal\Core\Field\FieldItemInterface $field_item
+   * @param \Drupal\Core\Field\FieldItemInterface $item
    *   The untranslated field item instance.
    * @param $langcode
    *   The langcode.

core/modules/hal/src/Normalizer/FieldNormalizer.php

@@ -51,8 +51,8 @@ class FieldNormalizer extends SerializationFieldNormalizer {
   /**
    * Helper function to normalize field items.
    *
-   * @param \Drupal\Core\Field\FieldItemListInterface $field
-   *   The field object.
+   * @param \Drupal\Core\Field\FieldItemListInterface $field_items
+   *   The field item list object.
    * @param string $format
    *   The format.
    * @param array $context

core/modules/language/src/EventSubscriber/LanguageRequestSubscriber.php

@@ -52,7 +52,7 @@ class LanguageRequestSubscriber implements EventSubscriberInterface {
    *   The language manager service.
    * @param \Drupal\language\LanguageNegotiatorInterface $negotiator
    *   The language negotiator.
-   * @param \Drupal\Core\StringTranslation\Translator\TranslatorInterface $translation;
+   * @param \Drupal\Core\StringTranslation\Translator\TranslatorInterface $translation
    *   The translation service.
    * @param \Drupal\Core\Session\AccountInterface $current_user
    *   The current active user.

core/modules/language/src/Form/NegotiationBrowserForm.php

@@ -23,9 +23,6 @@ class NegotiationBrowserForm extends ConfigFormBase {
 
   /**
    * {@inheritdoc}
-   *
-   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
-   *   The module handler
    */
   public function __construct(ConfigFactoryInterface $config_factory, ConfigurableLanguageManagerInterface $language_manager ) {
     parent::__construct($config_factory);

core/modules/language/src/LanguageNegotiationMethodInterface.php

@@ -24,7 +24,7 @@ interface LanguageNegotiationMethodInterface {
   /**
    * Injects the configuration factory.
    *
-   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config
    *   The configuration factory.
    */
   public function setConfig(ConfigFactoryInterface $config);

core/modules/language/tests/language_test/src/Controller/LanguageTestController.php

@@ -53,7 +53,7 @@ class LanguageTestController implements ContainerInjectionInterface {
   /**
    * Route entity upcasting test helper.
    *
-   * @param \Drupal\language\ConfigurableLanguageInterface $language
+   * @param \Drupal\language\ConfigurableLanguageInterface $configurable_language
    *   The ConfigurableLanguage object from the route.
    *
    * @return string

core/modules/migrate/src/Plugin/MigrationInterface.php

@@ -153,7 +153,7 @@ interface MigrationInterface extends PluginInspectionInterface, DerivativeInspec
   /**
    * Set the current migration status.
    *
-   * @param int $result
+   * @param int $status
    *   One of the STATUS_* constants.
    */
   public function setStatus($status);

core/modules/migrate_drupal/src/Plugin/migrate/destination/EntityFieldStorageConfig.php

@@ -49,10 +49,10 @@ class EntityFieldStorageConfig extends BaseEntityFieldStorageConfig {
    *   The list of bundles this entity type has.
    * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
    *   The language manager.
-   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_plugin_manager
-   *   The field type plugin manager.
    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
    *   The configuration factory.
+   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_plugin_manager
+   *   The field type plugin manager.
    */
   public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory, FieldTypePluginManagerInterface $field_type_plugin_manager) {
     parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles, $language_manager, $config_factory, $field_type_plugin_manager);

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

@@ -29,7 +29,7 @@ class Type extends StringArgument {
    *   The plugin_id for the plugin instance.
    * @param mixed $plugin_definition
    *   The plugin implementation definition.
-   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
+   * @param \Drupal\Core\Entity\EntityStorageInterface $node_type_storage
    *   The entity storage class.
    */
   public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityStorageInterface $node_type_storage) {

core/modules/rest/src/EventSubscriber/RestConfigSubscriber.php

@@ -22,7 +22,7 @@ class RestConfigSubscriber implements EventSubscriberInterface {
   /**
    * Constructs the RestConfigSubscriber.
    *
-   * @param \Drupal\Core\Routing\RouteBuilderInterface $route_builder
+   * @param \Drupal\Core\Routing\RouteBuilderInterface $router_builder
    *   The router builder service.
    */
   public function __construct(RouteBuilderInterface $router_builder) {

core/modules/search/src/Controller/SearchController.php

@@ -149,8 +149,6 @@ class SearchController extends ControllerBase {
   /**
    * Creates a render array for the search help page.
    *
-   * @param \Symfony\Component\HttpFoundation\Request $request
-   *   The request object.
    * @param \Drupal\search\SearchPageInterface $entity
    *   The search page entity.
    *

core/modules/simpletest/simpletest.module

@@ -794,7 +794,7 @@ function simpletest_phpunit_xml_to_rows($test_id, $phpunit_xml_file) {
  *
  * @param \SimpleXMLElement $element
  *   The PHPUnit xml to search for test cases.
- * @param \SimpleXMLElement $suite
+ * @param \SimpleXMLElement $parent
  *   (Optional) The parent of the current element. Defaults to NULL.
  *
  * @return array

core/modules/simpletest/src/Form/SimpletestResultsForm.php

@@ -235,7 +235,7 @@ class SimpletestResultsForm extends FormBase {
    *
    * @param array $form
    *   The form to attach the results to.
-   * @param array $test_results
+   * @param array $results
    *   The simpletest results.
    *
    * @return array

core/modules/simpletest/src/TestDiscovery.php

@@ -309,7 +309,7 @@ class TestDiscovery {
   /**
    * Retrieves information about a test class for UI purposes.
    *
-   * @param string $class
+   * @param string $classname
    *   The test classname.
    * @param string $doc_comment
    *   (optional) The class PHPDoc comment. If not passed in reflection will be

core/modules/system/src/SystemConfigSubscriber.php

@@ -25,7 +25,7 @@ class SystemConfigSubscriber implements EventSubscriberInterface {
   /**
    * Constructs the SystemConfigSubscriber.
    *
-   * @param \Drupal\Core\Routing\RouteBuilderInterface $route_builder
+   * @param \Drupal\Core\Routing\RouteBuilderInterface $router_builder
    *   The router builder service.
    */
   public function __construct(RouteBuilderInterface $router_builder) {

core/modules/taxonomy/src/Tests/TaxonomyTranslationTestTrait.php

@@ -78,10 +78,6 @@ trait TaxonomyTranslationTestTrait {
 
   /**
    * Adds term reference field for the article content type.
-   *
-   * @param bool $translatable
-   *   (optional) If TRUE, create a translatable term reference field. Defaults
-   *   to FALSE.
    */
   protected function setUpTermReferenceField() {
     $handler_settings = [

core/modules/taxonomy/tests/src/Functional/TaxonomyTranslationTestTrait.php

@@ -73,10 +73,6 @@ trait TaxonomyTranslationTestTrait {
 
   /**
    * Adds term reference field for the article content type.
-   *
-   * @param bool $translatable
-   *   (optional) If TRUE, create a translatable term reference field. Defaults
-   *   to FALSE.
    */
   protected function setUpTermReferenceField() {
     $handler_settings = [

core/modules/user/src/Form/UserPasswordForm.php

@@ -60,9 +60,6 @@ class UserPasswordForm extends FormBase {
 
   /**
    * {@inheritdoc}
-   *
-   * @param \Symfony\Component\HttpFoundation\Request $request
-   *   The request object.
    */
   public function buildForm(array $form, FormStateInterface $form_state) {
     $form['name'] = [

core/modules/user/src/Form/UserPermissionsRoleSpecificForm.php

@@ -25,10 +25,14 @@ class UserPermissionsRoleSpecificForm extends UserPermissionsForm {
   }
 
   /**
-   * {@inheritdoc}
+   * Builds the user permissions administration form for a specific role.
    *
-   * @param string $role_id
-   *   The user role ID used for this form.
+   * @param array $form
+   *   An associative array containing the structure of the form.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The current state of the form.
+   * @param \Drupal\user\RoleInterface|null $user_role
+   *   (optional) The user role used for this form. Defaults to NULL.
    */
   public function buildForm(array $form, FormStateInterface $form_state, RoleInterface $user_role = NULL) {
     $this->userRole = $user_role;

core/modules/views/src/Tests/ViewTestBase.php

@@ -95,7 +95,7 @@ abstract class ViewTestBase extends WebTestBase {
    *
    * @param string $id
    *   The HTML ID of the button
-   * @param string $label
+   * @param string $expected_label
    *   The expected label for the button.
    * @param string $message
    *   (optional) A custom message to display with the assertion. If no custom

core/modules/views/tests/src/Unit/Plugin/query/SqlTest.php

@@ -139,7 +139,7 @@ class SqlTest extends UnitTestCase {
    *
    * @param \Drupal\Core\Entity\EntityInterface[][] $entities_by_type
    *   Test entities keyed by entity type and entity ID.
-   * @param \Drupal\Core\Entity\EntityInterface[][] $entities_by_type
+   * @param \Drupal\Core\Entity\EntityInterface[][] $entity_revisions_by_type
    *   Test entities keyed by entity type and revision ID.
    *
    * @return \Prophecy\Prophecy\ObjectProphecy

core/phpcs.xml.dist

@@ -62,7 +62,6 @@
     <exclude name="Drupal.Commenting.FunctionComment.ParamCommentFullStop"/>
     <exclude name="Drupal.Commenting.FunctionComment.ParamCommentIndentation"/>
     <exclude name="Drupal.Commenting.FunctionComment.ParamMissingDefinition"/>
-    <exclude name="Drupal.Commenting.FunctionComment.ParamNameNoMatch"/>
     <exclude name="Drupal.Commenting.FunctionComment.TypeHintMissing"/>
   </rule>
   <rule ref="../vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/ControlStructures/ElseIfSniff.php"/>

core/tests/Drupal/Tests/Core/Render/RendererPlaceholdersTest.php

@@ -547,12 +547,11 @@ class RendererPlaceholdersTest extends RendererTestBase {
 
   /**
    * @param false|array $cid_parts
-   * @param array $expected_data
-   *   FALSE if no render cache item is expected, a render array with the
-   *   expected values if a render cache item is expected.
    * @param string[] $bubbled_cache_contexts
    *   Additional cache contexts that were bubbled when the placeholder was
    *   rendered.
+   * @param array $expected_data
+   *   A render array with the expected values.
    */
   protected function assertPlaceholderRenderCache($cid_parts, array $bubbled_cache_contexts, array $expected_data) {
     if ($cid_parts !== FALSE) {