Skip to content

Commit

Permalink
Docs: Replace miscellaneous incorrect PHPDoc tags.
Browse files Browse the repository at this point in the history
* `@contrib` is not a valid tag.
* `@origin` is not a valid tag.
* `@ref` is not a valid tag.
* `@blessed` is not a valid tag and doesn't convey any meaningful information.
* `@issue` is not a valid tag.

Reference: [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#phpdoc-tags PHP Documentation Standards: PHPDoc Tags].

Follow-up to [8852], [34754], [38832], [43808].

Props jrf.
See #59651.

git-svn-id: https://develop.svn.wordpress.org/trunk@57108 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
SergeyBiryukov committed Nov 13, 2023
1 parent 0079130 commit cfecc5c
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/wp-admin/includes/class-wp-filesystem-ssh2.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* To use this class you must follow these steps for PHP 5.2.6+
*
* @contrib http://kevin.vanzonneveld.net/techblog/article/make_ssh_connections_with_php/ - Installation Notes
* {@link http://kevin.vanzonneveld.net/techblog/article/make_ssh_connections_with_php/ - Installation Notes}
*
* Compile libssh2 (Note: Only 0.14 is officaly working with PHP 5.2.6+ right now, But many users have found the latest versions work)
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ function twentynineteen_get_the_archive_title() {
/**
* Adds custom 'sizes' attribute to responsive image functionality for post thumbnails.
*
* @origin Twenty Nineteen 1.0
* @since Twenty Nineteen 1.0
*
* @param string[] $attr Array of attribute values for the image markup, keyed by attribute name.
* See wp_get_attachment_image().
Expand Down Expand Up @@ -163,7 +163,8 @@ function twentynineteen_add_ellipses_to_nav( $nav_menu, $args ) {
* Adjustments to menu attributes to support WCAG 2.0 recommendations
* for flyout and dropdown menus.
*
* @ref https://www.w3.org/WAI/tutorials/menus/flyout/
* @link https://www.w3.org/WAI/tutorials/menus/flyout/
*
* @param array $atts {
* The HTML attributes applied to the menu item's `<a>` element, empty strings are ignored.
*
Expand Down
2 changes: 0 additions & 2 deletions src/wp-includes/ms-functions.php
Original file line number Diff line number Diff line change
Expand Up @@ -2082,8 +2082,6 @@ function redirect_this_site( $deprecated = '' ) {
*
* @since MU (3.0.0)
*
* @blessed
*
* @param array $upload An array of information about the newly-uploaded file.
* @return string|array If the upload is under the size limit, $upload is returned. Otherwise returns an error message.
*/
Expand Down
2 changes: 1 addition & 1 deletion tests/phpunit/tests/rest-api/rest-posts-controller.php
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ public function test_get_items() {
/**
* A valid query that returns 0 results should return an empty JSON list.
*
* @issue 862
* @link https://github.com/WP-API/WP-API/issues/862
*/
public function test_get_items_empty_query() {
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
Expand Down

0 comments on commit cfecc5c

Please sign in to comment.