Docs: Miscellaneous docblock corrections.

See #48303

Built from https://develop.svn.wordpress.org/trunk@46610


git-svn-id: http://core.svn.wordpress.org/trunk@46407 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2019-10-28 19:48:01 +00:00
parent c08dbe5236
commit 057f661ce3
6 changed files with 23 additions and 22 deletions

View File

@ -127,6 +127,7 @@ class Core_Upgrader extends WP_Upgrader {
// WARNING: This may be removed in the future. // WARNING: This may be removed in the future.
if ( is_wp_error( $download ) && $download->get_error_data( 'softfail-filename' ) ) { if ( is_wp_error( $download ) && $download->get_error_data( 'softfail-filename' ) ) {
// Outout the failure error as a normal feedback, and not as an error: // Outout the failure error as a normal feedback, and not as an error:
/** This filter is documented in wp-admin/includes/update-core.php */
apply_filters( 'update_feedback', $download->get_error_message() ); apply_filters( 'update_feedback', $download->get_error_message() );
// Report this failure back to WordPress.org for debugging purposes. // Report this failure back to WordPress.org for debugging purposes.

View File

@ -501,13 +501,13 @@ class WP_List_Table {
} }
/** /**
* Generate row actions div * Generates the required HTML for a list of row action links.
* *
* @since 3.1.0 * @since 3.1.0
* *
* @param string[] $actions An array of action links. * @param string[] $actions An array of action links.
* @param bool $always_visible Whether the actions should be always visible. * @param bool $always_visible Whether the actions should be always visible.
* @return string * @return string The HTML for the row actions.
*/ */
protected function row_actions( $actions, $always_visible = false ) { protected function row_actions( $actions, $always_visible = false ) {
$action_count = count( $actions ); $action_count = count( $actions );
@ -531,14 +531,14 @@ class WP_List_Table {
} }
/** /**
* Display a monthly dropdown for filtering items * Displays a dropdown for filtering items in the list table by month.
* *
* @since 3.1.0 * @since 3.1.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Locale $wp_locale WordPress date and time locale object. * @global WP_Locale $wp_locale WordPress date and time locale object.
* *
* @param string $post_type * @param string $post_type The post type.
*/ */
protected function months_dropdown( $post_type ) { protected function months_dropdown( $post_type ) {
global $wpdb, $wp_locale; global $wpdb, $wp_locale;

View File

@ -2618,8 +2618,8 @@ function wp_ext2type( $ext ) {
* @return array { * @return array {
* Values for the extension and mime type. * Values for the extension and mime type.
* *
* @type string|false $0 File extension, or false if the file doesn't match a mime type. * @type string|false $ext File extension, or false if the file doesn't match a mime type.
* @type string|false $1 File mime type, or false if the file doesn't match a mime type. * @type string|false $type File mime type, or false if the file doesn't match a mime type.
* } * }
*/ */
function wp_check_filetype( $filename, $mimes = null ) { function wp_check_filetype( $filename, $mimes = null ) {
@ -2660,9 +2660,9 @@ function wp_check_filetype( $filename, $mimes = null ) {
* @return array { * @return array {
* Values for the extension, mime type, and corrected filename. * Values for the extension, mime type, and corrected filename.
* *
* @type string|false $0 File extension, or false if the file doesn't match a mime type. * @type string|false $ext File extension, or false if the file doesn't match a mime type.
* @type string|false $1 File mime type, or false if the file doesn't match a mime type. * @type string|false $type File mime type, or false if the file doesn't match a mime type.
* @type string|false $2 File name with its correct extension, or false if it cannot be determined. * @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
* } * }
*/ */
function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) { function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
@ -2822,9 +2822,9 @@ function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
* @param array $wp_check_filetype_and_ext { * @param array $wp_check_filetype_and_ext {
* Values for the extension, mime type, and corrected filename. * Values for the extension, mime type, and corrected filename.
* *
* @type string|false $0 File extension, or false if the file doesn't match a mime type. * @type string|false $ext File extension, or false if the file doesn't match a mime type.
* @type string|false $1 File mime type, or false if the file doesn't match a mime type. * @type string|false $type File mime type, or false if the file doesn't match a mime type.
* @type string|false $2 File name with its correct extension, or false if it cannot be determined. * @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
* } * }
* @param string $file Full path to the file. * @param string $file Full path to the file.
* @param string $filename The name of the file (may differ from $file due to * @param string $filename The name of the file (may differ from $file due to

View File

@ -419,8 +419,8 @@ function get_the_excerpt( $post = null ) {
* @since 1.2.0 * @since 1.2.0
* @since 4.5.0 Introduced the `$post` parameter. * @since 4.5.0 Introduced the `$post` parameter.
* *
* @param string $post_excerpt The post excerpt. * @param string $post_excerpt The post excerpt.
* @param WP_Post $post Post object. * @param WP_Post $post Post object.
*/ */
return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ); return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
} }

View File

@ -778,7 +778,7 @@ function wp_tinymce_inline_scripts() {
'wpview', 'wpview',
); );
/* This filter is documented in wp-includes/class-wp-editor.php */ /** This filter is documented in wp-includes/class-wp-editor.php */
$tinymce_plugins = apply_filters( 'tiny_mce_plugins', $tinymce_plugins, 'classic-block' ); $tinymce_plugins = apply_filters( 'tiny_mce_plugins', $tinymce_plugins, 'classic-block' );
$tinymce_plugins = array_unique( $tinymce_plugins ); $tinymce_plugins = array_unique( $tinymce_plugins );
@ -807,7 +807,7 @@ function wp_tinymce_inline_scripts() {
'wp_adv', 'wp_adv',
); );
/* This filter is documented in wp-includes/class-wp-editor.php */ /** This filter is documented in wp-includes/class-wp-editor.php */
$toolbar1 = apply_filters( 'mce_buttons', $toolbar1, 'classic-block' ); $toolbar1 = apply_filters( 'mce_buttons', $toolbar1, 'classic-block' );
$toolbar2 = array( $toolbar2 = array(
@ -824,13 +824,13 @@ function wp_tinymce_inline_scripts() {
'wp_help', 'wp_help',
); );
/* This filter is documented in wp-includes/class-wp-editor.php */ /** This filter is documented in wp-includes/class-wp-editor.php */
$toolbar2 = apply_filters( 'mce_buttons_2', $toolbar2, 'classic-block' ); $toolbar2 = apply_filters( 'mce_buttons_2', $toolbar2, 'classic-block' );
/* This filter is documented in wp-includes/class-wp-editor.php */ /** This filter is documented in wp-includes/class-wp-editor.php */
$toolbar3 = apply_filters( 'mce_buttons_3', array(), 'classic-block' ); $toolbar3 = apply_filters( 'mce_buttons_3', array(), 'classic-block' );
/* This filter is documented in wp-includes/class-wp-editor.php */ /** This filter is documented in wp-includes/class-wp-editor.php */
$toolbar4 = apply_filters( 'mce_buttons_4', array(), 'classic-block' ); $toolbar4 = apply_filters( 'mce_buttons_4', array(), 'classic-block' );
/* This filter is documented in wp-includes/class-wp-editor.php */ /** This filter is documented in wp-includes/class-wp-editor.php */
$external_plugins = apply_filters( 'mce_external_plugins', array(), 'classic-block' ); $external_plugins = apply_filters( 'mce_external_plugins', array(), 'classic-block' );
$tinymce_settings = array( $tinymce_settings = array(
@ -851,7 +851,7 @@ function wp_tinymce_inline_scripts() {
array_merge( $tinymce_settings, $editor_settings['tinymce'] ); array_merge( $tinymce_settings, $editor_settings['tinymce'] );
} }
/* This filter is documented in wp-includes/class-wp-editor.php */ /** This filter is documented in wp-includes/class-wp-editor.php */
$tinymce_settings = apply_filters( 'tiny_mce_before_init', $tinymce_settings, 'classic-block' ); $tinymce_settings = apply_filters( 'tiny_mce_before_init', $tinymce_settings, 'classic-block' );
// Do "by hand" translation from PHP array to js object. // Do "by hand" translation from PHP array to js object.

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.4-alpha-46609'; $wp_version = '5.4-alpha-46610';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.