<!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>[57644] trunk/src: Docs: Various improvements and corrections to inline documentation.</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/57644">57644</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/57644","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>2024-02-16 21:45:18 +0000 (Fri, 16 Feb 2024)</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: Various improvements and corrections to inline documentation.

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

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpadminincludesclasswpapplicationpasswordslisttablephp">trunk/src/wp-admin/includes/class-wp-application-passwords-list-table.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpcommentslisttablephp">trunk/src/wp-admin/includes/class-wp-comments-list-table.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpfilesystembasephp">trunk/src/wp-admin/includes/class-wp-filesystem-base.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpfilesystemdirectphp">trunk/src/wp-admin/includes/class-wp-filesystem-direct.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpfilesystemftpextphp">trunk/src/wp-admin/includes/class-wp-filesystem-ftpext.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpfilesystemftpsocketsphp">trunk/src/wp-admin/includes/class-wp-filesystem-ftpsockets.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpfilesystemssh2php">trunk/src/wp-admin/includes/class-wp-filesystem-ssh2.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswplisttablephp">trunk/src/wp-admin/includes/class-wp-list-table.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpmssiteslisttablephp">trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php</a></li>

<li><a href="#trunksrcwpadminincludespluginphp">trunk/src/wp-admin/includes/plugin.php</a></li>

<li><a href="#trunksrcwpadminincludesrevisionphp">trunk/src/wp-admin/includes/revision.php</a></li>

<li><a href="#trunksrcwpadminincludesthemephp">trunk/src/wp-admin/includes/theme.php</a></li>

<li><a href="#trunksrcwpadminincludesupdatephp">trunk/src/wp-admin/includes/update.php</a></li>

<li><a href="#trunksrcwpincludesblocktemplateutilsphp">trunk/src/wp-includes/block-template-utils.php</a></li>

<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>

<li><a href="#trunksrcwpincludesclasswpcustomizenavmenusphp">trunk/src/wp-includes/class-wp-customize-nav-menus.php</a></li>

<li><a href="#trunksrcwpincludesclasswpdatequeryphp">trunk/src/wp-includes/class-wp-date-query.php</a></li>

<li><a href="#trunksrcwpincludesclasswphttpphp">trunk/src/wp-includes/class-wp-http.php</a></li>

<li><a href="#trunksrcwpincludesclasswppausedextensionsstoragephp">trunk/src/wp-includes/class-wp-paused-extensions-storage.php</a></li>

<li><a href="#trunksrcwpincludesclasswpscriptmodulesphp">trunk/src/wp-includes/class-wp-script-modules.php</a></li>

<li><a href="#trunksrcwpincludesclasswpsitequeryphp">trunk/src/wp-includes/class-wp-site-query.php</a></li>

<li><a href="#trunksrcwpincludesclasswptaxqueryphp">trunk/src/wp-includes/class-wp-tax-query.php</a></li>

<li><a href="#trunksrcwpincludesclasswpuserphp">trunk/src/wp-includes/class-wp-user.php</a></li>

<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>

<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>

<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>

<li><a href="#trunksrcwpincludesscriptmodulesphp">trunk/src/wp-includes/script-modules.php</a></li>

<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpadminincludesclasswpapplicationpasswordslisttablephp"></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-application-passwords-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-application-passwords-list-table.php 2024-02-16 21:33:02 UTC (rev 57643)

+++ trunk/src/wp-admin/includes/class-wp-application-passwords-list-table.php   2024-02-16 21:45:18 UTC (rev 57644)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -146,7 +146,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 5.6.0

</span><span class="cx" style="display: block; padding: 0 10px">         *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param string $which The location of the bulk actions: 'top' or 'bottom'.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string $which The location of the bulk actions: Either 'top' or 'bottom'.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        protected function display_tablenav( $which ) {

</span><span class="cx" style="display: block; padding: 0 10px">                ?>

</span></span></pre></div>

<a id="trunksrcwpadminincludesclasswpcommentslisttablephp"></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-comments-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-comments-list-table.php      2024-02-16 21:33:02 UTC (rev 57643)

+++ trunk/src/wp-admin/includes/class-wp-comments-list-table.php        2024-02-16 21:45:18 UTC (rev 57644)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -437,7 +437,7 @@

<span class="cx" style="display: block; padding: 0 10px">                 * @since 5.6.0 The `$which` parameter was added.

</span><span class="cx" style="display: block; padding: 0 10px">                 *

<span class="cx" style="display: block; padding: 0 10px">                 * @param string $comment_status The comment status name. Default 'All'.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 * @param string $which          The location of the extra table nav markup: 'top' or 'bottom'.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          * @param string $which          The location of the extra table nav markup: Either 'top' or 'bottom'.

</ins><span class="cx" style="display: block; padding: 0 10px">                  */

</span><span class="cx" style="display: block; padding: 0 10px">                do_action( 'manage_comments_nav', $comment_status, $which );

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span></span></pre></div>

<a id="trunksrcwpadminincludesclasswpfilesystembasephp"></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-filesystem-base.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-filesystem-base.php  2024-02-16 21:33:02 UTC (rev 57643)

+++ trunk/src/wp-admin/includes/class-wp-filesystem-base.php    2024-02-16 21:45:18 UTC (rev 57644)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -836,7 +836,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         * @return array|false {

<span class="cx" style="display: block; padding: 0 10px">         *     Array of arrays containing file information. False if unable to list directory contents.

</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 array $0... {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  *     @type array ...$0 {

</ins><span class="cx" style="display: block; padding: 0 10px">          *         Array of file information. Note that some elements may not be available on all filesystems.

</span><span class="cx" style="display: block; padding: 0 10px">         *