Merge pull request #1595 from WordPress-Coding-Standards/feature/update-since-docs

Documentation: Touch up the class and method documentation

Author: GaryJones

WordPress/AbstractArrayAssignmentRestrictionsSniff.php

@@ -19,8 +19,8 @@
  * @since   0.3.0
  * @since   0.10.0 Class became a proper abstract class. This was already the behaviour.
  *                 Moved the file and renamed the class from
- *                 `WordPress_Sniffs_Arrays_ArrayAssignmentRestrictionsSniff` to
- *                 `WordPress_AbstractArrayAssignmentRestrictionsSniff`.
+ *                 `\WordPressCS\WordPress\Sniffs\Arrays\ArrayAssignmentRestrictionsSniff` to
+ *                 `\WordPressCS\WordPress\AbstractArrayAssignmentRestrictionsSniff`.
  */
 abstract class AbstractArrayAssignmentRestrictionsSniff extends Sniff {
 

WordPress/AbstractClassRestrictionsSniff.php

@@ -79,7 +79,7 @@ public function register() {
 	/**
 	 * Processes this test, when one of its tokens is encountered.
 	 *
-	 * {@internal Unlike in the `WordPress_AbstractFunctionRestrictionsSniff`,
+	 * {@internal Unlike in the `AbstractFunctionRestrictionsSniff`,
 	 *            we can't do a preliminary check on classes as at this point
 	 *            we don't know the class name yet.}}
 	 *

WordPress/AbstractFunctionRestrictionsSniff.php

@@ -20,9 +20,9 @@
  * @since   0.3.0
  * @since   0.10.0 Class became a proper abstract class. This was already the behaviour.
  *                 Moved the file and renamed the class from
- *                 `WordPress_Sniffs_Functions_FunctionRestrictionsSniff` to
- *                 `WordPress_AbstractFunctionRestrictionsSniff`.
- * @since   0.11.0 Extends the WordPress_Sniff class.
+ *                 `\WordPressCS\WordPress\Sniffs\Functions\FunctionRestrictionsSniff` to
+ *                 `\WordPressCS\WordPress\AbstractFunctionRestrictionsSniff`.
+ * @since   0.11.0 Extends the WordPressCS native `Sniff` class.
  */
 abstract class AbstractFunctionRestrictionsSniff extends Sniff {
 

WordPress/Sniff.php

@@ -500,7 +500,7 @@ abstract class Sniff implements PHPCS_Sniff {
 	 * @since 0.3.0
 	 * @since 0.11.0 Changed visibility from public to protected.
 	 * @since 0.12.0 Renamed from `$globals` to `$wp_globals` to be more descriptive.
-	 * @since 0.12.0 Moved from WordPress_Sniffs_Variables_GlobalVariablesSniff to WordPress_Sniff
+	 * @since 0.12.0 Moved here from the WordPress.Variables.GlobalVariables sniff.
 	 *
 	 * @var array
 	 */
@@ -955,7 +955,7 @@ protected function string_to_errorcode( $base_string ) {
 	 *     before merging/returning to allow for resetting to the base array.
 	 *
 	 * {@internal Function is static as it doesn't use any of the properties or others
-	 * methods anyway and this way the `WordPress_Sniffs_NamingConventions_ValidVariableNameSniff`
+	 * methods anyway and this way the `WordPress.NamingConventions.ValidVariableName` sniff
 	 * which extends an upstream sniff can also use it.}}
 	 *
 	 * @since 0.11.0
@@ -2196,7 +2196,7 @@ protected function find_array_open_close( $stackPtr ) {
 	 * Determine the namespace name an arbitrary token lives in.
 	 *
 	 * @since 0.10.0
-	 * @since 0.12.0 Moved from the WordPress_AbstractClassRestrictionsSniff to this sniff.
+	 * @since 0.12.0 Moved from the `AbstractClassRestrictionsSniff` to this class.
 	 *
 	 * @param int $stackPtr The token position for which to determine the namespace.
 	 *
@@ -2262,7 +2262,7 @@ public function determine_namespace( $stackPtr ) {
 	 * i.e. MyProject\Sub\Level which will be returned together as one string.
 	 *
 	 * @since 0.12.0 A lesser variant of this method previously existed in the
-	 *               WordPress_AbstractClassRestrictionsSniff.
+	 *               `AbstractClassRestrictionsSniff` class.
 	 *
 	 * @param int|bool $stackPtr The position of a T_NAMESPACE token.
 	 *

WordPress/Sniffs/Arrays/ArrayDeclarationSpacingSniff.php

@@ -27,14 +27,13 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   0.11.0 - The WordPress specific additional checks have now been split off
- *                 from the WordPress_Sniffs_Arrays_ArrayDeclaration sniff into
- *                 this sniff.
+ *                   from the `WordPress.Arrays.ArrayDeclaration` sniff into this sniff.
  *                 - Added sniffing & fixing for associative arrays.
  * @since   0.12.0 Decoupled this sniff from the upstream sniff completely.
- *                 This sniff now extends the `WordPress_Sniff` instead.
- * @since   0.13.0 Added the last remaining checks from the `ArrayDeclaration` sniff
- *                 which were not covered elsewhere. The `ArrayDeclaration` sniff has
- *                 now been deprecated.
+ *                 This sniff now extends the WordPressCS native `Sniff` class instead.
+ * @since   0.13.0 Added the last remaining checks from the `WordPress.Arrays.ArrayDeclaration`
+ *                 sniff which were not covered elsewhere.
+ *                 The `WordPress.Arrays.ArrayDeclaration` sniff has now been deprecated.
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   0.14.0 Single item associative arrays are now by default exempt from the
  *                 "must be multi-line" rule. This behaviour can be changed using the

WordPress/Sniffs/Arrays/ArrayKeySpacingRestrictionsSniff.php

@@ -20,7 +20,7 @@
  *
  * @since   0.3.0
  * @since   0.7.0  This sniff now has the ability to fix a number of the issues it flags.
- * @since   0.12.0 This class now extends WordPress_Sniff.
+ * @since   0.12.0 This class now extends the WordPressCS native `Sniff` class.
  * @since   0.13.0 Class name changed: this class is now namespaced.
  */
 class ArrayKeySpacingRestrictionsSniff extends Sniff {

WordPress/Sniffs/DB/DirectDatabaseQuerySniff.php

@@ -21,7 +21,7 @@
  *
  * @since   0.3.0
  * @since   0.6.0  Removed the add_unique_message() function as it is no longer needed.
- * @since   0.11.0 This class now extends WordPress_Sniff.
+ * @since   0.11.0 This class now extends the WordPressCS native `Sniff` class.
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `VIP` category to the `DB` category.
  */

WordPress/Sniffs/Files/FileNameSniff.php

@@ -25,10 +25,10 @@
  *                   template tags end in `-template`. Based on @subpackage file DocBlock tag.
  *                 - This sniff will now allow for underscores in file names for certain theme
  *                   specific exceptions if the `$is_theme` property is set to `true`.
- * @since   0.12.0 Now extends the `WordPress_Sniff` class.
+ * @since   0.12.0 Now extends the WordPressCS native `Sniff` class.
  * @since   0.13.0 Class name changed: this class is now namespaced.
  *
- * @uses    \WordPress\Sniff::$custom_test_class_whitelist
+ * @uses    \WordPressCS\WordPress\Sniff::$custom_test_class_whitelist
  */
 class FileNameSniff extends Sniff {
 

WordPress/Sniffs/NamingConventions/PrefixAllGlobalsSniff.php

@@ -22,7 +22,7 @@
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.2.0  Now also checks whether namespaces are prefixed.
  *
- * @uses    \WordPress\Sniff::$custom_test_class_whitelist
+ * @uses    \WordPressCS\WordPress\Sniff::$custom_test_class_whitelist
  */
 class PrefixAllGlobalsSniff extends AbstractFunctionParameterSniff {
 

WordPress/Sniffs/NamingConventions/ValidHookNameSniff.php

@@ -24,7 +24,7 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   0.10.0
- * @since   0.11.0 Extends the WordPress_AbstractFunctionParameterSniff class.
+ * @since   0.11.0 Extends the WordPressCS native `AbstractFunctionParameterSniff` class.
  * @since   0.13.0 Class name changed: this class is now namespaced.
  */
 class ValidHookNameSniff extends AbstractFunctionParameterSniff {