<!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>[29163] trunk/src/wp-includes: Inline documentation cleanup for 4.0 audit.</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 { 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/29163">29163</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-07-14 01:01:22 +0000 (Mon, 14 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation cleanup for 4.0 audit.
Various improvements:
* Adds `@see` reference for `wp_list_comments()` in 'wp_list_comments_args' filter docs, added in <a href="http://core.trac.wordpress.org/changeset/28285">[28285]</a>
* Various phpDoc tweaks for the 'run_wptexturize' filter docs, added in <a href="http://core.trac.wordpress.org/changeset/28715">[28715]</a>
* Sentence and wrapping changes for `is_https_url()`, added in <a href="http://core.trac.wordpress.org/changeset/28894">[28894]</a>
* Documents the `$args` parameter for `wp_dropdown_languages()`, added in <a href="http://core.trac.wordpress.org/changeset/29007">[29007]</a>
* Adds a period to the parameter description for `_update_posts_count_on_delete()`, added in <a href="http://core.trac.wordpress.org/changeset/28835">[28835]</a>
* Documents a global in `is_customize_preview()`, added in <a href="http://core.trac.wordpress.org/changeset/28999">[28999]</a>
* phpDoc tweaks, adds an access modifier for `wpdb::esc_like()`, added in <a href="http://core.trac.wordpress.org/changeset/28711">[28711]</a>
See <a href="http://core.trac.wordpress.org/ticket/28885">#28885</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
<li><a href="#trunksrcwpincludesmsblogsphp">trunk/src/wp-includes/ms-blogs.php</a></li>
<li><a href="#trunksrcwpincludesthemephp">trunk/src/wp-includes/theme.php</a></li>
<li><a href="#trunksrcwpincludeswpdbphp">trunk/src/wp-includes/wp-db.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/comment-template.php (29162 => 29163)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/comment-template.php 2014-07-14 00:47:36 UTC (rev 29162)
+++ trunk/src/wp-includes/comment-template.php 2014-07-14 01:01:22 UTC (rev 29163)
</span><span class="lines">@@ -1940,6 +1940,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><span class="cx"> *
</span><ins>+ * @see wp_list_comments()
+ *
</ins><span class="cx"> * @param array $r An array of arguments for displaying comments.
</span><span class="cx"> */
</span><span class="cx"> $r = apply_filters( 'wp_list_comments_args', $r );
</span></span></pre></div>
<a id="trunksrcwpincludesformattingphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/formatting.php (29162 => 29163)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/formatting.php 2014-07-14 00:47:36 UTC (rev 29162)
+++ trunk/src/wp-includes/formatting.php 2014-07-14 01:01:22 UTC (rev 29163)
</span><span class="lines">@@ -40,16 +40,18 @@
</span><span class="cx"> // Set up static variables. Run once only.
</span><span class="cx"> if ( $reset || ! isset( $static_characters ) ) {
</span><span class="cx"> /**
</span><del>- * Filter whether to skip running `wptexturize()`.
</del><ins>+ * Filter whether to skip running wptexturize().
</ins><span class="cx"> *
</span><del>- * Passing false to the filter will effectively short-circuit `wptexturize()`.
</del><ins>+ * Passing false to the filter will effectively short-circuit wptexturize().
</ins><span class="cx"> * returning the original text passed to the function instead.
</span><span class="cx"> *
</span><del>- * The filter runs only once, the first time `wptexturize()` is called.
</del><ins>+ * The filter runs only once, the first time wptexturize() is called.
</ins><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><span class="cx"> *
</span><del>- * @param bool $run_texturize Whether to short-circuit `wptexturize()`.
</del><ins>+ * @see wptexturize()
+ *
+ * @param bool $run_texturize Whether to short-circuit wptexturize().
</ins><span class="cx"> */
</span><span class="cx"> $run_texturize = apply_filters( 'run_wptexturize', $run_texturize );
</span><span class="cx"> if ( false === $run_texturize ) {
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/functions.php (29162 => 29163)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/functions.php 2014-07-14 00:47:36 UTC (rev 29162)
+++ trunk/src/wp-includes/functions.php 2014-07-14 01:01:22 UTC (rev 29163)
</span><span class="lines">@@ -3506,8 +3506,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><span class="cx"> *
</span><del>- * @param string $url The URL
- * @return bool True if the given URL uses https, false if not (or if the URL is not valid).
</del><ins>+ * @param string $url The URL.
+ * @return bool True if the given URL uses https, false if not (or if the URL
+ * is not valid).
</ins><span class="cx"> */
</span><span class="cx"> function is_https_url( $url ) {
</span><span class="cx"> return ( 'https' === parse_url( $url, PHP_URL_SCHEME ) );
</span></span></pre></div>
<a id="trunksrcwpincludesl10nphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/l10n.php (29162 => 29163)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/l10n.php 2014-07-14 00:47:36 UTC (rev 29162)
+++ trunk/src/wp-includes/l10n.php 2014-07-14 01:01:22 UTC (rev 29163)
</span><span class="lines">@@ -821,6 +821,10 @@
</span><span class="cx"> * Language selector. More to come.
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ *
+ * @see get_available_languages()
+ *
+ * @param array $args Optional arguments. Default empty array.
</ins><span class="cx"> */
</span><span class="cx"> function wp_dropdown_languages( $args = array() ) {
</span><span class="cx"> if ( isset( $args['languages'] ) ) {
</span></span></pre></div>
<a id="trunksrcwpincludesmsblogsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/ms-blogs.php (29162 => 29163)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/ms-blogs.php 2014-07-14 00:47:36 UTC (rev 29162)
+++ trunk/src/wp-includes/ms-blogs.php 2014-07-14 01:01:22 UTC (rev 29163)
</span><span class="lines">@@ -910,7 +910,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0
</span><span class="cx"> *
</span><del>- * @param int $post_id Post ID
</del><ins>+ * @param int $post_id Post ID.
</ins><span class="cx"> */
</span><span class="cx"> function _update_posts_count_on_delete( $post_id ) {
</span><span class="cx"> if ( 'publish' !== get_post_field( 'post_status', $post_id ) ) {
</span></span></pre></div>
<a id="trunksrcwpincludesthemephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/theme.php (29162 => 29163)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/theme.php 2014-07-14 00:47:36 UTC (rev 29162)
+++ trunk/src/wp-includes/theme.php 2014-07-14 01:01:22 UTC (rev 29163)
</span><span class="lines">@@ -1947,6 +1947,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><span class="cx"> *
</span><ins>+ * @global WP_Customize_Manager $wp_customize Customizer instance.
+ *
</ins><span class="cx"> * @return bool True if the site is being previewed in the Customizer, false otherwise.
</span><span class="cx"> */
</span><span class="cx"> function is_customize_preview() {
</span></span></pre></div>
<a id="trunksrcwpincludeswpdbphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/wp-db.php (29162 => 29163)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/wp-db.php 2014-07-14 00:47:36 UTC (rev 29162)
+++ trunk/src/wp-includes/wp-db.php 2014-07-14 01:01:22 UTC (rev 29163)
</span><span class="lines">@@ -1188,11 +1188,14 @@
</span><span class="cx"> * $sql = esc_sql( $wpdb->esc_like( $input ) );
</span><span class="cx"> *
</span><span class="cx"> * @since 4.0.0
</span><ins>+ * @access public
</ins><span class="cx"> *
</span><del>- * @param string $text The raw text to be escaped. The input typed by the user should have no extra or deleted slashes.
- * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call prepare or real_escape next.
</del><ins>+ * @param string $text The raw text to be escaped. The input typed by the user should have no
+ * extra or deleted slashes.
+ * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call $wpdb::prepare()
+ * or real_escape next.
</ins><span class="cx"> */
</span><del>- function esc_like( $text ) {
</del><ins>+ public function esc_like( $text ) {
</ins><span class="cx"> return addcslashes( $text, '_%\\' );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>