Commit 3a371631 authored by John Blackbourn's avatar John Blackbourn
Browse files

Docs: Another pass at some inline docs fixes mostly made by PHPCBF. 

See #49572, #50744
Built from https://develop.svn.wordpress.org/trunk@48590


git-svn-id: https://core.svn.wordpress.org/trunk@48352 1a063a9b-81f0-0310-95a4-ce76da25c4cd
parent 6a854456

wp-includes/class-wp-recovery-mode-email-service.php

+5 −3
Original line number Diff line number Diff line
@@ -41,7 +41,9 @@ final class WP_Recovery_Mode_Email_Service { 
	 *

	 * @param int   $rate_limit Number of seconds before another email can be sent.

	 * @param array $error      Error details from {@see error_get_last()}

	 * @param array $extension  The extension that caused the error. {

	 * @param array $extension {

	 *     The extension that caused the error.

	 *

	 *     @type string $slug The extension slug. The plugin or theme's directory.

	 *     @type string $type The extension type. Either 'plugin' or 'theme'.

	 * }

wp-includes/class-wp-recovery-mode.php

+4 −2
Original line number Diff line number Diff line
@@ -341,6 +341,8 @@ class WP_Recovery_Mode { 
	 *

	 * @param array $error Error that was triggered.

	 * @return array|false {

	 *     Extension details.

	 *

	 *     @type string $slug The extension slug. This is the plugin or theme's directory.

	 *     @type string $type The extension type. Either 'plugin' or 'theme'.

	 * }

wp-includes/class-wp-theme.php

+18 −18
Original line number Diff line number Diff line
@@ -1636,8 +1636,8 @@ final class WP_Theme implements ArrayAccess { 
	 *

	 * @since 3.4.0

	 *

	 * @param string $a First name.

	 * @param string $b Second name.

	 * @param WP_Theme $a First theme.

	 * @param WP_Theme $b Second theme.

	 * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.

	 *             Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().

	 */
@@ -1650,8 +1650,8 @@ final class WP_Theme implements ArrayAccess { 
	 *

	 * @since 3.4.0

	 *

	 * @param string $a First name.

	 * @param string $b Second name.

	 * @param WP_Theme $a First theme.

	 * @param WP_Theme $b Second theme.

	 * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.

	 *             Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().

	 */

wp-includes/comment.php

+23 −22
Original line number Diff line number Diff line
@@ -1063,6 +1063,7 @@ function get_comment_pages_count( $comments = null, $per_page = null, $threaded 
 * @param int   $comment_ID Comment ID.

 * @param array $args {

 *     Array of optional arguments.

 *

 *     @type string     $type      Limit paginated comments to those matching a given type.

 *                                 Accepts 'comment', 'trackback', 'pingback', 'pings'

 *                                 (trackbacks and pingbacks), or 'all'. Default 'all'.
@@ -3286,8 +3287,8 @@ function _close_comments_for_old_posts( $posts, $query ) { 
 * @since 2.7.0

 * @access private

 *

 * @param bool $open Comments open or closed

 * @param int $post_id Post ID

 * @param bool $open    Comments open or closed.

 * @param int  $post_id Post ID.

 * @return bool $open

 */

function _close_comments_for_old_post( $open, $post_id ) {

wp-includes/formatting.php

+6 −7
Original line number Diff line number Diff line
@@ -4923,7 +4923,6 @@ function map_deep( $value, $callback ) { 
/**

 * Parses a string into variables to be stored in an array.

 *

 *

 * @since 2.2.1

 *

 * @param string $string The string to be parsed.
@@ -5364,7 +5363,7 @@ function sanitize_textarea_field( $str ) { 
 * @access private

 *

 * @param string $str           String to sanitize.

 * @param bool $keep_newlines optional Whether to keep newlines. Default: false.

 * @param bool   $keep_newlines Optional. Whether to keep newlines. Default: false.

 * @return string Sanitized string.

 */

function _sanitize_text_fields( $str, $keep_newlines = false ) {