<!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>[12687] trunk/wp-includes/general-template.php: phpdoc updates.</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/12687">12687</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2010-01-10 15:50:17 +0000 (Sun, 10 Jan 2010)</dd>
</dl>

<h3>Log Message</h3>
<pre>phpdoc updates.  Props sirzooro. fixes <a href="http://trac.wordpress.org/ticket/11853">#11853</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesgeneraltemplatephp">trunk/wp-includes/general-template.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesgeneraltemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/general-template.php (12686 => 12687)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/general-template.php        2010-01-10 15:02:12 UTC (rev 12686)
+++ trunk/wp-includes/general-template.php        2010-01-10 15:50:17 UTC (rev 12687)
</span><span class="lines">@@ -1292,7 +1292,7 @@
</span><span class="cx">  *
</span><span class="cx">  * @since 1.5.0
</span><span class="cx">  *
</span><del>- * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
</del><ins>+ * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
</ins><span class="cx">  * @param int|object $post Optional post ID or object. Default is global $post object.
</span><span class="cx">  * @return string
</span><span class="cx">  */
</span><span class="lines">@@ -1311,8 +1311,8 @@
</span><span class="cx">  *
</span><span class="cx">  * @since 2.0.0
</span><span class="cx">  *
</span><del>- * @param string $d Either 'G', 'U', or php date format.
- * @param bool $gmt Whether of not to return the gmt time.
</del><ins>+ * @param string $d Optional Either 'G', 'U', or php date format.
+ * @param bool $gmt Optional, default is false. Whether of not to return the gmt time.
</ins><span class="cx">  * @param int|object $post Optional post ID or object. Default is global $post object.
</span><span class="cx">  * @param bool $translate Whether to translate the time string or not
</span><span class="cx">  * @return string
</span><span class="lines">@@ -1334,7 +1334,7 @@
</span><span class="cx">  *
</span><span class="cx">  * @since 2.0.0
</span><span class="cx">  *
</span><del>- * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
</del><ins>+ * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
</ins><span class="cx">  */
</span><span class="cx"> function the_modified_time($d = '') {
</span><span class="cx">         echo apply_filters('the_modified_time', get_the_modified_time($d), $d);
</span><span class="lines">@@ -1345,7 +1345,7 @@
</span><span class="cx">  *
</span><span class="cx">  * @since 2.0.0
</span><span class="cx">  *
</span><del>- * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
</del><ins>+ * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
</ins><span class="cx">  * @return string
</span><span class="cx">  */
</span><span class="cx"> function get_the_modified_time($d = '') {
</span><span class="lines">@@ -1361,10 +1361,10 @@
</span><span class="cx">  *
</span><span class="cx">  * @since 2.0.0
</span><span class="cx">  *
</span><del>- * @param string $d Either 'G', 'U', or php date format.
- * @param bool $gmt Whether of not to return the gmt time.
- * @param int|object $post A post_id or post object
- * @param bool translate Whether to translate the result or not
</del><ins>+ * @param string $d Optional, default is 'U'. Either 'G', 'U', or php date format.
+ * @param bool $gmt Optional, default is false. Whether of not to return the gmt time.
+ * @param int|object $post Optional, default is global post object. A post_id or post object
+ * @param bool $translate Optional, default is false. Whether to translate the result or not
</ins><span class="cx">  * @return string Returns timestamp
</span><span class="cx">  */
</span><span class="cx"> function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
</span><span class="lines">@@ -1401,8 +1401,8 @@
</span><span class="cx">  *
</span><span class="cx">  * @since 0.71
</span><span class="cx">  *
</span><del>- * @param string $before output before the date.
- * @param string $after output after the date.
</del><ins>+ * @param string $before Optional Output before the date.
+ * @param string $after Optional Output after the date.
</ins><span class="cx">   */
</span><span class="cx"> function the_weekday_date($before='',$after='') {
</span><span class="cx">         global $wp_locale, $post, $day, $previousweekday;
</span><span class="lines">@@ -1442,7 +1442,7 @@
</span><span class="cx">  *
</span><span class="cx">  * @since 2.8.0
</span><span class="cx">  *
</span><del>- * @param boolean $add Add or remove links. Defaults to true.
</del><ins>+ * @param boolean $add Optional, default is true. Add or remove links. Defaults to true.
</ins><span class="cx">  */
</span><span class="cx"> function automatic_feed_links( $add = true ) {
</span><span class="cx">         if ( $add )
</span><span class="lines">@@ -1460,7 +1460,7 @@
</span><span class="cx">  *
</span><span class="cx">  * @param array $args Optional arguments.
</span><span class="cx">  */
</span><del>-function feed_links( $args ) {
</del><ins>+function feed_links( $args = array() ) {
</ins><span class="cx">         $defaults = array(
</span><span class="cx">                 /* translators: Separator between blog name and feed type in feed links */
</span><span class="cx">                 'separator'        =&gt; _x('&amp;raquo;', 'feed link'),
</span><span class="lines">@@ -1483,7 +1483,7 @@
</span><span class="cx">  *
</span><span class="cx">  * @param array $args Optional arguments.
</span><span class="cx">  */
</span><del>-function feed_links_extra( $args ) {
</del><ins>+function feed_links_extra( $args = array() ) {
</ins><span class="cx">         $defaults = array(
</span><span class="cx">                 /* translators: Separator between blog name and feed type in feed links */
</span><span class="cx">                 'separator'   =&gt; _x('&amp;raquo;', 'feed link'),
</span><span class="lines">@@ -1643,8 +1643,8 @@
</span><span class="cx">  * @since 2.1.0
</span><span class="cx">  *
</span><span class="cx">  * @param string $content Textarea content.
</span><del>- * @param string $id HTML ID attribute value.
- * @param string $prev_id HTML ID name for switching back and forth between visual editors.
</del><ins>+ * @param string $id Optional, default is 'content'. HTML ID attribute value.
+ * @param string $prev_id Optional, default is 'title'. HTML ID name for switching back and forth between visual editors.
</ins><span class="cx">  * @param bool $media_buttons Optional, default is true. Whether to display media buttons.
</span><span class="cx">  * @param int $tab_index Optional, default is 2. Tabindex for textarea element.
</span><span class="cx">  */
</span><span class="lines">@@ -1903,7 +1903,7 @@
</span><span class="cx">  * @param string $key The unique key for this theme.
</span><span class="cx">  * @param string $name The name of the theme.
</span><span class="cx">  * @param string $url The url of the css file containing the colour scheme.
</span><del>- * @param array @colors An array of CSS color definitions which are used to give the user a feel for the theme.
</del><ins>+ * @param array @colors Optional An array of CSS color definitions which are used to give the user a feel for the theme.
</ins><span class="cx">  */
</span><span class="cx"> function wp_admin_css_color($key, $name, $url, $colors = array()) {
</span><span class="cx">         global $_wp_admin_css_colors;
</span></span></pre>
</div>
</div>

</body>
</html>