Fix 'Drupal.Commenting.ClassComment' coding standard

What commit was this made against? I'm happy to help split it down into more manageable patches so it's not so huge.

This patch just generate more coding standard bugs, it really needs a deep check and fix all of those empty doc what are generated with this patch.

As agreed between the mentors at Drupalcon, according to issues to avoid for novices, I am untagging this issue as "Beginner". This issue contains changes across a very wide range of files and might create too many other patches to need to be rerolled at this particular time. This patch has an automated way to be rerolled later so better to implement it after Drupalcon.

patch outdated

New patch with removed Drupal.Commenting.ClassComment sniff from phpcs.xml.dist file.

Suppose this issue should not be blocked because changing only a doc block

+++ b/core/lib/Drupal/Core/Archiver/ArchiveTar.php
@@ -107,7 +107,9 @@ function gzseek($zp, $offset, $whence = SEEK_SET)
-// Drupal change class Archive_Tar extends PEAR.
+/**
+ *Drupal change class Archive_Tar extends PEAR.
+ */

This is only change in blocker #2610984: Add Archive Tar via Composer, with BC shim

Is this issue still relevant?

Patch is outdated

Hi guys,
reroll is ready, waiting for tests

+++ b/core/lib/Drupal/Core/Archiver/ArchiveTar.php
@@ -108,7 +108,9 @@ function gzseek($zp, $offset, $whence = SEEK_SET)
-// Drupal change class Archive_Tar extends PEAR.
+/**
+ *Drupal change class Archive_Tar extends PEAR.
+ */

do not change this file, please
this one is vendor locked

fixed

1. +++ b/core/modules/forum/src/Form/Overview.php
   @@ -10,8 +10,10 @@
   -/*
   - * Provides forum overview form for the forum vocabulary.
   +/**
   + *
   + *Provides forum overview form for the forum vocabulary.
   

   that's wrong

2. +++ b/core/modules/forum/src/Form/Overview.php
   @@ -10,8 +10,10 @@
   + * ¶
   

   hm

3. +++ b/core/modules/migrate/tests/src/Unit/MigrationTest.php
   @@ -174,8 +174,7 @@ public function setMigrationPluginManager(MigrationPluginManagerInterface $plugi
    interface RequirementsAwareSourceInterface extends MigrateSourceInterface, RequirementsInterface {}
   -
    /**
     * Defines the RequirementsAwareDestinationInterface.
     */
   -interface RequirementsAwareDestinationInterface extends MigrateDestinationInterface, RequirementsInterface {}
   +interface RequirementsAwareDestinationInterface extends MigrateDestinationInterface, RequirementsInterface {}
   \ No newline at end of file
   

   any reason?

4. +++ b/core/modules/taxonomy/src/Form/OverviewTerms.php
   @@ -9,8 +9,10 @@
   -/*
   - * Provides terms overview form for a taxonomy vocabulary.
   +/**
   + *
   + *Provides terms overview form for a taxonomy vocabulary.
   

   the same

5. +++ b/core/modules/taxonomy/src/Form/OverviewTerms.php
   @@ -9,8 +9,10 @@
   + * ¶
   

   hm

6. +++ b/core/modules/views/src/Plugin/views/PluginInterface.php
   @@ -3,7 +3,9 @@
   -
   +/**
   
   +++ b/core/modules/views/tests/src/Unit/EntityViewsDataTest.php
   @@ -956,14 +956,18 @@ protected static function userEntityInfo() {
   -
   +/**
   ...
   -
   +/**
   + *
   + */
   

   there's a lot of changes like this
   but there should be empty line before phpdoc

7. +++ b/core/modules/views/tests/src/Unit/Plugin/pager/PagerPluginBaseTest.php
   @@ -249,7 +249,9 @@ public function testExecuteCountQueryWithOffset() {
   -// As StatementInterface extends \Traversable, which though always needs
   -// an additional interface. The Statement class itself can't be mocked because
   -// of its __wakeup function.
   +/**
   + *As StatementInterface extends \Traversable, which though always needs
   + *an additional interface. The Statement class itself can't be mocked because
   + *of its __wakeup function.
   

   here should be space after * for each line

8. +++ b/core/phpcs.xml.dist
   @@ -46,4 +46,68 @@
   -</ruleset>
   +  <!--Blacklist of coding standard rules that are not yet fixed. Ref. https://www.drupal.org/node/2571965-->
   +  <rule ref="Drupal">
   

   I'm sure those was remove for reason, check history of the file

9. +++ b/core/phpcs.xml.dist
   @@ -46,4 +46,68 @@
   +</ruleset>
   \ No newline at end of file
   

   hm

fixed

I see no reason in empty doc blocks, so they should be filled and

+++ b/composer.json
@@ -5,7 +5,9 @@
-        "wikimedia/composer-merge-plugin": "~1.3"
+        "wikimedia/composer-merge-plugin": "~1.3",

+++ b/composer.lock
@@ -4,8 +4,8 @@
-    "content-hash": "7d72dc63a3981fb6edb92f6786ba94b1",
+    "hash": "5ad0250761817c1eff9e751c886f2290",

this changes should be removed!

>>this changes should be removed!

ok

>>>>this changes should be removed!

>>ok

done

1. +++ b/core/modules/migrate/src/Plugin/Derivative/MigrateEntityRevision.php
   @@ -4,7 +4,9 @@
   +/**
   + *
   + */
    class MigrateEntityRevision implements ContainerDeriverInterface {
   

   We can't just add empty comments - that's silly. This issue is going to take a long time to solve. Each class needs its own documentation. I suggest we split this sniff up into separate issues to fix each sub sniff. See latest patch on #2707641: Ensure core compliance to Drupal.Commenting.FunctionComment.ParamCommentIndentation (part 2) for an example of how to dow this.

2. +++ b/core/modules/migrate/tests/src/Unit/MigrationTest.php
   @@ -174,8 +174,7 @@ public function setMigrationPluginManager(MigrationPluginManagerInterface $plugi
   \ No newline at end of file
   

   This is weird there is a new line at the end of the file in HEAD

Here is a manually fixed patch after "phpcbf" and excluded "Missing" subsniffer

I think missing doc blocks needs separate issue

Perfect

Committed 246c162 and pushed to 8.1.x. Thanks!