<!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>[BuddyPress][7403] trunk/bp-activity: Fixes some incorrect documentation syntax</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://buddypress.trac.wordpress.org/changeset/7403">7403</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-08 20:58:25 +0000 (Tue, 08 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Fixes some incorrect documentation syntax
See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityclassesphp">trunk/bp-activity/bp-activity-classes.php</a></li>
<li><a href="#trunkbpactivitybpactivityfunctionsphp">trunk/bp-activity/bp-activity-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-classes.php (7402 => 7403)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-classes.php 2013-10-08 20:58:22 UTC (rev 7402)
+++ trunk/bp-activity/bp-activity-classes.php 2013-10-08 20:58:25 UTC (rev 7403)
</span><span class="lines">@@ -223,24 +223,27 @@
</span><span class="cx"> *
</span><span class="cx"> * @param array $args {
</span><span class="cx"> * An array of arguments. All items are optional.
</span><del>- * @int $page Which page of results to fetch. Using page=1 without
- * per_page will result in no pagination. Default: 1.
- * @int|bool $per_page Number of results per page. Default: 25.
- * @int|bool $max Maximum number of results to return.
- * Default: false (unlimited).
- * @string $sort ASC or DESC. Default: 'DESC'.
- * @array $exclude Array of activity IDs to exclude. Default: false.
- * @array $in Array of ids to limit query by (IN). Default: false.
- * @array $meta_query An array of meta_query conditions.
- * See WP_Meta_Query::queries for a description.
- * @array $filter See BP_Activity_Activity::get_filter_sql().
- * @string $search_terms Limit results by a search term.
- * Default: false.
- * @bool $display_comments Whether to include activity comments.
</del><ins>+ * @type int $page Which page of results to fetch. Using page=1
+ * without per_page will result in no pagination.
+ * Default: 1.
+ * @type int|bool $per_page Number of results per page. Default: 25.
+ * @type int|bool $max Maximum number of results to return.
+ * Default: false (unlimited).
+ * @type string $sort ASC or DESC. Default: 'DESC'.
+ * @type array $exclude Array of activity IDs to exclude.
+ * Default: false.
+ * @type array $in Array of ids to limit query by (IN).
+ * Default: false.
+ * @type array $meta_query An array of meta_query conditions.
+ * See WP_Meta_Query::queries for description.
+ * @type array $filter See BP_Activity_Activity::get_filter_sql().
+ * @type string $search_terms Limit results by a search term.
+ * Default: false.
+ * @type bool $display_comments Whether to include activity comments.
+ * Default: false.
+ * @type bool $show_hidden Whether to show items marked hide_sitewide.
</ins><span class="cx"> * Default: false.
</span><del>- * @bool $show_hidden Whether to show items marked hide_sitewide.
- * Default: false.
- * @string $spam Spam status. Default: 'ham_only'.
</del><ins>+ * @type string $spam Spam status. Default: 'ham_only'.
</ins><span class="cx"> * }
</span><span class="cx"> * @return array The array returned has two keys:
</span><span class="cx"> * - 'total' is the count of located activities
</span></span></pre></div>
<a id="trunkbpactivitybpactivityfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-functions.php (7402 => 7403)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-functions.php 2013-10-08 20:58:22 UTC (rev 7402)
+++ trunk/bp-activity/bp-activity-functions.php 2013-10-08 20:58:25 UTC (rev 7403)
</span><span class="lines">@@ -987,8 +987,8 @@
</span><span class="cx"> * @param array $args {
</span><span class="cx"> * All arguments and defaults are shared with BP_Activity_Activity::get(),
</span><span class="cx"> * except for the following:
</span><del>- * @string|int|array Single activity ID, comma-separated list of IDs, or
- * array of IDs.
</del><ins>+ * @type string|int|array Single activity ID, comma-separated list of IDs,
+ * or array of IDs.
</ins><span class="cx"> * }
</span><span class="cx"> * @return array $activity See BP_Activity_Activity::get() for description.
</span><span class="cx"> */
</span><span class="lines">@@ -1032,30 +1032,31 @@
</span><span class="cx"> *
</span><span class="cx"> * @param array $args {
</span><span class="cx"> * An array of arguments.
</span><del>- * @int|bool $id Pass an activity ID to update an existing item, or false
- * to create a new item. Default: false.
- * @string $action Optional. The activity action/description, typically
- * something like "Joe posted an update".
- * @string $content Optional. The content of the activity item.
- * @string $component The unique name of the component associated with the
- * activity item - 'groups', 'profile', etc.
- * @string $type The specific activity type, used for directory filtering.
- * 'new_blog_post', 'activity_update', etc.
- * @string $primary_link Optional. The URL for this item, as used in RSS
- * feeds. Defaults to the URL for this activity
- * item's permalink page.
- * @int|bool $user_id Optional. The ID of the user associated with the
- * activity item. May be set to false or 0 if the item
- * is not related to any user. Default: the ID of the
- * currently logged-in user.
- * @int $item_id Optional. The ID of the associated item.
- * @int $secondary_item_id Optional. The ID of a secondary associated item.
- * @string $date_recorded Optional. The GMT time, in Y-m-d h:i:s format,
- * when the item was recorded. Defaults to the
- * current time.
- * @bool $hide_sitewide Should the item be hidden on sitewide streams?
- * Default: false.
- * @bool $is_spam Should the item be marked as spam? Default: false.
</del><ins>+ * @type int|bool $id Pass an activity ID to update an existing item, or
+ * false to create a new item. Default: false.
+ * @type string $action Optional. The activity action/description, typically
+ * something like "Joe posted an update".
+ * @type string $content Optional. The content of the activity item.
+ * @type string $component The unique name of the component associated with
+ * the activity item - 'groups', 'profile', etc.
+ * @type string $type The specific activity type, used for directory
+ * filtering. 'new_blog_post', 'activity_update', etc.
+ * @type string $primary_link Optional. The URL for this item, as used in
+ * RSS feeds. Defaults to the URL for this
+ * activity item's permalink page.
+ * @type int|bool $user_id Optional. The ID of the user associated with the
+ * activity item. May be set to false or 0 if the
+ * item is not related to any user. Default: the ID
+ * of the currently logged-in user.
+ * @type int $item_id Optional. The ID of the associated item.
+ * @type int $secondary_item_id Optional. The ID of a secondary associated
+ * item.
+ * @type string $date_recorded Optional. The GMT time, in Y-m-d h:i:s format,
+ * when the item was recorded. Defaults to the
+ * current time.
+ * @type bool $hide_sitewide Should the item be hidden on sitewide streams?
+ * Default: false.
+ * @type bool $is_spam Should the item be marked as spam? Default: false.
</ins><span class="cx"> * }
</span><span class="cx"> * @return int|bool The ID of the activity on success. False on error.
</span><span class="cx"> */
</span><span class="lines">@@ -1133,8 +1134,8 @@
</span><span class="cx"> * @uses do_action() To call the 'bp_activity_posted_update' hook.
</span><span class="cx"> *
</span><span class="cx"> * @param array $args {
</span><del>- * @string $content The content of the activity update.
- * @int $user_id Optional. Defaults to the logged-in user.
</del><ins>+ * @type string $content The content of the activity update.
+ * @type int $user_id Optional. Defaults to the logged-in user.
</ins><span class="cx"> * }
</span><span class="cx"> * @return int $activity_id The activity id
</span><span class="cx"> */
</span><span class="lines">@@ -1195,15 +1196,15 @@
</span><span class="cx"> * @uses do_action() To call the 'bp_activity_comment_posted' hook.
</span><span class="cx"> *
</span><span class="cx"> * @param array $args {
</span><del>- * @int $id Optional. Pass an ID to update an existing comment.
- * @string $content The content of the comment.
- * @int $user_id Optional. The ID of the user making the comment. Defaults
- * to the ID of the logged-in user.
- * @int $activity_id The ID of the "root" activity item, ie the oldest
- * ancestor of the comment.
- * @int $parent_id Optional. The ID of the parent activity item, ie the
- * item to which the comment is an immediate reply. If
- * not provided, this value defaults to the $activity_id.
</del><ins>+ * @type int $id Optional. Pass an ID to update an existing comment.
+ * @type string $content The content of the comment.
+ * @type int $user_id Optional. The ID of the user making the comment.
+ * Defaults to the ID of the logged-in user.
+ * @type int $activity_id The ID of the "root" activity item, ie the oldest
+ * ancestor of the comment.
+ * @type int $parent_id Optional. The ID of the parent activity item, ie the
+ * item to which the comment is an immediate reply. If
+ * not provided, this value defaults to the $activity_id.
</ins><span class="cx"> * }
</span><span class="cx"> * @return int|bool The ID of the comment on success, otherwise false.
</span><span class="cx"> */
</span></span></pre>
</div>
</div>
</body>
</html>