Changeset 42877

Timestamp:

03/25/2018 07:34:31 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve various inline documentation.

See #42505

Location:

trunk/src

Files:

• wp-admin/includes/dashboard.php (modified) (2 diffs)
• wp-admin/includes/taxonomy.php (modified) (1 diff)
• wp-admin/includes/theme.php (modified) (1 diff)
• wp-includes/category-template.php (modified) (1 diff)
• wp-includes/class-http.php (modified) (1 diff)
• wp-includes/class-walker-nav-menu.php (modified) (1 diff)
• wp-includes/class-wp-meta-query.php (modified) (1 diff)
• wp-includes/class-wp-metadata-lazyloader.php (modified) (1 diff)
• wp-includes/date.php (modified) (1 diff)

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

@@ -440 +440 @@
          *
          * @since MU (3.0.0)
-         *
-         * @param null $unused
          */
-        do_action( 'wpmuadminresult', '' );
+        do_action( 'wpmuadminresult' );
     ?>
 
@@ -1530 +1528 @@
      *
      * @param string $notice   The notice content.
-     * @param array  $response An array containing web browser information.
+     * @param array  $response An array containing web browser information. See `wp_check_browser_version()`.
      */
     echo apply_filters( 'browse-happy-notice', $notice, $response );

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

@@ -283 +283 @@
      * @see get_terms_to_edit()
      *
-     * @param array  $terms_to_edit An array of terms.
-     * @param string $taxonomy     The taxonomy for which to retrieve terms. Default 'post_tag'.
+     * @param string $terms_to_edit A comma-separated list of term names.
+     * @param string $taxonomy      The taxonomy name for which to retrieve terms.
      */
     $terms_to_edit = apply_filters( 'terms_to_edit', $terms_to_edit, $taxonomy );

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

@@ -581 +581 @@
      * Filters theme data before it is prepared for JavaScript.
      *
-     * Passing a non-empty array will result in wp_prepare_themes_for_js() returning
+     * Passing a non-empty array will result in `wp_prepare_themes_for_js()` returning
      * early with that value instead.
      *

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

@@ -1388 +1388 @@
      * @since 2.9.0
      *
-     * @param array  $term_list List of terms to display.
+     * @param string $term_list List of terms to display.
      * @param string $taxonomy  The taxonomy name.
      * @param string $before    String to use before the terms.

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

@@ -441 +441 @@
      * @since 4.6.0
      *
-     * @param array $cookies List of cookies to send with the request.
+     * @param array $cookies Array of cookies to send with the request.
      * @return Requests_Cookie_Jar Cookie holder object.
      */

trunk/src/wp-includes/class-walker-nav-menu.php

@@ -141 +141 @@
 
         /**
-         * Filters the CSS class(es) applied to a menu item's list item element.
+         * Filters the CSS classes applied to a menu item's list item element.
          *
          * @since 3.0.0

trunk/src/wp-includes/class-wp-meta-query.php

@@ -340 +340 @@
          * @since 3.1.0
          *
-         * @param array  $clauses           Array containing the query's JOIN and WHERE clauses.
+         * @param array  $sql               Array containing the query's JOIN and WHERE clauses.
          * @param array  $queries           Array of meta queries.
          * @param string $type              Type of meta.

trunk/src/wp-includes/class-wp-metadata-lazyloader.php

@@ -98 +98 @@
          * @since 4.5.0
          *
-         * @param array                  $object_ids  Object IDs.
+         * @param array                  $object_ids  Array of object IDs.
          * @param string                 $object_type Type of object being queued.
          * @param WP_Metadata_Lazyloader $lazyloader  The lazy-loader object.

trunk/src/wp-includes/date.php

@@ -141 +141 @@
      *     }
      * }
-     * @param array $default_column Optional. Default column to query against. Default 'post_date'.
-     *                              Accepts 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
-     *                              'comment_date', 'comment_date_gmt'.
+     * @param string $default_column Optional. Default column to query against. Default 'post_date'.
+     *                               Accepts 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
+     *                               'comment_date', 'comment_date_gmt'.
      */
     public function __construct( $date_query, $default_column = 'post_date' ) {