Use Exceptions consistently

jrfnl · jrfnl · commit 35b8bd78040c · 2019-01-07T07:51:04.000+01:00
As far as I can see, Exceptions thrown by sniffs/utility methods when, for instance, a wrong token is passed, should be `RuntimeException`s, while Exceptions thrown by the `Tokenizer` classes should be `TokenizerException`s.

In a number of places this was applied inconsistently. This has now been fixed.

Aside from that, for quite a number of methods, the `Exception` being thrown has now been documented.
diff --git a/src/Config.php b/src/Config.php
@@ -584,6 +584,7 @@ public function restoreDefaults()
      * @param int    $pos The position of the argument on the command line.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     public function processShortArgument($arg, $pos)
     {
@@ -688,6 +689,7 @@ public function processShortArgument($arg, $pos)
      * @param int    $pos The position of the argument on the command line.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     public function processLongArgument($arg, $pos)
     {
@@ -1249,6 +1251,7 @@ public function processLongArgument($arg, $pos)
      * @param int    $pos The position of the argument on the command line.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     public function processUnknownArgument($arg, $pos)
     {
@@ -1274,6 +1277,7 @@ public function processUnknownArgument($arg, $pos)
      * @param string $path The path to the file to add.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     public function processFilePath($path)
     {
@@ -1555,7 +1559,7 @@ public static function getExecutablePath($name)
      *
      * @return bool
      * @see    getConfigData()
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the config file can not be written.
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If the config file can not be written.
      */
     public static function setConfigData($key, $value, $temp=false)
     {
@@ -1636,6 +1640,7 @@ public static function setConfigData($key, $value, $temp=false)
      *
      * @return array<string, string>
      * @see    getConfigData()
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If the config file could not be read.
      */
     public static function getAllConfigData()
     {
diff --git a/src/Files/File.php b/src/Files/File.php
@@ -1291,15 +1291,15 @@ public function getDeclarationName($stackPtr)
      *                      to acquire the parameters for.
      *
      * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified $stackPtr is not of
-     *                                                        type T_FUNCTION or T_CLOSURE.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified $stackPtr is not of
+     *                                                      type T_FUNCTION or T_CLOSURE.
      */
     public function getMethodParameters($stackPtr)
     {
         if ($this->tokens[$stackPtr]['code'] !== T_FUNCTION
             && $this->tokens[$stackPtr]['code'] !== T_CLOSURE
         ) {
-            throw new TokenizerException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
+            throw new RuntimeException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
         }
 
         $opener = $this->tokens[$stackPtr]['parenthesis_opener'];
@@ -1483,15 +1483,15 @@ public function getMethodParameters($stackPtr)
      *                      acquire the properties for.
      *
      * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
-     *                                                        T_FUNCTION token.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
+     *                                                      T_FUNCTION token.
      */
     public function getMethodProperties($stackPtr)
     {
         if ($this->tokens[$stackPtr]['code'] !== T_FUNCTION
             && $this->tokens[$stackPtr]['code'] !== T_CLOSURE
         ) {
-            throw new TokenizerException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
+            throw new RuntimeException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
         }
 
         if ($this->tokens[$stackPtr]['code'] === T_FUNCTION) {
@@ -1632,14 +1632,14 @@ public function getMethodProperties($stackPtr)
      *                      acquire the properties for.
      *
      * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
-     *                                                        T_VARIABLE token, or if the position is not
-     *                                                        a class member variable.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
+     *                                                      T_VARIABLE token, or if the position is not
+     *                                                      a class member variable.
      */
     public function getMemberProperties($stackPtr)
     {
         if ($this->tokens[$stackPtr]['code'] !== T_VARIABLE) {
-            throw new TokenizerException('$stackPtr must be of type T_VARIABLE');
+            throw new RuntimeException('$stackPtr must be of type T_VARIABLE');
         }
 
         $conditions = array_keys($this->tokens[$stackPtr]['conditions']);
@@ -1664,7 +1664,7 @@ public function getMemberProperties($stackPtr)
                     return [];
                 }
             } else {
-                throw new TokenizerException('$stackPtr is not a class member var');
+                throw new RuntimeException('$stackPtr is not a class member var');
             }
         }
 
@@ -1676,7 +1676,7 @@ public function getMemberProperties($stackPtr)
                 && isset($this->tokens[$deepestOpen]['parenthesis_owner']) === true
                 && $this->tokens[$this->tokens[$deepestOpen]['parenthesis_owner']]['code'] === T_FUNCTION
             ) {
-                throw new TokenizerException('$stackPtr is not a class member var');
+                throw new RuntimeException('$stackPtr is not a class member var');
             }
         }
 
@@ -1751,13 +1751,13 @@ public function getMemberProperties($stackPtr)
      *                      acquire the properties for.
      *
      * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a
-     *                                                        T_CLASS token.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
+     *                                                      T_CLASS token.
      */
     public function getClassProperties($stackPtr)
     {
         if ($this->tokens[$stackPtr]['code'] !== T_CLASS) {
-            throw new TokenizerException('$stackPtr must be of type T_CLASS');
+            throw new RuntimeException('$stackPtr must be of type T_CLASS');
         }
 
         $valid = [
@@ -1938,6 +1938,7 @@ public function isReference($stackPtr)
      *                          content should be used.
      *
      * @return string The token contents.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position does not exist.
      */
     public function getTokensAsString($start, $length, $origContent=false)
     {
diff --git a/src/Files/FileList.php b/src/Files/FileList.php
@@ -136,6 +136,7 @@ public function addFile($path, $file=null)
      * Get the class name of the filter being used for the run.
      *
      * @return string
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If the specified filter could not be found.
      */
     private function getFilterClass()
     {
diff --git a/src/Reporter.php b/src/Reporter.php
@@ -92,7 +92,8 @@ class Reporter
      * @param \PHP_CodeSniffer\Config $config The config data for the run.
      *
      * @return void
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If a report is not available.
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If a custom report class could not be found.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException  If a report class is incorrectly set up.
      */
     public function __construct(Config $config)
     {
diff --git a/src/Reports/Cbf.php b/src/Reports/Cbf.php
@@ -34,6 +34,7 @@ class Cbf implements Report
      * @param int                   $width       Maximum allowed line width.
      *
      * @return bool
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
     {
diff --git a/src/Reports/Gitblame.php b/src/Reports/Gitblame.php
@@ -63,6 +63,7 @@ protected function getAuthor($line)
      * @param string $filename File to blame.
      *
      * @return array
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     protected function getBlameContent($filename)
     {
diff --git a/src/Reports/Hgblame.php b/src/Reports/Hgblame.php
@@ -64,6 +64,7 @@ protected function getAuthor($line)
      * @param string $filename File to blame.
      *
      * @return array
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     protected function getBlameContent($filename)
     {
diff --git a/src/Reports/Svnblame.php b/src/Reports/Svnblame.php
@@ -49,6 +49,7 @@ protected function getAuthor($line)
      * @param string $filename File to blame.
      *
      * @return array
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
      */
     protected function getBlameContent($filename)
     {
diff --git a/src/Ruleset.php b/src/Ruleset.php
@@ -122,6 +122,7 @@ class Ruleset
      * @param \PHP_CodeSniffer\Config $config The config data for the run.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If no sniffs were registered.
      */
     public function __construct(Config $config)
     {
@@ -305,7 +306,8 @@ public function explain()
      *                            is only used for debug output.
      *
      * @return string[]
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the ruleset path is invalid.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException - If the ruleset path is invalid.
+     *                                                      - If a specified autoload file could not be found.
      */
     public function processRuleset($rulesetPath, $depth=0)
     {
diff --git a/src/Runner.php b/src/Runner.php
@@ -233,7 +233,7 @@ public function runPHPCBF()
      * Exits if the minimum requirements of PHP_CodSniffer are not met.
      *
      * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If the requirements are not met.
      */
     public function checkRequirements()
     {
@@ -255,7 +255,7 @@ public function checkRequirements()
      * Init the rulesets and other high-level settings.
      *
      * @return void
-     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
+     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If a referenced standard is not installed.
      */
     public function init()
     {
diff --git a/src/Sniffs/AbstractScopeSniff.php b/src/Sniffs/AbstractScopeSniff.php
@@ -66,7 +66,8 @@ abstract class AbstractScopeSniff implements Sniff
      *                               processTokenOutsideScope method.
      *
      * @see    PHP_CodeSniffer.getValidScopeTokeners()
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified tokens array is empty.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified tokens arrays are empty
+     *                                                      or invalid.
      */
     public function __construct(
         array $scopeTokens,
diff --git a/src/Standards/Squiz/Sniffs/Debug/JavaScriptLintSniff.php b/src/Standards/Squiz/Sniffs/Debug/JavaScriptLintSniff.php
@@ -45,6 +45,7 @@ public function register()
      *                                               the token was found.
      *
      * @return void
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If Javascript Lint ran into trouble.
      */
     public function process(File $phpcsFile, $stackPtr)
     {
diff --git a/src/Standards/Zend/Sniffs/Debug/CodeAnalyzerSniff.php b/src/Standards/Zend/Sniffs/Debug/CodeAnalyzerSniff.php
@@ -39,6 +39,7 @@ public function register()
      *                                               the token was found.
      *
      * @return int
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If ZendCodeAnalyzer could not be run.
      */
     public function process(File $phpcsFile, $stackPtr)
     {
diff --git a/src/Tokenizers/Tokenizer.php b/src/Tokenizers/Tokenizer.php
@@ -9,7 +9,7 @@
 
 namespace PHP_CodeSniffer\Tokenizers;
 
-use PHP_CodeSniffer\Exceptions\RuntimeException;
+use PHP_CodeSniffer\Exceptions\TokenizerException;
 use PHP_CodeSniffer\Util;
 
 abstract class Tokenizer
@@ -858,6 +858,7 @@ private function createScopeMap()
      * @param int $ignore   How many curly braces we are ignoring.
      *
      * @return int The position in the stack that closed the scope.
+     * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the nesting level gets too deep.
      */
     private function recurseScopeMap($stackPtr, $depth=1, &$ignore=0)
     {
@@ -1194,7 +1195,7 @@ private function recurseScopeMap($stackPtr, $depth=1, &$ignore=0)
                             echo '* reached maximum nesting level; aborting *'.PHP_EOL;
                         }
 
-                        throw new RuntimeException('Maximum nesting level reached; file could not be processed');
+                        throw new TokenizerException('Maximum nesting level reached; file could not be processed');
                     }
 
                     $oldDepth = $depth;
diff --git a/tests/Core/File/GetMemberPropertiesTest.php b/tests/Core/File/GetMemberPropertiesTest.php
@@ -327,7 +327,7 @@ public function dataGetMemberProperties()
      *
      * @param string $identifier Comment which preceeds the test case.
      *
-     * @expectedException        PHP_CodeSniffer\Exceptions\TokenizerException
+     * @expectedException        PHP_CodeSniffer\Exceptions\RuntimeException
      * @expectedExceptionMessage $stackPtr is not a class member var
      *
      * @dataProvider dataNotClassProperty
@@ -375,7 +375,7 @@ public function dataNotClassProperty()
     /**
      * Test receiving an expected exception when a non variable is passed.
      *
-     * @expectedException        PHP_CodeSniffer\Exceptions\TokenizerException
+     * @expectedException        PHP_CodeSniffer\Exceptions\RuntimeException
      * @expectedExceptionMessage $stackPtr must be of type T_VARIABLE
      *
      * @return void

Original file line number	Diff line number	Diff line change
`@@ -584,6 +584,7 @@ public function restoreDefaults()`
`584`	`584`	`* @param int $pos The position of the argument on the command line.`
`585`	`585`	`*`
`586`	`586`	`* @return void`
	`587`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`587`	`588`	`*/`
`588`	`589`	`public function processShortArgument($arg, $pos)`
`589`	`590`	`{`
`@@ -688,6 +689,7 @@ public function processShortArgument($arg, $pos)`
`688`	`689`	`* @param int $pos The position of the argument on the command line.`
`689`	`690`	`*`
`690`	`691`	`* @return void`
	`692`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`691`	`693`	`*/`
`692`	`694`	`public function processLongArgument($arg, $pos)`
`693`	`695`	`{`
`@@ -1249,6 +1251,7 @@ public function processLongArgument($arg, $pos)`
`1249`	`1251`	`* @param int $pos The position of the argument on the command line.`
`1250`	`1252`	`*`
`1251`	`1253`	`* @return void`
	`1254`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`1252`	`1255`	`*/`
`1253`	`1256`	`public function processUnknownArgument($arg, $pos)`
`1254`	`1257`	`{`
`@@ -1274,6 +1277,7 @@ public function processUnknownArgument($arg, $pos)`
`1274`	`1277`	`* @param string $path The path to the file to add.`
`1275`	`1278`	`*`
`1276`	`1279`	`* @return void`
	`1280`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`1277`	`1281`	`*/`
`1278`	`1282`	`public function processFilePath($path)`
`1279`	`1283`	`{`
`@@ -1555,7 +1559,7 @@ public static function getExecutablePath($name)`
`1555`	`1559`	`*`
`1556`	`1560`	`* @return bool`
`1557`	`1561`	`* @see getConfigData()`
`1558`		`- * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the config file can not be written.`
	`1562`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If the config file can not be written.`
`1559`	`1563`	`*/`
`1560`	`1564`	`public static function setConfigData($key, $value, $temp=false)`
`1561`	`1565`	`{`
`@@ -1636,6 +1640,7 @@ public static function setConfigData($key, $value, $temp=false)`
`1636`	`1640`	`*`
`1637`	`1641`	`* @return array<string, string>`
`1638`	`1642`	`* @see getConfigData()`
	`1643`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If the config file could not be read.`
`1639`	`1644`	`*/`
`1640`	`1645`	`public static function getAllConfigData()`
`1641`	`1646`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1291,15 +1291,15 @@ public function getDeclarationName($stackPtr)`
`1291`	`1291`	`* to acquire the parameters for.`
`1292`	`1292`	`*`
`1293`	`1293`	`* @return array`
`1294`		`- * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified $stackPtr is not of`
`1295`		`- * type T_FUNCTION or T_CLOSURE.`
	`1294`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified $stackPtr is not of`
	`1295`	`+ * type T_FUNCTION or T_CLOSURE.`
`1296`	`1296`	`*/`
`1297`	`1297`	`public function getMethodParameters($stackPtr)`
`1298`	`1298`	`{`
`1299`	`1299`	`if ($this->tokens[$stackPtr]['code'] !== T_FUNCTION`
`1300`	`1300`	`&& $this->tokens[$stackPtr]['code'] !== T_CLOSURE`
`1301`	`1301`	`) {`
`1302`		`- throw new TokenizerException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');`
	`1302`	`+ throw new RuntimeException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');`
`1303`	`1303`	`}`
`1304`	`1304`
`1305`	`1305`	`$opener = $this->tokens[$stackPtr]['parenthesis_opener'];`
`@@ -1483,15 +1483,15 @@ public function getMethodParameters($stackPtr)`
`1483`	`1483`	`* acquire the properties for.`
`1484`	`1484`	`*`
`1485`	`1485`	`* @return array`
`1486`		`- * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a`
`1487`		`- * T_FUNCTION token.`
	`1486`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a`
	`1487`	`+ * T_FUNCTION token.`
`1488`	`1488`	`*/`
`1489`	`1489`	`public function getMethodProperties($stackPtr)`
`1490`	`1490`	`{`
`1491`	`1491`	`if ($this->tokens[$stackPtr]['code'] !== T_FUNCTION`
`1492`	`1492`	`&& $this->tokens[$stackPtr]['code'] !== T_CLOSURE`
`1493`	`1493`	`) {`
`1494`		`- throw new TokenizerException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');`
	`1494`	`+ throw new RuntimeException('$stackPtr must be of type T_FUNCTION or T_CLOSURE');`
`1495`	`1495`	`}`
`1496`	`1496`
`1497`	`1497`	`if ($this->tokens[$stackPtr]['code'] === T_FUNCTION) {`
`@@ -1632,14 +1632,14 @@ public function getMethodProperties($stackPtr)`
`1632`	`1632`	`* acquire the properties for.`
`1633`	`1633`	`*`
`1634`	`1634`	`* @return array`
`1635`		`- * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a`
`1636`		`- * T_VARIABLE token, or if the position is not`
`1637`		`- * a class member variable.`
	`1635`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a`
	`1636`	`+ * T_VARIABLE token, or if the position is not`
	`1637`	`+ * a class member variable.`
`1638`	`1638`	`*/`
`1639`	`1639`	`public function getMemberProperties($stackPtr)`
`1640`	`1640`	`{`
`1641`	`1641`	`if ($this->tokens[$stackPtr]['code'] !== T_VARIABLE) {`
`1642`		`- throw new TokenizerException('$stackPtr must be of type T_VARIABLE');`
	`1642`	`+ throw new RuntimeException('$stackPtr must be of type T_VARIABLE');`
`1643`	`1643`	`}`
`1644`	`1644`
`1645`	`1645`	`$conditions = array_keys($this->tokens[$stackPtr]['conditions']);`
`@@ -1664,7 +1664,7 @@ public function getMemberProperties($stackPtr)`
`1664`	`1664`	`return [];`
`1665`	`1665`	`}`
`1666`	`1666`	`} else {`
`1667`		`- throw new TokenizerException('$stackPtr is not a class member var');`
	`1667`	`+ throw new RuntimeException('$stackPtr is not a class member var');`
`1668`	`1668`	`}`
`1669`	`1669`	`}`
`1670`	`1670`
`@@ -1676,7 +1676,7 @@ public function getMemberProperties($stackPtr)`
`1676`	`1676`	`&& isset($this->tokens[$deepestOpen]['parenthesis_owner']) === true`
`1677`	`1677`	`&& $this->tokens[$this->tokens[$deepestOpen]['parenthesis_owner']]['code'] === T_FUNCTION`
`1678`	`1678`	`) {`
`1679`		`- throw new TokenizerException('$stackPtr is not a class member var');`
	`1679`	`+ throw new RuntimeException('$stackPtr is not a class member var');`
`1680`	`1680`	`}`
`1681`	`1681`	`}`
`1682`	`1682`
`@@ -1751,13 +1751,13 @@ public function getMemberProperties($stackPtr)`
`1751`	`1751`	`* acquire the properties for.`
`1752`	`1752`	`*`
`1753`	`1753`	`* @return array`
`1754`		`- * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the specified position is not a`
`1755`		`- * T_CLASS token.`
	`1754`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a`
	`1755`	`+ * T_CLASS token.`
`1756`	`1756`	`*/`
`1757`	`1757`	`public function getClassProperties($stackPtr)`
`1758`	`1758`	`{`
`1759`	`1759`	`if ($this->tokens[$stackPtr]['code'] !== T_CLASS) {`
`1760`		`- throw new TokenizerException('$stackPtr must be of type T_CLASS');`
	`1760`	`+ throw new RuntimeException('$stackPtr must be of type T_CLASS');`
`1761`	`1761`	`}`
`1762`	`1762`
`1763`	`1763`	`$valid = [`
`@@ -1938,6 +1938,7 @@ public function isReference($stackPtr)`
`1938`	`1938`	`* content should be used.`
`1939`	`1939`	`*`
`1940`	`1940`	`* @return string The token contents.`
	`1941`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position does not exist.`
`1941`	`1942`	`*/`
`1942`	`1943`	`public function getTokensAsString($start, $length, $origContent=false)`
`1943`	`1944`	`{`
Original file line number	Diff line number	Diff line change
`@@ -136,6 +136,7 @@ public function addFile($path, $file=null)`
`136`	`136`	`* Get the class name of the filter being used for the run.`
`137`	`137`	`*`
`138`	`138`	`* @return string`
	`139`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If the specified filter could not be found.`
`139`	`140`	`*/`
`140`	`141`	`private function getFilterClass()`
`141`	`142`	`{`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,8 @@ class Reporter`
`92`	`92`	`* @param \PHP_CodeSniffer\Config $config The config data for the run.`
`93`	`93`	`*`
`94`	`94`	`* @return void`
`95`		`- * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If a report is not available.`
	`95`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If a custom report class could not be found.`
	`96`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If a report class is incorrectly set up.`
`96`	`97`	`*/`
`97`	`98`	`public function __construct(Config $config)`
`98`	`99`	`{`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ class Cbf implements Report`
`34`	`34`	`* @param int $width Maximum allowed line width.`
`35`	`35`	`*`
`36`	`36`	`* @return bool`
	`37`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`37`	`38`	`*/`
`38`	`39`	`public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)`
`39`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ protected function getAuthor($line)`
`63`	`63`	`* @param string $filename File to blame.`
`64`	`64`	`*`
`65`	`65`	`* @return array`
	`66`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`66`	`67`	`*/`
`67`	`68`	`protected function getBlameContent($filename)`
`68`	`69`	`{`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,7 @@ protected function getAuthor($line)`
`64`	`64`	`* @param string $filename File to blame.`
`65`	`65`	`*`
`66`	`66`	`* @return array`
	`67`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`67`	`68`	`*/`
`68`	`69`	`protected function getBlameContent($filename)`
`69`	`70`	`{`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ protected function getAuthor($line)`
`49`	`49`	`* @param string $filename File to blame.`
`50`	`50`	`*`
`51`	`51`	`* @return array`
	`52`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
`52`	`53`	`*/`
`53`	`54`	`protected function getBlameContent($filename)`
`54`	`55`	`{`
Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,7 @@ class Ruleset`
`122`	`122`	`* @param \PHP_CodeSniffer\Config $config The config data for the run.`
`123`	`123`	`*`
`124`	`124`	`* @return void`
	`125`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If no sniffs were registered.`
`125`	`126`	`*/`
`126`	`127`	`public function __construct(Config $config)`
`127`	`128`	`{`
`@@ -305,7 +306,8 @@ public function explain()`
`305`	`306`	`* is only used for debug output.`
`306`	`307`	`*`
`307`	`308`	`* @return string[]`
`308`		`- * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the ruleset path is invalid.`
	`309`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException - If the ruleset path is invalid.`
	`310`	`+ * - If a specified autoload file could not be found.`
`309`	`311`	`*/`
`310`	`312`	`public function processRuleset($rulesetPath, $depth=0)`
`311`	`313`	`{`
Original file line number	Diff line number	Diff line change
`@@ -233,7 +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`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If the requirements are not met.`
`237`	`237`	`*/`
`238`	`238`	`public function checkRequirements()`
`239`	`239`	`{`
`@@ -255,7 +255,7 @@ public function checkRequirements()`
`255`	`255`	`* Init the rulesets and other high-level settings.`
`256`	`256`	`*`
`257`	`257`	`* @return void`
`258`		`- * @throws \PHP_CodeSniffer\Exceptions\DeepExitException`
	`258`	`+ * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If a referenced standard is not installed.`
`259`	`259`	`*/`
`260`	`260`	`public function init()`
`261`	`261`	`{`