Docs: improve consistency and specificity [1]

jrfnl · jrfnl · commit 12154a65de39 · 2024-11-08T11:15:07.000+01:00
This fixes up the `@return` type declarations for all `register()` methods.
diff --git a/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php b/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php
@@ -58,7 +58,7 @@ abstract class AbstractVariableRestrictionsSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		// Retrieve the groups only once and don't set up a listener if there are no groups.
diff --git a/WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php b/WordPressVIPMinimum/Sniffs/Constants/ConstantStringSniff.php
@@ -20,7 +20,7 @@ class ConstantStringSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/Constants/RestrictedConstantsSniff.php b/WordPressVIPMinimum/Sniffs/Constants/RestrictedConstantsSniff.php
@@ -38,7 +38,7 @@ class RestrictedConstantsSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php b/WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php
@@ -107,7 +107,7 @@ public function getGroups() {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return Tokens::$includeTokens;
diff --git a/WordPressVIPMinimum/Sniffs/Files/IncludingNonPHPFileSniff.php b/WordPressVIPMinimum/Sniffs/Files/IncludingNonPHPFileSniff.php
@@ -44,7 +44,7 @@ class IncludingNonPHPFileSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return Tokens::$includeTokens;
diff --git a/WordPressVIPMinimum/Sniffs/Functions/CheckReturnValueSniff.php b/WordPressVIPMinimum/Sniffs/Functions/CheckReturnValueSniff.php
@@ -57,7 +57,7 @@ class CheckReturnValueSniff extends Sniff {
 	/**
 	 * Returns the token types that this sniff is interested in.
 	 *
-	 * @return array(int)
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_STRING ];
diff --git a/WordPressVIPMinimum/Sniffs/Functions/DynamicCallsSniff.php b/WordPressVIPMinimum/Sniffs/Functions/DynamicCallsSniff.php
@@ -62,7 +62,7 @@ class DynamicCallsSniff extends Sniff {
 	/**
 	 * Returns the token types that this sniff is interested in.
 	 *
-	 * @return array(int)
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_VARIABLE => T_VARIABLE ];
diff --git a/WordPressVIPMinimum/Sniffs/Hooks/AlwaysReturnInFilterSniff.php b/WordPressVIPMinimum/Sniffs/Hooks/AlwaysReturnInFilterSniff.php
@@ -27,7 +27,7 @@ class AlwaysReturnInFilterSniff extends Sniff {
 	/**
 	 * Returns the token types that this sniff is interested in.
 	 *
-	 * @return array(int)
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_STRING ];
diff --git a/WordPressVIPMinimum/Sniffs/Hooks/PreGetPostsSniff.php b/WordPressVIPMinimum/Sniffs/Hooks/PreGetPostsSniff.php
@@ -21,7 +21,7 @@ class PreGetPostsSniff extends Sniff {
 	/**
 	 * Returns the token types that this sniff is interested in.
 	 *
-	 * @return array(int)
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_STRING ];
diff --git a/WordPressVIPMinimum/Sniffs/JS/DangerouslySetInnerHTMLSniff.php b/WordPressVIPMinimum/Sniffs/JS/DangerouslySetInnerHTMLSniff.php
@@ -27,7 +27,7 @@ class DangerouslySetInnerHTMLSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/JS/HTMLExecutingFunctionsSniff.php b/WordPressVIPMinimum/Sniffs/JS/HTMLExecutingFunctionsSniff.php
@@ -52,7 +52,7 @@ class HTMLExecutingFunctionsSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/JS/InnerHTMLSniff.php b/WordPressVIPMinimum/Sniffs/JS/InnerHTMLSniff.php
@@ -27,7 +27,7 @@ class InnerHTMLSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/JS/StringConcatSniff.php b/WordPressVIPMinimum/Sniffs/JS/StringConcatSniff.php
@@ -27,7 +27,7 @@ class StringConcatSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/JS/StrippingTagsSniff.php b/WordPressVIPMinimum/Sniffs/JS/StrippingTagsSniff.php
@@ -27,7 +27,7 @@ class StrippingTagsSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/JS/WindowSniff.php b/WordPressVIPMinimum/Sniffs/JS/WindowSniff.php
@@ -27,7 +27,7 @@ class WindowSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/Performance/CacheValueOverrideSniff.php b/WordPressVIPMinimum/Sniffs/Performance/CacheValueOverrideSniff.php
@@ -18,7 +18,7 @@ class CacheValueOverrideSniff extends Sniff {
 	/**
 	 * Returns the token types that this sniff is interested in.
 	 *
-	 * @return array(int)
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_STRING ];
diff --git a/WordPressVIPMinimum/Sniffs/Performance/FetchingRemoteDataSniff.php b/WordPressVIPMinimum/Sniffs/Performance/FetchingRemoteDataSniff.php
@@ -19,7 +19,7 @@ class FetchingRemoteDataSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_STRING ];
diff --git a/WordPressVIPMinimum/Sniffs/Performance/TaxonomyMetaInOptionsSniff.php b/WordPressVIPMinimum/Sniffs/Performance/TaxonomyMetaInOptionsSniff.php
@@ -46,7 +46,7 @@ class TaxonomyMetaInOptionsSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_STRING ];
diff --git a/WordPressVIPMinimum/Sniffs/Security/EscapingVoidReturnFunctionsSniff.php b/WordPressVIPMinimum/Sniffs/Security/EscapingVoidReturnFunctionsSniff.php
@@ -26,7 +26,7 @@ class EscapingVoidReturnFunctionsSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/Security/ExitAfterRedirectSniff.php b/WordPressVIPMinimum/Sniffs/Security/ExitAfterRedirectSniff.php
@@ -19,7 +19,7 @@ class ExitAfterRedirectSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_STRING ];
diff --git a/WordPressVIPMinimum/Sniffs/Security/MustacheSniff.php b/WordPressVIPMinimum/Sniffs/Security/MustacheSniff.php
@@ -25,7 +25,7 @@ class MustacheSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/Security/ProperEscapingFunctionSniff.php b/WordPressVIPMinimum/Sniffs/Security/ProperEscapingFunctionSniff.php
@@ -107,7 +107,7 @@ class ProperEscapingFunctionSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		$this->echo_or_concat_tokens += Tokens::$emptyTokens;
diff --git a/WordPressVIPMinimum/Sniffs/Security/StaticStrreplaceSniff.php b/WordPressVIPMinimum/Sniffs/Security/StaticStrreplaceSniff.php
@@ -19,7 +19,7 @@ class StaticStrreplaceSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ T_STRING ];
diff --git a/WordPressVIPMinimum/Sniffs/Security/TwigSniff.php b/WordPressVIPMinimum/Sniffs/Security/TwigSniff.php
@@ -25,7 +25,7 @@ class TwigSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/Security/UnderscorejsSniff.php b/WordPressVIPMinimum/Sniffs/Security/UnderscorejsSniff.php
@@ -50,7 +50,7 @@ class UnderscorejsSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		$targets   = Tokens::$textStringTokens;
diff --git a/WordPressVIPMinimum/Sniffs/Security/VuejsSniff.php b/WordPressVIPMinimum/Sniffs/Security/VuejsSniff.php
@@ -25,7 +25,7 @@ class VuejsSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [
diff --git a/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php b/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php
@@ -118,7 +118,7 @@ class AdminBarRemovalSniff extends AbstractFunctionParameterSniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		// Set up all string targets.
diff --git a/WordPressVIPMinimum/Sniffs/Variables/ServerVariablesSniff.php b/WordPressVIPMinimum/Sniffs/Variables/ServerVariablesSniff.php
@@ -35,7 +35,7 @@ class ServerVariablesSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ abstract class AbstractVariableRestrictionsSniff extends Sniff {`
`58`	`58`	`/**`
`59`	`59`	`* Returns an array of tokens this test wants to listen for.`
`60`	`60`	`*`
`61`		`- * @return array`
	`61`	`+ * @return array<int\|string>`
`62`	`62`	`*/`
`63`	`63`	`public function register() {`
`64`	`64`	`// Retrieve the groups only once and don't set up a listener if there are no groups.`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class ConstantStringSniff extends Sniff {`
`20`	`20`	`/**`
`21`	`21`	`* Returns an array of tokens this test wants to listen for.`
`22`	`22`	`*`
`23`		`- * @return array`
	`23`	`+ * @return array<int\|string>`
`24`	`24`	`*/`
`25`	`25`	`public function register() {`
`26`	`26`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ class RestrictedConstantsSniff extends Sniff {`
`38`	`38`	`/**`
`39`	`39`	`* Returns an array of tokens this test wants to listen for.`
`40`	`40`	`*`
`41`		`- * @return array`
	`41`	`+ * @return array<int\|string>`
`42`	`42`	`*/`
`43`	`43`	`public function register() {`
`44`	`44`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ public function getGroups() {`
`107`	`107`	`/**`
`108`	`108`	`* Returns an array of tokens this test wants to listen for.`
`109`	`109`	`*`
`110`		`- * @return array`
	`110`	`+ * @return array<int\|string>`
`111`	`111`	`*/`
`112`	`112`	`public function register() {`
`113`	`113`	`return Tokens::$includeTokens;`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ class IncludingNonPHPFileSniff extends Sniff {`
`44`	`44`	`/**`
`45`	`45`	`* Returns an array of tokens this test wants to listen for.`
`46`	`46`	`*`
`47`		`- * @return array`
	`47`	`+ * @return array<int\|string>`
`48`	`48`	`*/`
`49`	`49`	`public function register() {`
`50`	`50`	`return Tokens::$includeTokens;`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ class CheckReturnValueSniff extends Sniff {`
`57`	`57`	`/**`
`58`	`58`	`* Returns the token types that this sniff is interested in.`
`59`	`59`	`*`
`60`		`- * @return array(int)`
	`60`	`+ * @return array<int\|string>`
`61`	`61`	`*/`
`62`	`62`	`public function register() {`
`63`	`63`	`return [ T_STRING ];`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ class DynamicCallsSniff extends Sniff {`
`62`	`62`	`/**`
`63`	`63`	`* Returns the token types that this sniff is interested in.`
`64`	`64`	`*`
`65`		`- * @return array(int)`
	`65`	`+ * @return array<int\|string>`
`66`	`66`	`*/`
`67`	`67`	`public function register() {`
`68`	`68`	`return [ T_VARIABLE => T_VARIABLE ];`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ class AlwaysReturnInFilterSniff extends Sniff {`
`27`	`27`	`/**`
`28`	`28`	`* Returns the token types that this sniff is interested in.`
`29`	`29`	`*`
`30`		`- * @return array(int)`
	`30`	`+ * @return array<int\|string>`
`31`	`31`	`*/`
`32`	`32`	`public function register() {`
`33`	`33`	`return [ T_STRING ];`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class PreGetPostsSniff extends Sniff {`
`21`	`21`	`/**`
`22`	`22`	`* Returns the token types that this sniff is interested in.`
`23`	`23`	`*`
`24`		`- * @return array(int)`
	`24`	`+ * @return array<int\|string>`
`25`	`25`	`*/`
`26`	`26`	`public function register() {`
`27`	`27`	`return [ T_STRING ];`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ class DangerouslySetInnerHTMLSniff extends Sniff {`
`27`	`27`	`/**`
`28`	`28`	`* Returns an array of tokens this test wants to listen for.`
`29`	`29`	`*`
`30`		`- * @return array`
	`30`	`+ * @return array<int\|string>`
`31`	`31`	`*/`
`32`	`32`	`public function register() {`
`33`	`33`	`return [`