Docs: add @internal tag to classes marked as internal API

This adds _"the other"_ `@internal` tag to these classes, also marking the classes as "internal API" via the tag (on top of the notice in the docblock description).
WordPress · Jul 6, 2023 · 53e1edc · 53e1edc
1 parent ba9b1ea
commit 53e1edc
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 0 deletions.
diff --git a/WordPress/Helpers/ConstantsHelper.php b/WordPress/Helpers/ConstantsHelper.php
@@ -26,6 +26,8 @@
  * {@internal The functionality in this class will likely be replaced at some point in
  * the future by functions from PHPCSUtils.}
  *
+ * @internal
+ *
  * @package WPCS\WordPressCodingStandards
  * @since   3.0.0 The method in this class was previously contained in the
  *                `WordPressCS\WordPress\Sniff` class and has been moved here.

diff --git a/WordPress/Helpers/ContextHelper.php b/WordPress/Helpers/ContextHelper.php
@@ -23,6 +23,8 @@
  * This also means that it has no promise of backward compatibility. Use at your own risk.
  * ---------------------------------------------------------------------------------------------
  *
+ * @internal
+ *
  * @package WPCS\WordPressCodingStandards
  * @since   3.0.0 The methods in this class were previously contained in the
  *                `WordPressCS\WordPress\Sniff` class and have been moved here.

diff --git a/WordPress/Helpers/DeprecationHelper.php b/WordPress/Helpers/DeprecationHelper.php
@@ -23,6 +23,8 @@
  * {@internal The functionality in this class will likely be replaced at some point in
  * the future by functions from PHPCSUtils.}
  *
+ * @internal
+ *
  * @package WPCS\WordPressCodingStandards
  * @since   3.0.0 The method in this class was previously contained in the
  *                `WordPressCS\WordPress\Sniff` class and has been moved here.

diff --git a/WordPress/Helpers/ListHelper.php b/WordPress/Helpers/ListHelper.php
@@ -25,6 +25,8 @@
  * {@internal The functionality in this class will likely be replaced at some point in
  * the future by functions from PHPCSUtils.}
  *
+ * @internal
+ *
  * @package WPCS\WordPressCodingStandards
  * @since   3.0.0 The method in this class was previously contained in the
  *                `WordPressCS\WordPress\Sniff` class and has been moved here.

diff --git a/WordPress/Helpers/RulesetPropertyHelper.php b/WordPress/Helpers/RulesetPropertyHelper.php
@@ -17,6 +17,8 @@
  * This also means that it has no promise of backward compatibility. Use at your own risk.
  * ---------------------------------------------------------------------------------------------
  *
+ * @internal
+ *
  * @package WPCS\WordPressCodingStandards
  * @since   3.0.0 The method in this class was previously contained in the
  *                `WordPressCS\WordPress\Sniff` class and has been moved here.

diff --git a/WordPress/Helpers/SnakeCaseHelper.php b/WordPress/Helpers/SnakeCaseHelper.php
@@ -22,6 +22,8 @@
  * {@internal The functionality in this class will likely be replaced at some point in
  * the future by functions from PHPCSUtils.}
  *
+ * @internal
+ *
  * @package WPCS\WordPressCodingStandards
  * @since   3.0.0 The method in this class was previously contained in the
  *                `WordPressCS\WordPress\Sniff` class and has been moved here.

diff --git a/WordPress/Helpers/VariableHelper.php b/WordPress/Helpers/VariableHelper.php
@@ -25,6 +25,8 @@
  * {@internal The functionality in this class will likely be replaced at some point in
  * the future by functions from PHPCSUtils.}
  *
+ * @internal
+ *
  * @package WPCS\WordPressCodingStandards
  * @since   3.0.0 The methods in this class were previously contained in the
  *                `WordPressCS\WordPress\Sniff` class and have been moved here.