<!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" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { 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 #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#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>
<title>[13210] trunk/wp-includes/functions.php:
  Some more phpdoc bits for functions.php.</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/13210">13210</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2010-02-19 01:08:39 +0000 (Fri, 19 Feb 2010)</dd>
</dl>

<h3>Log Message</h3>
<pre>Some more phpdoc bits for functions.php. Props miqrogroove, fixes <a href="http://trac.wordpress.org/ticket/12215">#12215</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesfunctionsphp">trunk/wp-includes/functions.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/functions.php (13209 => 13210)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/functions.php        2010-02-19 01:03:58 UTC (rev 13209)
+++ trunk/wp-includes/functions.php        2010-02-19 01:08:39 UTC (rev 13210)
</span><span class="lines">@@ -952,6 +952,8 @@
</span><span class="cx">  * @subpackage Option
</span><span class="cx">  * @since 2.8.0
</span><span class="cx">  *
</span><ins>+ * @param unknown $all
+ * @return bool
</ins><span class="cx">  */
</span><span class="cx"> function wp_set_all_user_settings($all) {
</span><span class="cx">         global $_updated_user_settings;
</span><span class="lines">@@ -1588,7 +1590,7 @@
</span><span class="cx">  *                parameters.
</span><span class="cx">  *
</span><span class="cx">  * @param int $header HTTP status code
</span><del>- * @return null Does not return anything.
</del><ins>+ * @return unknown
</ins><span class="cx">  */
</span><span class="cx"> function status_header( $header ) {
</span><span class="cx">         $text = get_status_header_desc( $header );
</span><span class="lines">@@ -3027,6 +3029,7 @@
</span><span class="cx">  *
</span><span class="cx">  * @since 2.5.0
</span><span class="cx">  *
</span><ins>+ * @param string $url
</ins><span class="cx">  * @return bool Whether or not SSL access is available
</span><span class="cx">  */
</span><span class="cx"> function url_is_accessable_via_ssl($url)
</span><span class="lines">@@ -3695,9 +3698,9 @@
</span><span class="cx">  *
</span><span class="cx">  * Overrides the gmt_offset option if we have a timezone_string available
</span><span class="cx">  *
</span><del>- * @since 2.8
</del><ins>+ * @since 2.8.0
</ins><span class="cx">  *
</span><del>- * @return unknown
</del><ins>+ * @return float|bool
</ins><span class="cx">  */
</span><span class="cx"> function wp_timezone_override_offset() {
</span><span class="cx">         if ( !wp_timezone_supported() ) {
</span><span class="lines">@@ -3718,9 +3721,9 @@
</span><span class="cx"> /**
</span><span class="cx">  * Check for PHP timezone support
</span><span class="cx">  *
</span><del>- * @since 2.9
</del><ins>+ * @since 2.9.0
</ins><span class="cx">  *
</span><del>- * @return unknown
</del><ins>+ * @return bool
</ins><span class="cx">  */
</span><span class="cx"> function wp_timezone_supported() {
</span><span class="cx">         $support = false;
</span><span class="lines">@@ -3738,11 +3741,11 @@
</span><span class="cx"> /**
</span><span class="cx">  * {@internal Missing Short Description}}
</span><span class="cx">  *
</span><del>- * @since 2.9
</del><ins>+ * @since 2.9.0
</ins><span class="cx">  *
</span><span class="cx">  * @param unknown_type $a
</span><span class="cx">  * @param unknown_type $b
</span><del>- * @return unknown
</del><ins>+ * @return int
</ins><span class="cx">  */
</span><span class="cx"> function _wp_timezone_choice_usort_callback( $a, $b ) {
</span><span class="cx">         // Don't use translated versions of Etc
</span><span class="lines">@@ -3785,7 +3788,7 @@
</span><span class="cx"> /**
</span><span class="cx">  * Gives a nicely formatted list of timezone strings // temporary! Not in final
</span><span class="cx">  *
</span><del>- * @since 2.9
</del><ins>+ * @since 2.9.0
</ins><span class="cx">  *
</span><span class="cx">  * @param string $selected_zone Selected Zone
</span><span class="cx">  * @return string
</span><span class="lines">@@ -3915,8 +3918,11 @@
</span><span class="cx">  * Strip close comment and close php tags from file headers used by WP
</span><span class="cx">  * See http://core.trac.wordpress.org/ticket/8497
</span><span class="cx">  *
</span><del>- * @since 2.8
-**/
</del><ins>+ * @since 2.8.0
+ *
+ * @param string $str
+ * @return string
+ */
</ins><span class="cx"> function _cleanup_header_comment($str) {
</span><span class="cx">         return trim(preg_replace(&quot;/\s*(?:\*\/|\?&gt;).*/&quot;, '', $str));
</span><span class="cx"> }
</span><span class="lines">@@ -3925,8 +3931,6 @@
</span><span class="cx">  * Permanently deletes posts, pages, attachments, and comments which have been in the trash for EMPTY_TRASH_DAYS.
</span><span class="cx">  *
</span><span class="cx">  * @since 2.9.0
</span><del>- *
- * @return void
</del><span class="cx">  */
</span><span class="cx"> function wp_scheduled_delete() {
</span><span class="cx">         global $wpdb;
</span><span class="lines">@@ -4033,6 +4037,9 @@
</span><span class="cx">  *
</span><span class="cx">  * @private
</span><span class="cx">  * @since 2.9.0
</span><ins>+ *
+ * @param string $t
+ * @return string
</ins><span class="cx">  */
</span><span class="cx"> function _search_terms_tidy($t) {
</span><span class="cx">         return trim($t, &quot;\&quot;'\n\r &quot;);
</span></span></pre>
</div>
</div>

</body>
</html>