Docs: Correct and improve various inline documentation.

See #42505


git-svn-id: https://develop.svn.wordpress.org/trunk@42877 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2018-03-25 19:34:31 +00:00
parent e207cdf2bb
commit cf400b9bc4
9 changed files with 13 additions and 15 deletions

View File

@ -439,10 +439,8 @@ function wp_network_dashboard_right_now() {
* just before the user and site search form fields. * just before the user and site search form fields.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
*
* @param null $unused
*/ */
do_action( 'wpmuadminresult', '' ); do_action( 'wpmuadminresult' );
?> ?>
<form action="<?php echo network_admin_url( 'users.php' ); ?>" method="get"> <form action="<?php echo network_admin_url( 'users.php' ); ?>" method="get">
@ -1529,7 +1527,7 @@ function wp_dashboard_browser_nag() {
* @since 3.2.0 * @since 3.2.0
* *
* @param string $notice The notice content. * @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 ); echo apply_filters( 'browse-happy-notice', $notice, $response );
} }

View File

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

View File

@ -580,7 +580,7 @@ function wp_prepare_themes_for_js( $themes = null ) {
/** /**
* Filters theme data before it is prepared for JavaScript. * 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. * early with that value instead.
* *
* @since 4.2.0 * @since 4.2.0

View File

@ -1387,7 +1387,7 @@ function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
* *
* @since 2.9.0 * @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 $taxonomy The taxonomy name.
* @param string $before String to use before the terms. * @param string $before String to use before the terms.
* @param string $sep String to use between the terms. * @param string $sep String to use between the terms.

View File

@ -440,7 +440,7 @@ class WP_Http {
* *
* @since 4.6.0 * @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. * @return Requests_Cookie_Jar Cookie holder object.
*/ */
public static function normalize_cookies( $cookies ) { public static function normalize_cookies( $cookies ) {

View File

@ -140,7 +140,7 @@ class Walker_Nav_Menu extends Walker {
$args = apply_filters( 'nav_menu_item_args', $args, $item, $depth ); $args = apply_filters( 'nav_menu_item_args', $args, $item, $depth );
/** /**
* 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 * @since 3.0.0
* @since 4.1.0 The `$depth` parameter was added. * @since 4.1.0 The `$depth` parameter was added.

View File

@ -339,7 +339,7 @@ class WP_Meta_Query {
* *
* @since 3.1.0 * @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 array $queries Array of meta queries.
* @param string $type Type of meta. * @param string $type Type of meta.
* @param string $primary_table Primary table. * @param string $primary_table Primary table.

View File

@ -97,7 +97,7 @@ class WP_Metadata_Lazyloader {
* *
* @since 4.5.0 * @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 string $object_type Type of object being queued.
* @param WP_Metadata_Lazyloader $lazyloader The lazy-loader object. * @param WP_Metadata_Lazyloader $lazyloader The lazy-loader object.
*/ */

View File

@ -140,7 +140,7 @@ class WP_Date_Query {
* } * }
* } * }
* } * }
* @param array $default_column Optional. Default column to query against. Default 'post_date'. * @param string $default_column Optional. Default column to query against. Default 'post_date'.
* Accepts 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt', * Accepts 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
* 'comment_date', 'comment_date_gmt'. * 'comment_date', 'comment_date_gmt'.
*/ */