Merge pull request #152 from PHPCSStandards/docs/split-some-throws-tags

jrfnl · web-flow · commit 4d72ca78a3b9 · 2020-06-13T23:06:43.000+02:00
Docs: one `@throws` per exception thrown
diff --git a/PHPCSUtils/Utils/ControlStructures.php b/PHPCSUtils/Utils/ControlStructures.php
@@ -363,9 +363,10 @@ public static function getDeclareScopeOpenClose(File $phpcsFile, $stackPtr)
      *
      * @return array
      *
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified $stackPtr is not of
-     *                                                      type T_CATCH, doesn't exist or in case
-     *                                                      of a parse error.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified `$stackPtr` is not of
+     *                                                      type `T_CATCH` or doesn't exist.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If no parenthesis opener or closer can be
+     *                                                      determined (parse error).
      */
     public static function getCaughtExceptions(File $phpcsFile, $stackPtr)
     {
diff --git a/PHPCSUtils/Utils/TextStrings.php b/PHPCSUtils/Utils/TextStrings.php
@@ -46,8 +46,9 @@ class TextStrings
      * @return string The complete text string.
      *
      * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
-     *                                                      valid text string token or if the
-     *                                                      token is not the first text string token.
+     *                                                      valid text string token.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified token is not the _first_
+     *                                                      token in a text string.
      */
     public static function getCompleteTextString(File $phpcsFile, $stackPtr, $stripQuotes = true)
     {
diff --git a/PHPCSUtils/Utils/UseStatements.php b/PHPCSUtils/Utils/UseStatements.php
@@ -169,7 +169,9 @@ public static function isTraitUse(File $phpcsFile, $stackPtr)
      *               ]`
      *
      * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
-     *                                                      T_USE token or not an import use statement.
+     *                                                      `T_USE` token.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the `T_USE` token is not for an import
+     *                                                      use statement.
      */
     public static function splitImportUseStatement(File $phpcsFile, $stackPtr)
     {
diff --git a/PHPCSUtils/Utils/Variables.php b/PHPCSUtils/Utils/Variables.php
@@ -109,8 +109,9 @@ class Variables
      * @return array
      *
      * @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.
+     *                                                      T_VARIABLE token.
+     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
+     *                                                      class member variable.
      */
     public static function getMemberProperties(File $phpcsFile, $stackPtr)
     {

Original file line number	Diff line number	Diff line change
`@@ -363,9 +363,10 @@ public static function getDeclareScopeOpenClose(File $phpcsFile, $stackPtr)`
`363`	`363`	`*`
`364`	`364`	`* @return array`
`365`	`365`	`*`
`366`		`- * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified $stackPtr is not of`
`367`		`- * type T_CATCH, doesn't exist or in case`
`368`		`- * of a parse error.`
	`366`	+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified `$stackPtr` is not of
	`367`	+ * type `T_CATCH` or doesn't exist.
	`368`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If no parenthesis opener or closer can be`
	`369`	`+ * determined (parse error).`
`369`	`370`	`*/`
`370`	`371`	`public static function getCaughtExceptions(File $phpcsFile, $stackPtr)`
`371`	`372`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,9 @@ class TextStrings`
`46`	`46`	`* @return string The complete text string.`
`47`	`47`	`*`
`48`	`48`	`* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a`
`49`		`- * valid text string token or if the`
`50`		`- * token is not the first text string token.`
	`49`	`+ * valid text string token.`
	`50`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified token is not the _first_`
	`51`	`+ * token in a text string.`
`51`	`52`	`*/`
`52`	`53`	`public static function getCompleteTextString(File $phpcsFile, $stackPtr, $stripQuotes = true)`
`53`	`54`	`{`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,9 @@ public static function isTraitUse(File $phpcsFile, $stackPtr)`
`169`	`169`	* ]`
`170`	`170`	`*`
`171`	`171`	`* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a`
`172`		`- * T_USE token or not an import use statement.`
	`172`	+ * `T_USE` token.
	`173`	+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the `T_USE` token is not for an import
	`174`	`+ * use statement.`
`173`	`175`	`*/`
`174`	`176`	`public static function splitImportUseStatement(File $phpcsFile, $stackPtr)`
`175`	`177`	`{`
Original file line number	Diff line number	Diff line change
`@@ -109,8 +109,9 @@ class Variables`
`109`	`109`	`* @return array`
`110`	`110`	`*`
`111`	`111`	`* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a`
`112`		`- * T_VARIABLE token, or if the position is not`
`113`		`- * a class member variable.`
	`112`	`+ * T_VARIABLE token.`
	`113`	`+ * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a`
	`114`	`+ * class member variable.`
`114`	`115`	`*/`
`115`	`116`	`public static function getMemberProperties(File $phpcsFile, $stackPtr)`
`116`	`117`	`{`