Docs: fix incomplete param types

jrfnl · jrfnl · commit 33c9a8954d9a · 2020-06-13T18:52:42.000+02:00
diff --git a/PHPCSUtils/BackCompat/Helper.php b/PHPCSUtils/BackCompat/Helper.php
@@ -172,7 +172,7 @@ public static function getTabWidth(File $phpcsFile)
      *
      * @since 1.0.0
      *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile Optional. The current file being processed.
+     * @param \PHP_CodeSniffer\Files\File|null $phpcsFile Optional. The current file being processed.
      *
      * @return string Encoding. Defaults to the PHPCS native default, which is 'utf-8'
      *                for PHPCS 3.x and was 'iso-8859-1' for PHPCS 2.x.
@@ -213,8 +213,7 @@ public static function getEncoding(File $phpcsFile = null)
      *
      * @since 1.0.0
      *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile Optional. The current file
-     *                                               being processed.
+     * @param \PHP_CodeSniffer\Files\File|null $phpcsFile Optional. The current file being processed.
      *
      * @return bool True if annotations should be ignored, false otherwise.
      */

Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ public static function getTabWidth(File $phpcsFile)`
`172`	`172`	`*`
`173`	`173`	`* @since 1.0.0`
`174`	`174`	`*`
`175`		`- * @param \PHP_CodeSniffer\Files\File $phpcsFile Optional. The current file being processed.`
	`175`	`+ * @param \PHP_CodeSniffer\Files\File\|null $phpcsFile Optional. The current file being processed.`
`176`	`176`	`*`
`177`	`177`	`* @return string Encoding. Defaults to the PHPCS native default, which is 'utf-8'`
`178`	`178`	`* for PHPCS 3.x and was 'iso-8859-1' for PHPCS 2.x.`
`@@ -213,8 +213,7 @@ public static function getEncoding(File $phpcsFile = null)`
`213`	`213`	`*`
`214`	`214`	`* @since 1.0.0`
`215`	`215`	`*`
`216`		`- * @param \PHP_CodeSniffer\Files\File $phpcsFile Optional. The current file`
`217`		`- * being processed.`
	`216`	`+ * @param \PHP_CodeSniffer\Files\File\|null $phpcsFile Optional. The current file being processed.`
`218`	`217`	`*`
`219`	`218`	`* @return bool True if annotations should be ignored, false otherwise.`
`220`	`219`	`*/`