Minor doc tweaks

Follow up on 2249 and 2250.
WordPress · Jun 16, 2023 · 46295e8 · 46295e8
1 parent 2e72cd6
commit 46295e8
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 16 deletions.
diff --git a/WordPress/Helpers/EscapingFunctionsTrait.php b/WordPress/Helpers/EscapingFunctionsTrait.php
@@ -20,7 +20,7 @@
  * - `customAutoEscapedFunctions`
  *
  * @package WPCS\WordPressCodingStandards
- * @since   3.0.0 The properties this trait were previously contained partially in the
+ * @since   3.0.0 The properties in this trait were previously contained partially in the
  *                `WordPressCS\WordPress\Sniff` class and partially in the `EscapeOutputSniff`
  *                class and have been moved here.
  */
@@ -30,7 +30,7 @@ trait EscapingFunctionsTrait {
 	 * Custom list of functions which escape values for display.
 	 *
 	 * @since 0.5.0
-	 * @since 3.0.0 Moved from the EscapeOutput Sniff class to this class.
+	 * @since 3.0.0 Moved from the EscapeOutput Sniff class to this trait.
 	 *
 	 * @var string|string[]
 	 */
@@ -40,7 +40,7 @@ trait EscapingFunctionsTrait {
 	 * Custom list of functions whose return values are pre-escaped for display.
 	 *
 	 * @since 0.3.0
-	 * @since 3.0.0 Moved from the EscapeOutput Sniff class to this class.
+	 * @since 3.0.0 Moved from the EscapeOutput Sniff class to this trait.
 	 *
 	 * @var string|string[]
 	 */
@@ -51,10 +51,10 @@ trait EscapingFunctionsTrait {
 	 *
 	 * @since 0.5.0
 	 * @since 0.11.0 Changed from public static to protected non-static.
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
+	 * @since 3.0.0 - Moved from the Sniff class to this trait.
 	 *              - Visibility changed from protected to private.
 	 *
-	 * @var array
+	 * @var array<string, bool>
 	 */
 	private $escapingFunctions = array(
 		'absint'                     => true,
@@ -100,10 +100,10 @@ trait EscapingFunctionsTrait {
 	 *
 	 * @since 0.5.0
 	 * @since 0.11.0 Changed from public static to protected non-static.
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
+	 * @since 3.0.0 - Moved from the Sniff class to this trait.
 	 *              - Visibility changed from protected to private.
 	 *
-	 * @var array
+	 * @var array<string, bool>
 	 */
 	private $autoEscapedFunctions = array(
 		'allowed_tags'              => true,
@@ -174,7 +174,7 @@ trait EscapingFunctionsTrait {
 	 * @since 0.4.0
 	 * @since 0.11.0 - Changed from public static to protected non-static.
 	 *               - Changed the format from simple bool to array.
-	 * @since 3.0.0  - Moved from the EscapeOutput Sniff class to this class.
+	 * @since 3.0.0  - Moved from the EscapeOutput Sniff class to this trait.
 	 *               - Visibility changed from protected to private.
 	 *
 	 * @var array
@@ -189,7 +189,7 @@ trait EscapingFunctionsTrait {
 	 *
 	 * @since 3.0.0
 	 *
-	 * @var array
+	 * @var array<string, bool>
 	 */
 	private $allEscapingFunctions = array();
 
@@ -198,7 +198,7 @@ trait EscapingFunctionsTrait {
 	 *
 	 * @since 3.0.0
 	 *
-	 * @var array
+	 * @var array<string, bool>
 	 */
 	private $allAutoEscapedFunctions = array();
 

diff --git a/WordPress/Helpers/PrintingFunctionsTrait.php b/WordPress/Helpers/PrintingFunctionsTrait.php
@@ -29,7 +29,7 @@ trait PrintingFunctionsTrait {
 	 * Custom list of functions which print output incorporating the passed values.
 	 *
 	 * @since 0.4.0
-	 * @since 3.0.0 Moved from the EscapeOutput Sniff class to this class.
+	 * @since 3.0.0 Moved from the EscapeOutput Sniff class to this trait.
 	 *
 	 * @var string|string[]
 	 */
@@ -40,10 +40,10 @@ trait PrintingFunctionsTrait {
 	 *
 	 * @since 0.5.0
 	 * @since 0.11.0 Changed from public static to protected non-static.
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
+	 * @since 3.0.0 - Moved from the Sniff class to this trait.
 	 *              - Visibility changed from protected to private.
 	 *
-	 * @var array
+	 * @var array<string, bool>
 	 */
 	private $printingFunctions = array(
 		'_deprecated_argument'    => true,
@@ -70,10 +70,10 @@ trait PrintingFunctionsTrait {
 	 * @since 0.4.0
 	 * @since 0.11.0 - Changed from public static to protected non-static.
 	 *               - Changed the format from simple bool to array.
-	 * @since 3.0.0  - Moved from the EscapeOutput Sniff class to this class.
+	 * @since 3.0.0  - Moved from the EscapeOutput Sniff class to this trait.
 	 *               - Visibility changed from protected to private.
 	 *
-	 * @var array
+	 * @var string|string[]
 	 */
 	private $addedCustomPrintingFunctions = array();
 
@@ -82,7 +82,7 @@ trait PrintingFunctionsTrait {
 	 *
 	 * @since 3.0.0
 	 *
-	 * @var array
+	 * @var array<string, bool>
 	 */
 	private $allPrintingFunctions = array();
 

diff --git a/WordPress/Sniffs/Security/EscapeOutputSniff.php b/WordPress/Sniffs/Security/EscapeOutputSniff.php
@@ -34,6 +34,10 @@
  *                 echo tags `<?=`.
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `XSS` category to the `Security` category.
+ *
+ * @uses    \WordPressCS\WordPress\Helpers\EscapingFunctionsTrait::$customEscapingFunctions
+ * @uses    \WordPressCS\WordPress\Helpers\EscapingFunctionsTrait::$customAutoEscapedFunctions
+ * @uses    \WordPressCS\WordPress\Helpers\PrintingFunctionsTrait::$customPrintingFunctions
  */
 class EscapeOutputSniff extends Sniff {