CS: remove class/function end comments

Includes removing the rule from the PHPCS native ruleset and adding another one to enforce the opposite, i.e. forbid end comments.

Author: jrfnl

autoload.php

@@ -141,7 +141,7 @@ public static function load(string $className)
 
             return false;
 
-        }//end load()
+        }
 
 
         /**
@@ -184,7 +184,7 @@ public static function loadFile(string $path)
             self::$loadedFiles[$className] = $path;
             return self::$loadedClasses[$path];
 
-        }//end loadFile()
+        }
 
 
         /**
@@ -245,7 +245,7 @@ static function ($remaining, $current) {
 
             return $className;
 
-        }//end determineLoadedClass()
+        }
 
 
         /**
@@ -260,7 +260,7 @@ public static function addSearchPath(string $path, string $nsPrefix = '')
         {
             self::$searchPaths[$path] = rtrim(trim((string) $nsPrefix), '\\');
 
-        }//end addSearchPath()
+        }
 
 
         /**
@@ -272,7 +272,7 @@ public static function getSearchPaths()
         {
             return self::$searchPaths;
 
-        }//end getSearchPaths()
+        }
 
 
         /**
@@ -291,7 +291,7 @@ public static function getLoadedClassName(string $path)
 
             return self::$loadedClasses[$path];
 
-        }//end getLoadedClassName()
+        }
 
 
         /**
@@ -310,7 +310,7 @@ public static function getLoadedFileName(string $className)
 
             return self::$loadedFiles[$className];
 
-        }//end getLoadedFileName()
+        }
 
 
         /**
@@ -322,7 +322,7 @@ public static function getLoadedClasses()
         {
             return self::$loadedClasses;
 
-        }//end getLoadedClasses()
+        }
 
 
         /**
@@ -334,10 +334,10 @@ public static function getLoadedFiles()
         {
             return self::$loadedFiles;
 
-        }//end getLoadedFiles()
+        }
 
 
-    }//end class
+    }
 
     // Register the autoloader before any existing autoloaders to ensure
     // it gets a chance to hear about every autoload request, and record

phpcs.xml.dist

@@ -37,7 +37,7 @@
     <!-- Include some sniffs from other standards that don't conflict with PEAR -->
     <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
     <rule ref="Squiz.Arrays.ArrayDeclaration"/>
-    <rule ref="Squiz.Commenting.ClosingDeclarationComment"/>
+    <rule ref="PSR12.Classes.ClosingBrace"/>
     <rule ref="Squiz.ControlStructures.ControlSignature"/>
     <rule ref="PSR2.ControlStructures.ElseIfDeclaration"/>
     <rule ref="Squiz.Commenting.BlockComment"/>

requirements.php

@@ -70,4 +70,4 @@ function checkRequirements()
         exit($exitCode);
     }
 
-}//end checkRequirements()
+}

scripts/BuildRequirementsCheckMatrix.php

@@ -72,7 +72,7 @@ public function getBuilds()
 
         return $builds;
 
-    }//end getBuilds()
+    }
 
 
     /**
@@ -106,7 +106,7 @@ private function getValidBuilds()
 
         return $builds;
 
-    }//end getValidBuilds()
+    }
 
 
     /**
@@ -138,7 +138,7 @@ private function getInvalidPHPBuilds()
 
         return $builds;
 
-    }//end getInvalidPHPBuilds()
+    }
 
 
     /**
@@ -182,7 +182,7 @@ private function getMissingExtensionsBuilds()
 
         return $builds;
 
-    }//end getMissingExtensionsBuilds()
+    }
 
 
-}//end class
+}

scripts/build-phar.php

@@ -76,7 +76,7 @@ function stripWhitespaceAndComments(string $fullpath, Config $config)
 
     return $stripped;
 
-}//end stripWhitespaceAndComments()
+}
 
 
 Timing::startTiming();

src/Config.php

@@ -276,7 +276,7 @@ public function __get(string $name)
 
         return $this->settings[$name];
 
-    }//end __get()
+    }
 
 
     /**
@@ -349,7 +349,7 @@ public function __set(string $name, $value)
 
         $this->settings[$name] = $value;
 
-    }//end __set()
+    }
 
 
     /**
@@ -363,7 +363,7 @@ public function __isset(string $name)
     {
         return isset($this->settings[$name]);
 
-    }//end __isset()
+    }
 
 
     /**
@@ -377,7 +377,7 @@ public function __unset(string $name)
     {
         $this->settings[$name] = null;
 
-    }//end __unset()
+    }
 
 
     /**
@@ -389,7 +389,7 @@ public function getSettings()
     {
         return $this->settings;
 
-    }//end getSettings()
+    }
 
 
     /**
@@ -403,7 +403,7 @@ public function setSettings(array $settings)
     {
         $this->settings = $settings;
 
-    }//end setSettings()
+    }
 
 
     /**
@@ -488,7 +488,7 @@ public function __construct(array $cliArgs = [], bool $dieOnUnknownArg = true)
 
         fclose($handle);
 
-    }//end __construct()
+    }
 
 
     /**
@@ -539,7 +539,7 @@ public function setCommandLineValues(array $args)
             }//end if
         }//end for
 
-    }//end setCommandLineValues()
+    }
 
 
     /**
@@ -663,7 +663,7 @@ public function restoreDefaults()
             $this->parallel = max((int) $parallel, 1);
         }
 
-    }//end restoreDefaults()
+    }
 
 
     /**
@@ -775,7 +775,7 @@ public function processShortArgument(string $arg, int $pos)
             }
         }//end switch
 
-    }//end processShortArgument()
+    }
 
 
     /**
@@ -1307,7 +1307,7 @@ public function processLongArgument(string $arg, int $pos)
             break;
         }//end switch
 
-    }//end processLongArgument()
+    }
 
 
     /**
@@ -1394,7 +1394,7 @@ static function ($carry, $item) {
 
         return $sniffs;
 
-    }//end parseSniffCodes()
+    }
 
 
     /**
@@ -1423,7 +1423,7 @@ public function processUnknownArgument(string $arg, int $pos)
 
         $this->processFilePath($arg);
 
-    }//end processUnknownArgument()
+    }
 
 
     /**
@@ -1459,7 +1459,7 @@ public function processFilePath(string $path)
             $this->overriddenDefaults['files'] = true;
         }
 
-    }//end processFilePath()
+    }
 
 
     /**
@@ -1479,7 +1479,7 @@ public function printUsage()
 
         echo PHP_EOL;
 
-    }//end printUsage()
+    }
 
 
     /**
@@ -1506,7 +1506,7 @@ public function printShortUsage(bool $returnOutput = false)
 
         echo $usage;
 
-    }//end printShortUsage()
+    }
 
 
     /**
@@ -1532,7 +1532,7 @@ public function printPHPCSUsage()
 
         (new Help($this, $longOptions, $shortOptions))->display();
 
-    }//end printPHPCSUsage()
+    }
 
 
     /**
@@ -1548,7 +1548,7 @@ public function printPHPCBFUsage()
 
         (new Help($this, $longOptions, $shortOptions))->display();
 
-    }//end printPHPCBFUsage()
+    }
 
 
     /**
@@ -1574,7 +1574,7 @@ public static function getConfigData(string $key)
 
         return $phpCodeSnifferConfig[$key];
 
-    }//end getConfigData()
+    }
 
 
     /**
@@ -1615,7 +1615,7 @@ public static function getExecutablePath(string $name)
         self::$executablePaths[$name] = $result;
         return $result;
 
-    }//end getExecutablePath()
+    }
 
 
     /**
@@ -1697,7 +1697,7 @@ public function setConfigData(string $key, ?string $value, bool $temp = false)
 
         return true;
 
-    }//end setConfigData()
+    }
 
 
     /**
@@ -1739,7 +1739,7 @@ public static function getAllConfigData()
         self::$configData     = $phpCodeSnifferConfig;
         return self::$configData;
 
-    }//end getAllConfigData()
+    }
 
 
     /**
@@ -1774,7 +1774,7 @@ public function prepareConfigDataForDisplay(array $data)
 
         return $output;
 
-    }//end prepareConfigDataForDisplay()
+    }
 
 
     /**
@@ -1790,7 +1790,7 @@ public function printConfigData(array $data)
     {
         echo $this->prepareConfigDataForDisplay($data);
 
-    }//end printConfigData()
+    }
 
 
-}//end class
+}

src/Exceptions/DeepExitException.php

@@ -22,4 +22,4 @@
 class DeepExitException extends Exception
 {
 
-}//end class
+}

src/Exceptions/GeneratorException.php

@@ -15,4 +15,4 @@
 class GeneratorException extends DomainException
 {
 
-}//end class
+}

src/Exceptions/RuntimeException.php

@@ -14,4 +14,4 @@
 class RuntimeException extends PHPRuntimeException
 {
 
-}//end class
+}

src/Exceptions/TokenizerException.php

@@ -14,4 +14,4 @@
 class TokenizerException extends Exception
 {
 
-}//end class
+}