Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: use correct format for @internal tags #2281

Merged
merged 1 commit into from
Jul 4, 2023
Merged

Docs: use correct format for @internal tags #2281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions WordPress/Helpers/ContextHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ final class ContextHelper {
/**
* Check if a particular token acts - statically or non-statically - on an object.
*
* @internal Note: this may still mistake a namespaced function imported via a `use` statement for
* a global function!
* {@internal Note: this may still mistake a namespaced function imported via a `use` statement for
* a global function!}
*
* @since 2.1.0
* @since 3.0.0 - Moved from the Sniff class to this class.
Expand All @@ -137,8 +137,8 @@ public static function has_object_operator_before( File $phpcsFile, $stackPtr )
/**
* Check if a particular token is prefixed with a namespace.
*
* @internal This will give a false positive if the file is not namespaced and the token is prefixed
* with `namespace\`.
* {@internal This will give a false positive if the file is not namespaced and the token is prefixed
* with `namespace\`.}
*
* @since 2.1.0
* @since 3.0.0 - Moved from the Sniff class to this class.
Expand Down
4 changes: 2 additions & 2 deletions WordPress/Helpers/ListHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ final class ListHelper {
/**
* Get a list of the token pointers to the variables being assigned to in a list statement.
*
* @internal No need to take special measures for nested lists. Nested or not,
* each list part can only contain one variable being written to.
* {@internal No need to take special measures for nested lists. Nested or not,
* each list part can only contain one variable being written to.}
*
* @since 2.2.0
* @since 3.0.0 - Moved from the Sniff class to this class.
Expand Down
4 changes: 2 additions & 2 deletions WordPress/Sniffs/NamingConventions/PrefixAllGlobalsSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -773,8 +773,8 @@ protected function process_variable_assignment( $stackPtr, $in_list = false ) {
/**
* Check that global variables declared via a list construct are prefixed.
*
* @internal No need to take special measures for nested lists. Nested or not,
* each list part can only contain one variable being written to.
* {@internal No need to take special measures for nested lists. Nested or not,
* each list part can only contain one variable being written to.}
*
* @since 2.2.0
*
Expand Down
4 changes: 2 additions & 2 deletions WordPress/Sniffs/WP/GlobalVariablesOverrideSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,8 @@ public function process_token( $stackPtr ) {
/**
* Check that global variables declared via a list construct are prefixed.
*
* @internal No need to take special measures for nested lists. Nested or not,
* each list part can only contain one variable being written to.
* {@internal No need to take special measures for nested lists. Nested or not,
* each list part can only contain one variable being written to.}
*
* @since 2.2.0
*
Expand Down
Loading