<!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>[36250] trunk/src: Docs: Various docblock corrections.</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" 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/36250">36250</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/36250","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>2016-01-10 01:25:44 +0000 (Sun, 10 Jan 2016)</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 docblock corrections.
See <a href="https://core.trac.wordpress.org/ticket/32246">#32246</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmincustomheaderphp">trunk/src/wp-admin/custom-header.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpfilesystembasephp">trunk/src/wp-admin/includes/class-wp-filesystem-base.php</a></li>
<li><a href="#trunksrcwpadminincludesdashboardphp">trunk/src/wp-admin/includes/dashboard.php</a></li>
<li><a href="#trunksrcwpadminincludesschemaphp">trunk/src/wp-admin/includes/schema.php</a></li>
<li><a href="#trunksrcwpincludesclassfeedphp">trunk/src/wp-includes/class-feed.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcommentphp">trunk/src/wp-includes/class-wp-comment.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorphp">trunk/src/wp-includes/class-wp-image-editor.php</a></li>
<li><a href="#trunksrcwpincludesclasswptermphp">trunk/src/wp-includes/class-wp-term.php</a></li>
<li><a href="#trunksrcwpincludesclasswpthemephp">trunk/src/wp-includes/class-wp-theme.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmincustomheaderphp"></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/custom-header.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/custom-header.php 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-admin/custom-header.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,6 +261,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Random image option is on by default if no header has been set.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param string $type The header type. One of 'default' (for the Uploaded Images control)
+ * or 'uploaded' (for the Uploaded Images control).
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function show_header_selector( $type = 'default' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'default' == $type ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -969,15 +972,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Choose a header image, selected from existing uploaded and default headers,
</span><span class="cx" style="display: block; padding: 0 10px"> * or provide an array of uploaded header data (either new, or from media library).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.4.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $choice Which header image to select. Allows for values of 'random-default-image',
</span><span class="cx" style="display: block; padding: 0 10px"> * for randomly cycling among the default images; 'random-uploaded-image', for randomly cycling
</span><span class="cx" style="display: block; padding: 0 10px"> * among the uploaded images; the key of a default image registered for that theme; and
</span><span class="cx" style="display: block; padding: 0 10px"> * the key of an image uploaded for that theme (the basename of the URL).
</span><span class="cx" style="display: block; padding: 0 10px"> * Or an array of arguments: attachment_id, url, width, height. All are required.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
- * @since 3.4.0
- *
- * @param array|object|string $choice
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> final public function set_header_image( $choice ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $choice ) || is_object( $choice ) ) {
</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 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-admin/includes/class-wp-filesystem-base.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -705,6 +705,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @abstract
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $file Path to file.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether $file is writable.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function is_writable( $file ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesdashboardphp"></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/dashboard.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/dashboard.php 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-admin/includes/dashboard.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1144,6 +1144,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Display plugins text for the WordPress news widget.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param string $rss The RSS feed URL.
+ * @param array $args Array of arguments for this RSS feed.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_dashboard_plugins_output( $rss, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Plugin feeds plus link to install them
</span></span></pre></div>
<a id="trunksrcwpadminincludesschemaphp"></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/schema.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/schema.php 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-admin/includes/schema.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -888,7 +888,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global int $wp_db_version
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Rewrite $wp_rewrite
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $network_id ID of network to populate.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $network_id ID of network to populate.
+ * @param string $domain The domain name for the network (eg. "example.com").
+ * @param string $email Email address for the network administrator.
+ * @param string $site_name The name of the network.
+ * @param string $path Optional. The path to append to the network's domain name. Default '/'.
+ * @param bool $subdomain_install Optional. Whether the network is a subdomain install or a subdirectory install.
+ * Default false, meaning the network is a subdirectory install.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|WP_Error True on success, or WP_Error on warning (with the install otherwise successful,
</span><span class="cx" style="display: block; padding: 0 10px"> * so the error code must be checked) or failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludesclassfeedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-feed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-feed.php 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-includes/class-feed.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,6 +9,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @static
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param string $location URL location (scheme is used to determine handler).
+ * @param string $filename Unique identifier for cache object.
+ * @param string $extension 'spi' or 'spc'.
+ * @return WP_Feed_Cache_Transient Feed cache handler object that uses transients.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create($location, $filename, $extension) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Feed_Cache_Transient($location, $filename, $extension);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,6 +25,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $mod_name;
</span><span class="cx" style="display: block; padding: 0 10px"> public $lifetime = 43200; //Default lifetime in cache of 12 hours
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Class instantiator.
+ *
+ * @param string $location URL location (scheme is used to determine handler).
+ * @param string $filename Unique identifier for cache object.
+ * @param string $extension 'spi' or 'spc'.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function __construct($location, $filename, $extension) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->name = 'feed_' . $filename;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->mod_name = 'feed_mod_' . $filename;
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-comment.php 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-includes/class-wp-comment.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -350,6 +350,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * unneeded database queries.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param bool $set Whether the comment's children have already been populated.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function populated_children( $set ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->populated_children = (bool) $set;
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-image-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-image-editor.php 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-includes/class-wp-image-editor.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,6 +21,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Each instance handles a single file.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param string $file Path to the file to load.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $file ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->file = $file;
</span></span></pre></div>
<a id="trunksrcwpincludesclasswptermphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-term.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-term.php 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-includes/class-wp-term.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,7 +237,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $key Property to get.
+ * @return mixed Property value.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __get( $key ) {
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $key ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpthemephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-theme.php 2016-01-10 01:23:49 UTC (rev 36249)
+++ trunk/src/wp-includes/class-wp-theme.php 2016-01-10 01:25:44 UTC (rev 36250)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -350,7 +350,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * __get() magic method for properties formerly returned by current_theme_info()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $offset Property to get.
+ * @return mixed Property value.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __get( $offset ) {
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $offset ) {
</span></span></pre>
</div>
</div>
</body>
</html>