From 53e1edc452af0867bea3d99798421a29c8257c7e Mon Sep 17 00:00:00 2001 From: jrfnl Date: Thu, 6 Jul 2023 08:51:26 +0200 Subject: [PATCH] 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/Helpers/ConstantsHelper.php | 2 ++ WordPress/Helpers/ContextHelper.php | 2 ++ WordPress/Helpers/DeprecationHelper.php | 2 ++ WordPress/Helpers/ListHelper.php | 2 ++ WordPress/Helpers/RulesetPropertyHelper.php | 2 ++ WordPress/Helpers/SnakeCaseHelper.php | 2 ++ WordPress/Helpers/VariableHelper.php | 2 ++ 7 files changed, 14 insertions(+) diff --git a/WordPress/Helpers/ConstantsHelper.php b/WordPress/Helpers/ConstantsHelper.php index 2c82401bb8..506254b2a1 100644 --- 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 index a7ccc979c8..aeaf4b1e34 100644 --- 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 index 33085e525e..2a7a665473 100644 --- 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 index 8649a8462b..a58610c124 100644 --- 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 index 0411e95930..3722266ac9 100644 --- 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 index a6bf69dd74..5dd559cf9e 100644 --- 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 index 428de8ab1a..68ca0d6bd7 100644 --- 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.