Changeset 57108

Timestamp:

11/13/2023 11:11:54 AM (15 months ago)

Author:

SergeyBiryukov

Message:

Docs: Replace miscellaneous incorrect PHPDoc tags.

• @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: ​PHP Documentation Standards: PHPDoc Tags.

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

Props jrf.
See #59651.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-filesystem-ssh2.php (modified) (1 diff)
• src/wp-content/themes/twentynineteen/inc/template-functions.php (modified) (2 diffs)
• src/wp-includes/ms-functions.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-filesystem-ssh2.php

@@ -5 +5 @@
  * 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)

trunk/src/wp-content/themes/twentynineteen/inc/template-functions.php

@@ -101 +101 @@
  * 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.
@@ -164 +164 @@
  * 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.

trunk/src/wp-includes/ms-functions.php

@@ -2083 +2083 @@
  * @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.

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -257 +257 @@
      * 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() {