<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[46610] trunk/src: Docs: Miscellaneous docblock corrections.</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/46610">46610</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/46610","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-10-28 19:46:13 +0000 (Mon, 28 Oct 2019)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Miscellaneous docblock corrections.

See <a href="https://core.trac.wordpress.org/ticket/48303">#48303</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasscoreupgraderphp">trunk/src/wp-admin/includes/class-core-upgrader.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswplisttablephp">trunk/src/wp-admin/includes/class-wp-list-table.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesposttemplatephp">trunk/src/wp-includes/post-template.php</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasscoreupgraderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-core-upgrader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-core-upgrader.php       2019-10-28 19:33:24 UTC (rev 46609)
+++ trunk/src/wp-admin/includes/class-core-upgrader.php 2019-10-28 19:46:13 UTC (rev 46610)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,6 +127,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                // WARNING: This may be removed in the future.
</span><span class="cx" style="display: block; padding: 0 10px">                if ( is_wp_error( $download ) && $download->get_error_data( 'softfail-filename' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        // Outout the failure error as a normal feedback, and not as an error:
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                        /** This filter is documented in wp-admin/includes/update-core.php */
</ins><span class="cx" style="display: block; padding: 0 10px">                         apply_filters( 'update_feedback', $download->get_error_message() );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                        // Report this failure back to WordPress.org for debugging purposes.
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswplisttablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-list-table.php       2019-10-28 19:33:24 UTC (rev 46609)
+++ trunk/src/wp-admin/includes/class-wp-list-table.php 2019-10-28 19:46:13 UTC (rev 46610)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -501,13 +501,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Generate row actions div
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * Generates the required HTML for a list of row action links.
</ins><span class="cx" style="display: block; padding: 0 10px">          *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string[] $actions        An array of action links.
</span><span class="cx" style="display: block; padding: 0 10px">         * @param bool     $always_visible Whether the actions should be always visible.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @return string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return string The HTML for the row actions.
</ins><span class="cx" style="display: block; padding: 0 10px">          */
</span><span class="cx" style="display: block; padding: 0 10px">        protected function row_actions( $actions, $always_visible = false ) {
</span><span class="cx" style="display: block; padding: 0 10px">                $action_count = count( $actions );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -531,7 +531,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Display a monthly dropdown for filtering items
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * Displays a dropdown for filtering items in the list table by month.
</ins><span class="cx" style="display: block; padding: 0 10px">          *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -538,7 +538,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * @global wpdb      $wpdb      WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px">         * @global WP_Locale $wp_locale WordPress date and time locale object.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param string $post_type
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string $post_type The post type.
</ins><span class="cx" style="display: block; padding: 0 10px">          */
</span><span class="cx" style="display: block; padding: 0 10px">        protected function months_dropdown( $post_type ) {
</span><span class="cx" style="display: block; padding: 0 10px">                global $wpdb, $wp_locale;
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php       2019-10-28 19:33:24 UTC (rev 46609)
+++ trunk/src/wp-includes/functions.php 2019-10-28 19:46:13 UTC (rev 46610)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2618,8 +2618,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">  * @return array {
</span><span class="cx" style="display: block; padding: 0 10px">  *     Values for the extension and mime type.
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *     @type string|false $0 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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *     @type string|false $ext  File extension, 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.
</ins><span class="cx" style="display: block; padding: 0 10px">  * }
</span><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_check_filetype( $filename, $mimes = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2660,9 +2660,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">  * @return array {
</span><span class="cx" style="display: block; padding: 0 10px">  *     Values for the extension, mime type, and corrected filename.
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *     @type string|false $0 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 $2 File name with its correct extension, or false if it cannot be determined.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *     @type string|false $ext             File extension, 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 $proper_filename File name with its correct extension, or false if it cannot be determined.
</ins><span class="cx" style="display: block; padding: 0 10px">  * }
</span><span class="cx" style="display: block; padding: 0 10px">  */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2822,9 +2822,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * @param array       $wp_check_filetype_and_ext {
</span><span class="cx" style="display: block; padding: 0 10px">         *     Values for the extension, mime type, and corrected filename.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *     @type string|false $0 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 $2 File name with its correct extension, or false if it cannot be determined.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *     @type string|false $ext             File extension, 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 $proper_filename File name with its correct extension, or false if it cannot be determined.
</ins><span class="cx" style="display: block; padding: 0 10px">          * }
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string      $file                      Full path to the file.
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string      $filename                  The name of the file (may differ from $file due to
</span></span></pre></div>
<a id="trunksrcwpincludesposttemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/post-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post-template.php   2019-10-28 19:33:24 UTC (rev 46609)
+++ trunk/src/wp-includes/post-template.php     2019-10-28 19:46:13 UTC (rev 46610)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -419,8 +419,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.5.0 Introduced the `$post` parameter.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param string $post_excerpt The post excerpt.
-        * @param WP_Post $post Post object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string  $post_excerpt The post excerpt.
+        * @param WP_Post $post         Post object.
</ins><span class="cx" style="display: block; padding: 0 10px">          */
</span><span class="cx" style="display: block; padding: 0 10px">        return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesscriptloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php   2019-10-28 19:33:24 UTC (rev 46609)
+++ trunk/src/wp-includes/script-loader.php     2019-10-28 19:46:13 UTC (rev 46610)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -778,7 +778,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                'wpview',
</span><span class="cx" style="display: block; padding: 0 10px">        );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /* This filter is documented in wp-includes/class-wp-editor.php */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/class-wp-editor.php */
</ins><span class="cx" style="display: block; padding: 0 10px">         $tinymce_plugins = apply_filters( 'tiny_mce_plugins', $tinymce_plugins, 'classic-block' );
</span><span class="cx" style="display: block; padding: 0 10px">        $tinymce_plugins = array_unique( $tinymce_plugins );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -807,7 +807,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                'wp_adv',
</span><span class="cx" style="display: block; padding: 0 10px">        );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /* This filter is documented in wp-includes/class-wp-editor.php */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/class-wp-editor.php */
</ins><span class="cx" style="display: block; padding: 0 10px">         $toolbar1 = apply_filters( 'mce_buttons', $toolbar1, 'classic-block' );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        $toolbar2 = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -824,13 +824,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">                'wp_help',
</span><span class="cx" style="display: block; padding: 0 10px">        );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /* This filter is documented in wp-includes/class-wp-editor.php */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/class-wp-editor.php */
</ins><span class="cx" style="display: block; padding: 0 10px">         $toolbar2 = apply_filters( 'mce_buttons_2', $toolbar2, 'classic-block' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /* This filter is documented in wp-includes/class-wp-editor.php */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/class-wp-editor.php */
</ins><span class="cx" style="display: block; padding: 0 10px">         $toolbar3 = apply_filters( 'mce_buttons_3', array(), 'classic-block' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /* This filter is documented in wp-includes/class-wp-editor.php */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/class-wp-editor.php */
</ins><span class="cx" style="display: block; padding: 0 10px">         $toolbar4 = apply_filters( 'mce_buttons_4', array(), 'classic-block' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /* This filter is documented in wp-includes/class-wp-editor.php */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/class-wp-editor.php */
</ins><span class="cx" style="display: block; padding: 0 10px">         $external_plugins = apply_filters( 'mce_external_plugins', array(), 'classic-block' );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        $tinymce_settings = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -851,7 +851,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                array_merge( $tinymce_settings, $editor_settings['tinymce'] );
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /* This filter is documented in wp-includes/class-wp-editor.php */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/class-wp-editor.php */
</ins><span class="cx" style="display: block; padding: 0 10px">         $tinymce_settings = apply_filters( 'tiny_mce_before_init', $tinymce_settings, 'classic-block' );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        // Do "by hand" translation from PHP array to js object.
</span></span></pre>
</div>
</div>

</body>
</html>