Changeset 46821

Timestamp:

12/06/2019 10:21:07 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Correct various docblocks documentation.

See #48303

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-list-table.php (modified) (1 diff)
• src/wp-admin/includes/nav-menu.php (modified) (1 diff)
• src/wp-admin/my-sites.php (modified) (1 diff)
• src/wp-includes/class-wp-customize-manager.php (modified) (2 diffs)
• src/wp-includes/class-wp-customize-nav-menus.php (modified) (1 diff)
• src/wp-includes/comment-template.php (modified) (2 diffs)
• src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php (modified) (2 diffs)
• src/wp-includes/revision.php (modified) (1 diff)
• src/wp-includes/theme.php (modified) (1 diff)
• src/wp-includes/widgets/class-wp-widget-custom-html.php (modified) (1 diff)
• tests/phpunit/tests/customize/manager.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-list-table.php

@@ -581 +581 @@
          * @since 3.7.0
          *
-         * @param object $months    The months drop-down query results.
-         * @param string $post_type The post type.
+         * @param object[] $months    Array of the months drop-down query results.
+         * @param string   $post_type The post type.
          */
         $months = apply_filters( 'months_dropdown_results', $months, $post_type );

trunk/src/wp-admin/includes/nav-menu.php

@@ -220 +220 @@
          * @since 3.0.0
          *
-         * @param object $meta_box_object The current object to add a menu items
-         *                                meta box for.
+         * @param WP_Post_Type|false $post_type The current object to add a menu items
+         *                                      meta box for.
          */
         $post_type = apply_filters( 'nav_menu_meta_box_object', $post_type );

trunk/src/wp-admin/my-sites.php

@@ -105 +105 @@
      *
      * @param string $settings_html The settings HTML markup. Default empty.
-     * @param object $context       Context of the setting (global or site-specific). Default 'global'.
+     * @param string $context       Context of the setting (global or site-specific). Default 'global'.
      */
     $settings_html = apply_filters( 'myblogs_options', '', 'global' );

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

@@ -4570 +4570 @@
      * @since 4.7.0
      *
-     * @returns array Allowed URLs.
+     * @return array Allowed URLs.
      */
     public function get_allowed_urls() {
@@ -5701 +5701 @@
      * @since 4.7.0
      *
-     * @returns bool Whether there are published (or to be published) pages.
+     * @return bool Whether there are published (or to be published) pages.
      */
     public function has_published_pages() {

trunk/src/wp-includes/class-wp-customize-nav-menus.php

@@ -1283 +1283 @@
      *
      * @param array $value Post IDs.
-     * @returns array Post IDs.
+     * @return array Post IDs.
      */
     public function sanitize_nav_menus_created_posts( $value ) {

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

@@ -1718 +1718 @@
      * @since 2.7.0
      *
-     * @param string  $link    The HTML markup for the comment reply link.
-     * @param array   $args    An array of arguments overriding the defaults.
-     * @param object  $comment The object of the comment being replied.
-     * @param WP_Post $post    The WP_Post object.
+     * @param string     $link    The HTML markup for the comment reply link.
+     * @param array      $args    An array of arguments overriding the defaults.
+     * @param WP_Comment $comment The object of the comment being replied.
+     * @param WP_Post    $post    The WP_Post object.
      */
     return apply_filters( 'comment_reply_link', $args['before'] . $link . $args['after'], $args, $comment, $post );
@@ -1733 +1733 @@
  * @see get_comment_reply_link()
  *
- * @param array       $args    Optional. Override default options.
- * @param int         $comment Comment being replied to. Default current comment.
- * @param int|WP_Post $post    Post ID or WP_Post object the comment is going to be displayed on.
- *                             Default current post.
+ * @param array          $args    Optional. Override default options.
+ * @param int|WP_Comment $comment Comment being replied to. Default current comment.
+ * @param int|WP_Post    $post    Post ID or WP_Post object the comment is going to be displayed on.
+ *                                Default current post.
  */
 function comment_reply_link( $args = array(), $comment = null, $post = null ) {

trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

@@ -300 +300 @@
      *
      * @param object $item Nav menu item.
-     * @returns string The type label.
+     * @return string The type label.
      */
     protected function get_type_label( $item ) {

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

@@ -180 +180 @@
      * @since 4.7.0
      *
-     * @param stdClass        $taxonomy Taxonomy data.
+     * @param WP_Taxonomy     $taxonomy Taxonomy data.
      * @param WP_REST_Request $request  Full details about the request.
      * @return WP_REST_Response Response object.
@@ -263 +263 @@
          *
          * @param WP_REST_Response $response The response object.
-         * @param object           $item     The original taxonomy object.
+         * @param WP_Taxonomy      $item     The original taxonomy object.
          * @param WP_REST_Request  $request  Request used to generate the response.
          */

trunk/src/wp-includes/revision.php

@@ -444 +444 @@
          * @since 2.6.0
          *
-         * @param int          $revision_id Post revision ID.
-         * @param object|array $revision    Post revision object or array.
+         * @param int     $revision_id Post revision ID.
+         * @param WP_Post $revision    Post revision object.
          */
         do_action( 'wp_delete_post_revision', $revision->ID, $revision );

trunk/src/wp-includes/theme.php

@@ -3145 +3145 @@
  * @param array $post_data          An array of slashed post data.
  * @param array $supplied_post_data An array of sanitized, but otherwise unmodified post data.
- * @returns array Filtered data.
+ * @return array Filtered data.
  */
 function _wp_customize_changeset_filter_insert_post_data( $post_data, $supplied_post_data ) {

trunk/src/wp-includes/widgets/class-wp-widget-custom-html.php

@@ -240 +240 @@
      * @see WP_Widget_Custom_HTML::render_control_template_scripts()
      * @param array $instance Current instance.
-     * @returns void
      */
     public function form( $instance ) {

trunk/tests/phpunit/tests/customize/manager.php

@@ -1253 +1253 @@
      * @param array $data    Data.
      * @param array $context Context.
-     * @returns array Data.
+     * @return array Data.
      */
     function filter_customize_changeset_save_data( $data, $context ) {