Issue #2707371 by Mile23: Fix several errors in the 'Drupal.Commenting.DocComment' coding standard

core/lib/Drupal/Component/Bridge/ZfExtensionManagerSfContainer.php

@@ -15,9 +15,9 @@ class ZfExtensionManagerSfContainer implements ReaderManagerInterface, WriterMan
   /**
    * This property was based from Zend Framework (http://framework.zend.com/)
    *
-   * @link      http://github.com/zendframework/zf2 for the canonical source repository
+   * @link http://github.com/zendframework/zf2 for the canonical source repository
    * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
-   * @license   http://framework.zend.com/license/new-bsd New BSD License
+   * @license http://framework.zend.com/license/new-bsd New BSD License
    *
    * A map of characters to be replaced through strtr.
    *
@@ -75,9 +75,9 @@ public function has($extension) {
   /**
    * This method was based from Zend Framework (http://framework.zend.com/)
    *
-   * @link      http://github.com/zendframework/zf2 for the canonical source repository
+   * @link http://github.com/zendframework/zf2 for the canonical source repository
    * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
-   * @license   http://framework.zend.com/license/new-bsd New BSD License
+   * @license http://framework.zend.com/license/new-bsd New BSD License
    *
    * Canonicalize the extension name to a service name.
    *

core/lib/Drupal/Component/Utility/UrlHelper.php

@@ -19,7 +19,6 @@ class UrlHelper {
   /**
    * Parses an array into a valid, rawurlencoded query string.
    *
-   *
    * rawurlencode() is RFC3986 compliant, and as a consequence RFC3987
    * compliant. The latter defines the required format of "URLs" in HTML5.
    * urlencode() is almost the same as rawurlencode(), except that it encodes

core/lib/Drupal/Core/Http/TrustedHostsRequestFactory.php

@@ -56,7 +56,7 @@ public function __construct($host) {
    *
    * @return \Symfony\Component\HttpFoundation\Request
    *   A new request object.
-   **/
+   */
   public function createRequest(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), $content = NULL) {
     if (empty($server['HTTP_HOST']) || ($server['HTTP_HOST'] === 'localhost' && $this->host !== 'localhost')) {
       $server['HTTP_HOST'] = $this->host;

core/lib/Drupal/Core/Routing/UrlGenerator.php

@@ -153,7 +153,6 @@ public function getPathFromRoute($name, $parameters = array()) {
    * @param string $name
    *   The route name or other identifying string from ::getRouteDebugMessage().
    *
-   *
    * @return string
    *   The url path, without any base path, including possible query string.
    *

core/modules/action/src/Plugin/Action/EmailAction.php

@@ -55,7 +55,8 @@ class EmailAction extends ConfigurableActionBase implements ContainerFactoryPlug
    */
   protected $mailManager;
 
-  /** The language manager.
+  /**
+   * The language manager.
    *
    * @var \Drupal\Core\Language\LanguageManagerInterface
    */

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

@@ -24,7 +24,7 @@ abstract class LanguageFormBase extends EntityForm {
   /**
    * Constructs a ContentEntityForm object.
    *
-   * @param  \Drupal\language\ConfigurableLanguageManagerInterface $language_manager
+   * @param \Drupal\language\ConfigurableLanguageManagerInterface $language_manager
    *   The configurable language manager.
    */
   public function __construct(ConfigurableLanguageManagerInterface $language_manager) {

core/modules/migrate/tests/src/Unit/process/DedupeEntityTest.php

@@ -22,7 +22,7 @@ class DedupeEntityTest extends MigrateProcessTestCase {
   /**
    * The mock entity query factory.
    *
-   * @var  \Drupal\Core\Entity\Query\QueryFactory|\PHPUnit_Framework_MockObject_MockObject
+   * @var \Drupal\Core\Entity\Query\QueryFactory|\PHPUnit_Framework_MockObject_MockObject
    */
   protected $entityQueryFactory;
 

core/modules/page_cache/tests/modules/page_cache_form_test.install

@@ -2,7 +2,6 @@
 
 /**
  * @file
- *
  * Install hooks for page_cache_form_test.
  */
 

core/modules/rest/tests/src/Kernel/RequestHandlerTest.php

@@ -126,9 +126,11 @@ public function providerTestSerialization() {
 
 }
 
+/**
+ * Stub class where we can prophesize methods.
+ */
 class StubRequestHandlerResourcePlugin extends ResourceBase {
 
-  /** stub methods so they can be prophesied. */
   function get() {}
   function patch() {}
 }

core/modules/simpletest/src/WebTestBase.php

@@ -1507,7 +1507,7 @@ protected function drupalGetXHR($path, array $options = array(), array $headers
    *   $edit = array(...);
    *   $this->drupalPostForm(NULL, $edit, t('Save'));
    *   @endcode
-   * @param  $edit
+   * @param $edit
    *   Field data in an associative array. Changes the current input fields
    *   (where possible) to the values indicated.
    *
@@ -2310,7 +2310,6 @@ protected function clickLink($label, $index = 0) {
   /**
    * Follows a link by partial name.
    *
-   *
    * If the link is discovered and clicked, the test passes. Fail otherwise.
    *
    * @param string|\Drupal\Component\Render\MarkupInterface $label

core/modules/views/src/EventSubscriber/ViewsEntitySchemaSubscriber.php

@@ -269,7 +269,6 @@ protected function baseTableRename($all_views, $entity_type_id, $old_base_table,
   }
 
   /**
-   *
    * Updates views if a data table is renamed.
    *
    * @param \Drupal\views\Entity\View[] $all_views

core/phpcs.xml.dist

@@ -16,6 +16,23 @@
   <rule ref="Drupal.Classes.UnusedUseStatement"/>
   <rule ref="Drupal.CSS.ClassDefinitionNameSpacing"/>
   <rule ref="Drupal.CSS.ColourDefinition"/>
+  <rule ref="Drupal.Commenting.DocComment">
+    <!-- Sniff for these errors: SpacingAfterTagGroup, WrongEnd, SpacingBetween,
+      ContentAfterOpen, SpacingBeforeShort, TagValueIndent -->
+    <exclude name="Drupal.Commenting.DocComment.ShortStartSpace"/>
+    <exclude name="Drupal.Commenting.DocComment.LongNotCapital"/>
+    <exclude name="Drupal.Commenting.DocComment.ParamGroup"/>
+    <exclude name="Drupal.Commenting.DocComment.SpacingAfter"/>
+    <exclude name="Drupal.Commenting.DocComment.ParamNotFirst"/>
+    <exclude name="Drupal.Commenting.DocComment.SpacingBeforeTags"/>
+    <exclude name="Drupal.Commenting.DocComment.LongFullStop"/>
+    <exclude name="Drupal.Commenting.DocComment.ShortNotCapital"/>
+    <exclude name="Drupal.Commenting.DocComment.ShortFullStop"/>
+    <exclude name="Drupal.Commenting.DocComment.TagsNotGrouped"/>
+    <exclude name="Drupal.Commenting.DocComment.ShortSingleLine"/>
+    <exclude name="Drupal.Commenting.DocComment.TagGroupSpacing"/>
+    <exclude name="Drupal.Commenting.DocComment.MissingShort"/>
+  </rule>
   <rule ref="Drupal.Commenting.DocCommentStar"/>
   <rule ref="Drupal.Commenting.FileComment"/>
   <rule ref="Drupal.Commenting.FunctionComment">

core/tests/Drupal/KernelTests/Core/Path/AliasStorageTest.php

@@ -16,7 +16,9 @@ class AliasStorageTest extends KernelTestBase {
    */
   public static $modules = ['system'];
 
-  /** @var \Drupal\Core\Path\AliasStorage */
+  /**
+   * @var \Drupal\Core\Path\AliasStorage
+   */
   protected $storage;
 
   /**

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

@@ -31,7 +31,7 @@ class CustomPageExceptionHtmlSubscriberTest extends UnitTestCase {
   /**
    * The mocked config factory
    *
-   * @var  \Drupal\Core\Config\ConfigFactoryInterface|\PHPUnit_Framework_MockObject_MockObject
+   * @var \Drupal\Core\Config\ConfigFactoryInterface|\PHPUnit_Framework_MockObject_MockObject
    */
   protected $configFactory;
 

core/tests/Drupal/Tests/Core/Form/FormTestBase.php

@@ -113,7 +113,6 @@ abstract class FormTestBase extends UnitTestCase {
   protected $elementInfo;
 
   /**
-   *
    * The event dispatcher.
    *
    * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface|\PHPUnit_Framework_MockObject_MockObject

core/tests/Drupal/Tests/Core/Plugin/Discovery/DerivativeDiscoveryDecoratorTest.php

@@ -29,7 +29,7 @@ protected function setUp() {
   /**
    * Tests the getDerivativeFetcher method.
    *
-   * @see  \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator::getDerivativeFetcher().
+   * @see \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator::getDerivativeFetcher().
    */
   public function testGetDerivativeFetcher() {
     $definitions = array();

core/tests/Drupal/Tests/Core/TypedData/RecursiveContextualValidatorTest.php

@@ -315,7 +315,6 @@ public function testValidatePropertyValue() {
   }
 
   /**
-   *
    * Builds some example type data object.
    *
    * @return \Drupal\Core\TypedData\TypedDataInterface|\PHPUnit_Framework_MockObject_MockObject