Changeset 42678

Timestamp:

02/09/2018 04:54:58 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Add missing code formatting to various @since entries.

See #42505

Location:

trunk/src

Files:

• wp-admin/includes/file.php (modified) (2 diffs)
• wp-includes/class-wp-customize-manager.php (modified) (2 diffs)
• wp-includes/class-wp-roles.php (modified) (1 diff)
• wp-includes/comment.php (modified) (2 diffs)
• wp-includes/functions.php (modified) (5 diffs)
• wp-includes/http.php (modified) (1 diff)
• wp-includes/link-template.php (modified) (1 diff)
• wp-includes/ms-blogs.php (modified) (1 diff)
• wp-includes/ms-functions.php (modified) (9 diffs)
• wp-includes/post.php (modified) (8 diffs)
• wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (1 diff)
• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)
• wp-includes/taxonomy.php (modified) (1 diff)
• wp-includes/template.php (modified) (1 diff)
• wp-includes/user.php (modified) (1 diff)

trunk/src/wp-admin/includes/file.php

@@ -220 +220 @@
      *
      * @since 2.8.0
-     * @since 4.9.0 Adds $plugin param.
+     * @since 4.9.0 Added the `$plugin` parameter.
      *
      * @param string $plugin Plugin file.
@@ -340 +340 @@
  * @param array $args {
  *     Args. Note that all of the arg values are already unslashed. They are, however,
- *     coming straight from $_POST and are not validated or sanitized in any way.
+ *     coming straight from `$_POST` and are not validated or sanitized in any way.
  *
  *     @type string $file       Relative path to file.

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -241 +241 @@
      *
      * @since 3.4.0
-     * @since 4.7.0 Added $args param.
+     * @since 4.7.0 Added `$args` parameter.
      *
      * @param array $args {
@@ -1684 +1684 @@
      *
      * @since 4.1.1
-     * @since 4.7.0 Added $args param and merging with changeset values and stashed theme mods.
+     * @since 4.7.0 Added `$args` parameter and merging with changeset values and stashed theme mods.
      *
      * @param array $args {

trunk/src/wp-includes/class-wp-roles.php

@@ -77 +77 @@
      *
      * @since 2.0.0
-     * @since 4.9.0 The $site_id argument was added.
+     * @since 4.9.0 The `$site_id` argument was added.
      *
      * @global array $wp_user_roles Used to set the 'roles' property value.

trunk/src/wp-includes/comment.php

@@ -2595 +2595 @@
  *
  * @since 1.5.0
- * @since 4.7.0 $post_id can be a WP_Post object.
+ * @since 4.7.0 `$post_id` can be a WP_Post object.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -2674 +2674 @@
  *
  * @since 0.71
- * @since 4.7.0 $post_id can be a WP_Post object.
+ * @since 4.7.0 `$post_id` can be a WP_Post object.
  *
  * @param string $content Post content to check for links. If empty will retrieve from post.

trunk/src/wp-includes/functions.php

@@ -232 +232 @@
      *
      * @since 2.8.0
-     * @since 4.9.0 The `$number` and `$decimals` arguments were added.
+     * @since 4.9.0 The `$number` and `$decimals` parameters were added.
      *
      * @param string $formatted Converted number in string format.
@@ -3713 +3713 @@
  *
  * @since 3.0.0
- * @since 4.7.0 Uses WP_List_Util class.
+ * @since 4.7.0 Uses `WP_List_Util` class.
  *
  * @param array       $list     An array of objects to filter
@@ -3746 +3746 @@
  *
  * @since 3.1.0
- * @since 4.7.0 Uses WP_List_Util class.
+ * @since 4.7.0 Uses `WP_List_Util` class.
  *
  * @param array  $list     An array of objects to filter.
@@ -3774 +3774 @@
  * @since 3.1.0
  * @since 4.0.0 $index_key parameter added.
- * @since 4.7.0 Uses WP_List_Util class.
+ * @since 4.7.0 Uses `WP_List_Util` class.
  *
  * @param array      $list      List of objects or arrays
@@ -4576 +4576 @@
  *
  * @since 3.0.0
- * @since 4.9.0 The $network_id parameter has been added.
+ * @since 4.9.0 The `$network_id` parameter was added.
  *
  * @param int $site_id    Optional. Site ID to test. Defaults to current site.

trunk/src/wp-includes/http.php

@@ -664 +664 @@
  *
  * @since 4.4.0
- * @since 4.7.0 The $component parameter was added for parity with PHP's parse_url().
+ * @since 4.7.0 The `$component` parameter was added for parity with PHP's `parse_url()`.
  *
  * @link https://secure.php.net/manual/en/function.parse-url.php

trunk/src/wp-includes/link-template.php

@@ -3714 +3714 @@
  *
  * @since 2.9.0
- * @since 4.6.0 Adjusted to use wp_get_canonical_url().
+ * @since 4.6.0 Adjusted to use `wp_get_canonical_url()`.
  */
 function rel_canonical() {

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

@@ -76 +76 @@
  *
  * @since MU (3.0.0)
- * @since 4.7.0 Converted to use get_sites().
+ * @since 4.7.0 Converted to use `get_sites()`.
  *
  * @param string $slug A site's slug.

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

@@ -102 +102 @@
  *
  * @since MU (3.0.0)
- * @since 4.8.0 The $network_id parameter has been added.
+ * @since 4.8.0 The `$network_id` parameter has been added.
  *
  * @param int|null $network_id ID of the network. Default is the current network.
@@ -117 +117 @@
  *
  * @since MU (3.0.0)
- * @since 3.7.0 The $network_id parameter has been deprecated.
- * @since 4.8.0 The $network_id parameter is now being used.
+ * @since 3.7.0 The `$network_id` parameter has been deprecated.
+ * @since 4.8.0 The `$network_id` parameter is now being used.
  *
  * @param int|null $network_id ID of the network. Default is the current network.
@@ -2464 +2464 @@
  *
  * @since 3.1.0
- * @since 4.8.0 The $network_id parameter has been added.
+ * @since 4.8.0 The `$network_id` parameter has been added.
  *
  * @param int|null $network_id ID of the network. Default is the current network.
@@ -2480 +2480 @@
  *
  * @since 3.7.0
- * @since 4.8.0 The $network_id parameter has been added.
+ * @since 4.8.0 The `$network_id` parameter has been added.
  *
  * @param int|null $network_id ID of the network. Default is the current network.
@@ -2511 +2511 @@
  *
  * @since 3.7.0
- * @since 4.8.0 The $network_id parameter has been added.
+ * @since 4.8.0 The `$network_id` parameter has been added.
  *
  * @param int|null $network_id ID of the network. Default is the current network.
@@ -2530 +2530 @@
  *
  * @since 3.7.0
- * @since 4.8.0 The $network_id parameter has been added.
+ * @since 4.8.0 The `$network_id` parameter has been added.
  *
  * @param int|null $network_id ID of the network. Default is the current network.
@@ -2557 +2557 @@
  *
  * @since 3.7.0
- * @since 4.8.0 The $network_id parameter has been added.
+ * @since 4.8.0 The `$network_id` parameter has been added.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -2686 +2686 @@
  *
  * @since 3.3.0
- * @since 4.8.0 The $network_id parameter has been added.
+ * @since 4.8.0 The `$network_id` parameter has been added.
  *
  * @param string   $using      'sites or 'users'. Default is 'sites'.
@@ -2704 +2704 @@
          *
          * @since 3.3.0
-         * @since 4.8.0 The $network_id parameter has been added.
+         * @since 4.8.0 The `$network_id` parameter has been added.
          *
          * @param bool   $is_large_network Whether the network has more than 10000 users or sites.

trunk/src/wp-includes/post.php

@@ -1005 +1005 @@
  *
  * @since 3.0.0
- * @since 4.6.0 Object returned is now an instance of WP_Post_Type.
+ * @since 4.6.0 Object returned is now an instance of `WP_Post_Type`.
  *
  * @global array $wp_post_types List of post types.
@@ -1068 +1068 @@
  * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing
  *              screen and post editing screen.
- * @since 4.6.0 Post type object returned is now an instance of WP_Post_Type.
- * @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
+ * @since 4.6.0 Post type object returned is now an instance of `WP_Post_Type`.
+ * @since 4.7.0 Introduced `show_in_rest`, `rest_base` and `rest_controller_class`
  *              arguments to register the post type in REST API.
  *
@@ -1215 +1215 @@
      *
      * @since 3.3.0
-     * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
+     * @since 4.6.0 Converted the `$post_type` parameter to accept a `WP_Post_Type` object.
      *
      * @param string       $post_type        Post type.
@@ -1444 +1444 @@
  * @since 4.4.0 Added the `archives`, `insert_into_item`, `uploaded_to_this_item`, `filter_items_list`,
  *              `items_list_navigation`, and `items_list` labels.
- * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
+ * @since 4.6.0 Converted the `$post_type` parameter to accept a `WP_Post_Type` object.
  * @since 4.7.0 Added the `view_items` and `attributes` labels.
  *
@@ -1713 +1713 @@
  * @since 4.4.0
  * @since 4.5.0 Added the ability to pass a post type name in addition to object.
- * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
+ * @since 4.6.0 Converted the `$post_type` parameter to accept a `WP_Post_Type` object.
  *
  * @param string|WP_Post_Type $post_type Post type name or object.
@@ -4249 +4249 @@
  *
  * @since 1.5.0
- * @since 4.7.0 $post_id can be a WP_Post object.
- * @since 4.7.0 $uri can be an array of URIs.
+ * @since 4.7.0 `$post_id` can be a WP_Post object.
+ * @since 4.7.0 `$uri` can be an array of URIs.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -4331 +4331 @@
  * @since 1.5.0
  *
- * @since 4.7.0 $post_id can be a WP_Post object.
+ * @since 4.7.0 `$post_id` can be a WP_Post object.
  *
  * @param int|WP_Post $post_id Post ID or object.
@@ -4359 +4359 @@
  *
  * @since 1.5.0
- * @since 4.7.0 $post_id can be a WP_Post object.
+ * @since 4.7.0 `$post_id` can be a WP_Post object.
  *
  * @param int|WP_Post $post_id Post Object or ID

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -579 +579 @@
          *
          * @since 4.7.0
-         * @since 4.8.0 $prepared_comment can now be a WP_Error to shortcircuit insertion.
+         * @since 4.8.0 `$prepared_comment` can now be a WP_Error to shortcircuit insertion.
          *
          * @param array|WP_Error  $prepared_comment The prepared comment data for wp_insert_comment().

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -1202 +1202 @@
      *
      * @since 4.7.0
-     * @since 4.9.0 Introduced the $validate parameter.
+     * @since 4.9.0 Added the `$validate` parameter.
      *
      * @param string  $template Page template filename.

trunk/src/wp-includes/taxonomy.php

@@ -3231 +3231 @@
  *
  * @since 2.3.0
- * @since 4.7.0 Returns a WP_Error object if get_term() returns an error for
+ * @since 4.7.0 Returns a `WP_Error` object if `get_term()` returns an error for
  *              any of the matched terms.
  *

trunk/src/wp-includes/template.php

@@ -478 +478 @@
  * @since 4.7.0 The decoded form of `single-{post_type}-{post_name}.php` was added to the top of the
  *              template hierarchy when the post name contains multibyte characters.
- * @since 4.7.0 {Post Type Template}.php was added to the top of the template hierarchy.
+ * @since 4.7.0 `{Post Type Template}.php` was added to the top of the template hierarchy.
  *
  * @see get_query_template()

trunk/src/wp-includes/user.php

@@ -594 +594 @@
  *
  * @since 3.0.0
- * @since 4.7.0 Converted to use get_sites().
+ * @since 4.7.0 Converted to use `get_sites()`.
  *
  * @global wpdb $wpdb WordPress database abstraction object.