<!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>[21241] trunk/wp-includes: Bunch of PHPDoc corrections and cleanups.</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, #logmsg > ol { margin-left: 0; 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/21241">21241</a></dd>
<dt>Author</dt> <dd>markjaquith</dd>
<dt>Date</dt> <dd>2012-07-09 05:03:53 +0000 (Mon, 09 Jul 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Bunch of PHPDoc corrections and cleanups. props c3mdigital. props SergeyBiryukov. fixes <a href="http://core.trac.wordpress.org/ticket/21149">#21149</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesbookmarktemplatephp">trunk/wp-includes/bookmark-template.php</a></li>
<li><a href="#trunkwpincludesclasshttpphp">trunk/wp-includes/class-http.php</a></li>
<li><a href="#trunkwpincludesformattingphp">trunk/wp-includes/formatting.php</a></li>
<li><a href="#trunkwpincludesgeneraltemplatephp">trunk/wp-includes/general-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesbookmarktemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/bookmark-template.php (21240 => 21241)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/bookmark-template.php 2012-07-09 04:56:50 UTC (rev 21240)
+++ trunk/wp-includes/bookmark-template.php 2012-07-09 05:03:53 UTC (rev 21241)
</span><span class="lines">@@ -42,7 +42,6 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> * @access private
</span><del>- * @usedby wp_list_bookmarks()
</del><span class="cx"> *
</span><span class="cx"> * @param array $bookmarks List of bookmarks to traverse
</span><span class="cx"> * @param string|array $args Optional. Overwrite the defaults.
</span><span class="lines">@@ -189,7 +188,7 @@
</span><span class="cx"> * @link http://codex.wordpress.org/Template_Tags/wp_list_bookmarks
</span><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><del>- * @uses _list_bookmarks() Used to iterate over all of the bookmarks and return
</del><ins>+ * @uses _walk_bookmarks() Used to iterate over all of the bookmarks and return
</ins><span class="cx"> * the html
</span><span class="cx"> * @uses get_terms() Gets all of the categories that are for links.
</span><span class="cx"> *
</span></span></pre></div>
<a id="trunkwpincludesclasshttpphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/class-http.php (21240 => 21241)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/class-http.php 2012-07-09 04:56:50 UTC (rev 21240)
+++ trunk/wp-includes/class-http.php 2012-07-09 05:03:53 UTC (rev 21241)
</span><span class="lines">@@ -200,7 +200,7 @@
</span><span class="cx"> * @param array $args Request arguments
</span><span class="cx"> * @param string $url URL to Request
</span><span class="cx"> *
</span><del>- * @return string|false Class name for the first transport that claims to support the request. False if no transport claims to support the request.
</del><ins>+ * @return string|bool Class name for the first transport that claims to support the request. False if no transport claims to support the request.
</ins><span class="cx"> */
</span><span class="cx"> public function _get_first_available_transport( $args, $url = null ) {
</span><span class="cx"> $request_order = array( 'curl', 'streams', 'fsockopen' );
</span></span></pre></div>
<a id="trunkwpincludesformattingphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/formatting.php (21240 => 21241)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/formatting.php 2012-07-09 04:56:50 UTC (rev 21240)
+++ trunk/wp-includes/formatting.php 2012-07-09 05:03:53 UTC (rev 21241)
</span><span class="lines">@@ -100,7 +100,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Transform into regexp sub-expression used in _wptexturize_pushpop_element
</span><del>- // Must do this everytime in case plugins use these filters in a context sensitive manner
</del><ins>+ // Must do this every time in case plugins use these filters in a context sensitive manner
</ins><span class="cx"> $no_texturize_tags = '(' . implode('|', apply_filters('no_texturize_tags', $default_no_texturize_tags) ) . ')';
</span><span class="cx"> $no_texturize_shortcodes = '(' . implode('|', apply_filters('no_texturize_shortcodes', $default_no_texturize_shortcodes) ) . ')';
</span><span class="cx">
</span><span class="lines">@@ -141,8 +141,7 @@
</span><span class="cx"> * @param array $stack Array used as stack of opened tag elements
</span><span class="cx"> * @param string $disabled_elements Tags to match against formatted as regexp sub-expression
</span><span class="cx"> * @param string $opening Tag opening character, assumed to be 1 character long
</span><del>- * @param string $opening Tag closing character
- * @return object
</del><ins>+ * @param string $closing Tag closing character
</ins><span class="cx"> */
</span><span class="cx"> function _wptexturize_pushpop_element($text, &$stack, $disabled_elements, $opening = '<', $closing = '>') {
</span><span class="cx"> // Check if it is a closing tag -- otherwise assume opening tag
</span><span class="lines">@@ -264,7 +263,7 @@
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> * @access private
</span><span class="cx"> * @param array $matches preg_replace_callback matches array
</span><del>- * @returns string
</del><ins>+ * @return string
</ins><span class="cx"> */
</span><span class="cx"> function _autop_newline_preservation_helper( $matches ) {
</span><span class="cx"> return str_replace("\n", "<WPPreserveNewline />", $matches[0]);
</span><span class="lines">@@ -1009,7 +1008,7 @@
</span><span class="cx"> * @since 2.5.1
</span><span class="cx"> *
</span><span class="cx"> * @param string $orderby Order by string to be checked.
</span><del>- * @return string|false Returns the order by clause if it is a match, false otherwise.
</del><ins>+ * @return string|bool Returns the order by clause if it is a match, false otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function sanitize_sql_orderby( $orderby ){
</span><span class="cx"> preg_match('/^\s*([a-z0-9_]+(\s+(ASC|DESC))?(\s*,\s*|\s*$))+|^\s*RAND\(\s*\)\s*$/i', $orderby, $obmatches);
</span><span class="lines">@@ -1623,8 +1622,8 @@
</span><span class="cx"> * @since 3.4.0
</span><span class="cx"> * @access private
</span><span class="cx"> *
</span><del>- * @param string $string The string to split
- * @param int $goal The desired chunk length.
</del><ins>+ * @param string $string The string to split.
+ * @param int $goal The desired chunk length.
</ins><span class="cx"> * @return array Numeric array of chunks.
</span><span class="cx"> */
</span><span class="cx"> function _split_str_by_whitespace( $string, $goal ) {
</span><span class="lines">@@ -1822,7 +1821,6 @@
</span><span class="cx"> * Convert to ASCII from email subjects.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><del>- * @usedby wp_mail() handles charsets in email subjects
</del><span class="cx"> *
</span><span class="cx"> * @param string $string Subject line
</span><span class="cx"> * @return string Converted string to ASCII
</span><span class="lines">@@ -1839,11 +1837,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Helper function to convert hex encoded chars to ascii
</del><ins>+ * Helper function to convert hex encoded chars to ASCII
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> * @access private
</span><del>- * @param array $match the preg_replace_callback matches array
</del><ins>+ * @param array $match The preg_replace_callback matches array
+ * @return array Converted chars
</ins><span class="cx"> */
</span><span class="cx"> function _wp_iso_convert( $match ) {
</span><span class="cx"> return chr( hexdec( strtolower( $match[1] ) ) );
</span></span></pre></div>
<a id="trunkwpincludesgeneraltemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/general-template.php (21240 => 21241)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/general-template.php 2012-07-09 04:56:50 UTC (rev 21240)
+++ trunk/wp-includes/general-template.php 2012-07-09 05:03:53 UTC (rev 21241)
</span><span class="lines">@@ -1050,7 +1050,6 @@
</span><span class="cx"> * Get number of days since the start of the week.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><del>- * @usedby get_calendar()
</del><span class="cx"> *
</span><span class="cx"> * @param int $num Number of day.
</span><span class="cx"> * @return int Days since the start of the week.
</span><span class="lines">@@ -1067,6 +1066,7 @@
</span><span class="cx"> * no posts for the month, then it will not be displayed.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.0.0
</span><ins>+ * @uses calendar_week_mod()
</ins><span class="cx"> *
</span><span class="cx"> * @param bool $initial Optional, default is true. Use initial calendar names.
</span><span class="cx"> * @param bool $echo Optional, default is true. Set to false for return.
</span></span></pre>
</div>
</div>
</body>
</html>