Commit a7f58974 authored by John Blackbourn's avatar John Blackbourn
Browse files

Docs: Various formatting improvements to inline docblocks. 

See #49572
Built from https://develop.svn.wordpress.org/trunk@48574


git-svn-id: https://core.svn.wordpress.org/trunk@48336 1a063a9b-81f0-0310-95a4-ce76da25c4cd
parent 9e37e38a

wp-admin/includes/class-wp-screen.php

+3 −3
Original line number Diff line number Diff line
@@ -496,7 +496,7 @@ final class WP_Screen { 
	 *

	 * @since 3.3.0

	 *

	 * @param string $option Option ID

	 * @param string $option Option ID.

	 * @param mixed  $args   Option-dependent arguments.

	 */

	public function add_option( $option, $args = array() ) {

wp-admin/includes/image.php

+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ 
 */



/**

 * Crop an Image to a given size.

 * Crops an image to a given size.

 *

 * @since 2.1.0

 *

wp-admin/includes/post.php

+5 −5
Original line number Diff line number Diff line
@@ -1505,13 +1505,13 @@ function get_sample_permalink_html( $id, $new_title = null, $new_slug = null ) { 
}



/**

 * Output HTML for the post thumbnail meta-box.

 * Returns HTML for the post thumbnail meta box.

 *

 * @since 2.9.0

 *

 * @param int         $thumbnail_id ID of the attachment used for thumbnail

 * @param int|WP_Post $post         Optional. The post ID or object associated with the thumbnail, defaults to global $post.

 * @return string html

 * @return string The post thumbnail HTML.

 */

function _wp_post_thumbnail_html( $thumbnail_id = null, $post = null ) {

	$_wp_additional_image_sizes = wp_get_additional_image_sizes();

wp-admin/includes/template.php

+2 −2
Original line number Diff line number Diff line
@@ -1795,8 +1795,8 @@ function add_settings_error( $setting, $code, $message, $type = 'error' ) { 
 *

 * @global array $wp_settings_errors Storage array of errors registered during this pageload

 *

 * @param string $setting Optional slug title of a specific setting whose errors you want.

 * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.

 * @param string $setting  Optional. Slug title of a specific setting whose errors you want.

 * @param bool   $sanitize Optional. Whether to re-sanitize the setting value before returning errors.

 * @return array Array of settings errors.

 */

function get_settings_errors( $setting = '', $sanitize = false ) {

wp-admin/users.php

+2 −2
Original line number Diff line number Diff line
@@ -247,7 +247,7 @@ switch ( $wp_list_table->current_action() ) { 
		 *

		 * @since 5.2.0

		 *

		 * @param boolean $users_have_additional_content Whether the users have additional content. Default false.

		 * @param bool  $users_have_additional_content Whether the users have additional content. Default false.

		 * @param int[] $userids                       Array of IDs for users being deleted.

		 */

		$users_have_content = (bool) apply_filters( 'users_have_additional_content', false, $userids );