Merge branch 'feature/minor-doc-fixes' of https://github.com/jrfnl/PHP_CodeSniffer

gsherwood · gsherwood · commit 631f8a2b0eca · 2019-01-07T08:49:57.000+11:00
diff --git a/autoload.php b/autoload.php
@@ -23,7 +23,7 @@ class Autoload
         /**
          * The composer autoloader.
          *
-         * @var Composer\Autoload\ClassLoader
+         * @var \Composer\Autoload\ClassLoader
          */
         private static $composerAutoloader = null;
 
diff --git a/src/Config.php b/src/Config.php
@@ -188,7 +188,7 @@ class Config
      * @param string $name The name of the property.
      *
      * @return mixed
-     * @throws RuntimeException If the setting name is invalid.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid.
      */
     public function __get($name)
     {
@@ -208,7 +208,7 @@ public function __get($name)
      * @param mixed  $value The value of the property.
      *
      * @return void
-     * @throws RuntimeException If the setting name is invalid.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid.
      */
     public function __set($name, $value)
     {
@@ -1555,7 +1555,7 @@ public static function getExecutablePath($name)
      *
      * @return bool
      * @see    getConfigData()
-     * @throws RuntimeException If the config file can not be written.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the config file can not be written.
      */
     public static function setConfigData($key, $value, $temp=false)
     {
diff --git a/src/Reporter.php b/src/Reporter.php
@@ -92,7 +92,7 @@ class Reporter
      * @param \PHP_CodeSniffer\Config $config The config data for the run.
      *
      * @return void
-     * @throws RuntimeException If a report is not available.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If a report is not available.
      */
     public function __construct(Config $config)
     {
diff --git a/src/Ruleset.php b/src/Ruleset.php
@@ -305,7 +305,7 @@ public function explain()
      *                            is only used for debug output.
      *
      * @return string[]
-     * @throws RuntimeException If the ruleset path is invalid.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the ruleset path is invalid.
      */
     public function processRuleset($rulesetPath, $depth=0)
     {
@@ -660,7 +660,7 @@ private function expandSniffDirectory($directory, $depth=0)
      *                           is only used for debug output.
      *
      * @return array
-     * @throws RuntimeException If the reference is invalid.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the reference is invalid.
      */
     private function expandRulesetReference($ref, $rulesetDir, $depth=0)
     {
@@ -836,13 +836,13 @@ private function expandRulesetReference($ref, $rulesetDir, $depth=0)
     /**
      * Processes a rule from a ruleset XML file, overriding built-in defaults.
      *
-     * @param SimpleXMLElement $rule      The rule object from a ruleset XML file.
-     * @param string[]         $newSniffs An array of sniffs that got included by this rule.
-     * @param int              $depth     How many nested processing steps we are in.
-     *                                    This is only used for debug output.
+     * @param \SimpleXMLElement $rule      The rule object from a ruleset XML file.
+     * @param string[]          $newSniffs An array of sniffs that got included by this rule.
+     * @param int               $depth     How many nested processing steps we are in.
+     *                                     This is only used for debug output.
      *
      * @return void
-     * @throws RuntimeException If rule settings are invalid.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If rule settings are invalid.
      */
     private function processRule($rule, $newSniffs, $depth=0)
     {
@@ -1073,7 +1073,7 @@ private function processRule($rule, $newSniffs, $depth=0)
     /**
      * Determine if an element should be processed or ignored.
      *
-     * @param SimpleXMLElement $element An object from a ruleset XML file.
+     * @param \SimpleXMLElement $element An object from a ruleset XML file.
      *
      * @return bool
      */
@@ -1174,7 +1174,7 @@ public function registerSniffs($files, $restrictions, $exclusions)
      * Populates the array of PHP_CodeSniffer_Sniff's for this file.
      *
      * @return void
-     * @throws RuntimeException If sniff registration fails.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If sniff registration fails.
      */
     public function populateTokenListeners()
     {
diff --git a/src/Runner.php b/src/Runner.php
@@ -233,6 +233,7 @@ public function runPHPCBF()
      * Exits if the minimum requirements of PHP_CodSniffer are not met.
      *
      * @return array
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     public function checkRequirements()
     {
@@ -254,6 +255,7 @@ public function checkRequirements()
      * Init the rulesets and other high-level settings.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     public function init()
     {
@@ -312,6 +314,8 @@ public function init()
      * Performs the run.
      *
      * @return int The number of errors and warnings found.
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException
      */
     private function run()
     {
@@ -558,6 +562,7 @@ private function run()
      * @param int    $line    The line number the error was raised at.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException
      */
     public function handleErrors($code, $message, $file, $line)
     {
@@ -577,6 +582,7 @@ public function handleErrors($code, $message, $file, $line)
      * @param \PHP_CodeSniffer\Files\File $file The file to be processed.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     public function processFile($file)
     {
@@ -726,14 +732,14 @@ private function processChildProcs($childProcs)
     /**
      * Print progress information for a single processed file.
      *
-     * @param File $file         The file that was processed.
-     * @param int  $numFiles     The total number of files to process.
-     * @param int  $numProcessed The number of files that have been processed,
-     *                           including this one.
+     * @param \PHP_CodeSniffer\Files\File $file         The file that was processed.
+     * @param int                         $numFiles     The total number of files to process.
+     * @param int                         $numProcessed The number of files that have been processed,
+     *                                                  including this one.
      *
      * @return void
      */
-    public function printProgress($file, $numFiles, $numProcessed)
+    public function printProgress(File $file, $numFiles, $numProcessed)
     {
         if (PHP_CODESNIFFER_VERBOSITY > 0
             || $this->config->showProgress === false
diff --git a/src/Sniffs/AbstractPatternSniff.php b/src/Sniffs/AbstractPatternSniff.php
@@ -153,7 +153,7 @@ private function getPatternTokenTypes($pattern)
      *
      * @return int The position in the pattern that this test should register
      *             as the listener.
-     * @throws RuntimeException If we could not determine a token to listen for.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If we could not determine a token to listen for.
      */
     private function getListenerTokenPos($pattern)
     {
diff --git a/src/Standards/MySource/Sniffs/Channels/IncludeSystemSniff.php b/src/Standards/MySource/Sniffs/Channels/IncludeSystemSniff.php
@@ -42,7 +42,7 @@ class IncludeSystemSniff extends AbstractScopeSniff
 
 
     /**
-     * Constructs a Squiz_Sniffs_Scope_MethodScopeSniff.
+     * Constructs an AbstractScopeSniff.
      */
     public function __construct()
     {
diff --git a/src/Tokenizers/CSS.php b/src/Tokenizers/CSS.php
@@ -27,7 +27,7 @@ class CSS extends PHP
      * @param string                  $eolChar The EOL char used in the content.
      *
      * @return void
-     * @throws TokenizerException If the file appears to be minified.
+     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified.
      */
     public function __construct($content, Config $config, $eolChar='\n')
     {
diff --git a/src/Tokenizers/JS.php b/src/Tokenizers/JS.php
@@ -257,7 +257,7 @@ class JS extends Tokenizer
      * @param string                  $eolChar The EOL char used in the content.
      *
      * @return void
-     * @throws TokenizerException If the file appears to be minified.
+     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified.
      */
     public function __construct($content, Config $config, $eolChar='\n')
     {
diff --git a/src/Tokenizers/Tokenizer.php b/src/Tokenizers/Tokenizer.php
@@ -59,7 +59,7 @@ abstract class Tokenizer
      * @param string                         $eolChar The EOL char used in the content.
      *
      * @return void
-     * @throws TokenizerException If the file appears to be minified.
+     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified.
      */
     public function __construct($content, $config, $eolChar='\n')
     {

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class Autoload`
`23`	`23`	`/**`
`24`	`24`	`* The composer autoloader.`
`25`	`25`	`*`
`26`		`- * @var Composer\Autoload\ClassLoader`
	`26`	`+ * @var \Composer\Autoload\ClassLoader`
`27`	`27`	`*/`
`28`	`28`	`private static $composerAutoloader = null;`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -188,7 +188,7 @@ class Config`
`188`	`188`	`* @param string $name The name of the property.`
`189`	`189`	`*`
`190`	`190`	`* @return mixed`
`191`		`- * @throws RuntimeException If the setting name is invalid.`
	`191`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid.`
`192`	`192`	`*/`
`193`	`193`	`public function __get($name)`
`194`	`194`	`{`
`@@ -208,7 +208,7 @@ public function __get($name)`
`208`	`208`	`* @param mixed $value The value of the property.`
`209`	`209`	`*`
`210`	`210`	`* @return void`
`211`		`- * @throws RuntimeException If the setting name is invalid.`
	`211`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the setting name is invalid.`
`212`	`212`	`*/`
`213`	`213`	`public function __set($name, $value)`
`214`	`214`	`{`
`@@ -1555,7 +1555,7 @@ public static function getExecutablePath($name)`
`1555`	`1555`	`*`
`1556`	`1556`	`* @return bool`
`1557`	`1557`	`* @see getConfigData()`
`1558`		`- * @throws RuntimeException If the config file can not be written.`
	`1558`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the config file can not be written.`
`1559`	`1559`	`*/`
`1560`	`1560`	`public static function setConfigData($key, $value, $temp=false)`
`1561`	`1561`	`{`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ class Reporter`
`92`	`92`	`* @param \PHP_CodeSniffer\Config $config The config data for the run.`
`93`	`93`	`*`
`94`	`94`	`* @return void`
`95`		`- * @throws RuntimeException If a report is not available.`
	`95`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If a report is not available.`
`96`	`96`	`*/`
`97`	`97`	`public function __construct(Config $config)`
`98`	`98`	`{`
Original file line number	Diff line number	Diff line change
`@@ -305,7 +305,7 @@ public function explain()`
`305`	`305`	`* is only used for debug output.`
`306`	`306`	`*`
`307`	`307`	`* @return string[]`
`308`		`- * @throws RuntimeException If the ruleset path is invalid.`
	`308`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the ruleset path is invalid.`
`309`	`309`	`*/`
`310`	`310`	`public function processRuleset($rulesetPath, $depth=0)`
`311`	`311`	`{`
`@@ -660,7 +660,7 @@ private function expandSniffDirectory($directory, $depth=0)`
`660`	`660`	`* is only used for debug output.`
`661`	`661`	`*`
`662`	`662`	`* @return array`
`663`		`- * @throws RuntimeException If the reference is invalid.`
	`663`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the reference is invalid.`
`664`	`664`	`*/`
`665`	`665`	`private function expandRulesetReference($ref, $rulesetDir, $depth=0)`
`666`	`666`	`{`
`@@ -836,13 +836,13 @@ private function expandRulesetReference($ref, $rulesetDir, $depth=0)`
`836`	`836`	`/**`
`837`	`837`	`* Processes a rule from a ruleset XML file, overriding built-in defaults.`
`838`	`838`	`*`
`839`		`- * @param SimpleXMLElement $rule The rule object from a ruleset XML file.`
`840`		`- * @param string[] $newSniffs An array of sniffs that got included by this rule.`
`841`		`- * @param int $depth How many nested processing steps we are in.`
`842`		`- * This is only used for debug output.`
	`839`	`+ * @param \SimpleXMLElement $rule The rule object from a ruleset XML file.`
	`840`	`+ * @param string[] $newSniffs An array of sniffs that got included by this rule.`
	`841`	`+ * @param int $depth How many nested processing steps we are in.`
	`842`	`+ * This is only used for debug output.`
`843`	`843`	`*`
`844`	`844`	`* @return void`
`845`		`- * @throws RuntimeException If rule settings are invalid.`
	`845`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If rule settings are invalid.`
`846`	`846`	`*/`
`847`	`847`	`private function processRule($rule, $newSniffs, $depth=0)`
`848`	`848`	`{`
`@@ -1073,7 +1073,7 @@ private function processRule($rule, $newSniffs, $depth=0)`
`1073`	`1073`	`/**`
`1074`	`1074`	`* Determine if an element should be processed or ignored.`
`1075`	`1075`	`*`
`1076`		`- * @param SimpleXMLElement $element An object from a ruleset XML file.`
	`1076`	`+ * @param \SimpleXMLElement $element An object from a ruleset XML file.`
`1077`	`1077`	`*`
`1078`	`1078`	`* @return bool`
`1079`	`1079`	`*/`
`@@ -1174,7 +1174,7 @@ public function registerSniffs($files, $restrictions, $exclusions)`
`1174`	`1174`	`* Populates the array of PHP_CodeSniffer_Sniff's for this file.`
`1175`	`1175`	`*`
`1176`	`1176`	`* @return void`
`1177`		`- * @throws RuntimeException If sniff registration fails.`
	`1177`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If sniff registration fails.`
`1178`	`1178`	`*/`
`1179`	`1179`	`public function populateTokenListeners()`
`1180`	`1180`	`{`
Original file line number	Diff line number	Diff line change
`@@ -233,6 +233,7 @@ public function runPHPCBF()`
`233`	`233`	`* Exits if the minimum requirements of PHP_CodSniffer are not met.`
`234`	`234`	`*`
`235`	`235`	`* @return array`
	`236`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`236`	`237`	`*/`
`237`	`238`	`public function checkRequirements()`
`238`	`239`	`{`
`@@ -254,6 +255,7 @@ public function checkRequirements()`
`254`	`255`	`* Init the rulesets and other high-level settings.`
`255`	`256`	`*`
`256`	`257`	`* @return void`
	`258`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`257`	`259`	`*/`
`258`	`260`	`public function init()`
`259`	`261`	`{`
`@@ -312,6 +314,8 @@ public function init()`
`312`	`314`	`* Performs the run.`
`313`	`315`	`*`
`314`	`316`	`* @return int The number of errors and warnings found.`
	`317`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
	`318`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException`
`315`	`319`	`*/`
`316`	`320`	`private function run()`
`317`	`321`	`{`
`@@ -558,6 +562,7 @@ private function run()`
`558`	`562`	`* @param int $line The line number the error was raised at.`
`559`	`563`	`*`
`560`	`564`	`* @return void`
	`565`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException`
`561`	`566`	`*/`
`562`	`567`	`public function handleErrors($code, $message, $file, $line)`
`563`	`568`	`{`
`@@ -577,6 +582,7 @@ public function handleErrors($code, $message, $file, $line)`
`577`	`582`	`* @param \PHP_CodeSniffer\Files\File $file The file to be processed.`
`578`	`583`	`*`
`579`	`584`	`* @return void`
	`585`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`580`	`586`	`*/`
`581`	`587`	`public function processFile($file)`
`582`	`588`	`{`
`@@ -726,14 +732,14 @@ private function processChildProcs($childProcs)`
`726`	`732`	`/**`
`727`	`733`	`* Print progress information for a single processed file.`
`728`	`734`	`*`
`729`		`- * @param File $file The file that was processed.`
`730`		`- * @param int $numFiles The total number of files to process.`
`731`		`- * @param int $numProcessed The number of files that have been processed,`
`732`		`- * including this one.`
	`735`	`+ * @param \PHP_CodeSniffer\Files\File $file The file that was processed.`
	`736`	`+ * @param int $numFiles The total number of files to process.`
	`737`	`+ * @param int $numProcessed The number of files that have been processed,`
	`738`	`+ * including this one.`
`733`	`739`	`*`
`734`	`740`	`* @return void`
`735`	`741`	`*/`
`736`		`- public function printProgress($file, $numFiles, $numProcessed)`
	`742`	`+ public function printProgress(File $file, $numFiles, $numProcessed)`
`737`	`743`	`{`
`738`	`744`	`if (PHP_CODESNIFFER_VERBOSITY > 0`
`739`	`745`	`\|\| $this->config->showProgress === false`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ private function getPatternTokenTypes($pattern)`
`153`	`153`	`*`
`154`	`154`	`* @return int The position in the pattern that this test should register`
`155`	`155`	`* as the listener.`
`156`		`- * @throws RuntimeException If we could not determine a token to listen for.`
	`156`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If we could not determine a token to listen for.`
`157`	`157`	`*/`
`158`	`158`	`private function getListenerTokenPos($pattern)`
`159`	`159`	`{`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ class IncludeSystemSniff extends AbstractScopeSniff`
`42`	`42`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * Constructs a Squiz_Sniffs_Scope_MethodScopeSniff.`
	`45`	`+ * Constructs an AbstractScopeSniff.`
`46`	`46`	`*/`
`47`	`47`	`public function __construct()`
`48`	`48`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ class CSS extends PHP`
`27`	`27`	`* @param string $eolChar The EOL char used in the content.`
`28`	`28`	`*`
`29`	`29`	`* @return void`
`30`		`- * @throws TokenizerException If the file appears to be minified.`
	`30`	`+ * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified.`
`31`	`31`	`*/`
`32`	`32`	`public function __construct($content, Config $config, $eolChar='\n')`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,7 @@ class JS extends Tokenizer`
`257`	`257`	`* @param string $eolChar The EOL char used in the content.`
`258`	`258`	`*`
`259`	`259`	`* @return void`
`260`		`- * @throws TokenizerException If the file appears to be minified.`
	`260`	`+ * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified.`
`261`	`261`	`*/`
`262`	`262`	`public function __construct($content, Config $config, $eolChar='\n')`
`263`	`263`	`{`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ abstract class Tokenizer`
`59`	`59`	`* @param string $eolChar The EOL char used in the content.`
`60`	`60`	`*`
`61`	`61`	`* @return void`
`62`		`- * @throws TokenizerException If the file appears to be minified.`
	`62`	`+ * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified.`
`63`	`63`	`*/`
`64`	`64`	`public function __construct($content, $config, $eolChar='\n')`
`65`	`65`	`{`