Changeset 7403

Timestamp:

10/08/2013 08:58:25 PM (11 years ago)

Author:

boonebgorges

Message:

Fixes some incorrect documentation syntax

See #5022

Location:

trunk/bp-activity

Files:

• bp-activity-classes.php (modified) (1 diff)
• bp-activity-functions.php (modified) (4 diffs)

trunk/bp-activity/bp-activity-classes.php

@@ -224 +224 @@
      * @param array $args {
      *     An array of arguments. All items are optional.
-     *     @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.
+     *     @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.
      *                             Default: false.
-     *     @bool $show_hidden Whether to show items marked hide_sitewide.
-     *                        Default: false.
-     *     @string $spam Spam status. Default: 'ham_only'.
+     *     @type string $spam Spam status. Default: 'ham_only'.
      * }
      * @return array The array returned has two keys:

trunk/bp-activity/bp-activity-functions.php

@@ -988 +988 @@
  *     All arguments and defaults are shared with BP_Activity_Activity::get(),
  *     except for the following:
- *     @string|int|array Single activity ID, comma-separated list of IDs, or
- *                       array of IDs.
+ *     @type string|int|array Single activity ID, comma-separated list of IDs,
+ *                            or array of IDs.
  * }
  * @return array $activity See BP_Activity_Activity::get() for description.
@@ -1033 +1033 @@
  * @param array $args {
  *     An array of arguments.
- *     @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.
+ *     @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.
  * }
  * @return int|bool The ID of the activity on success. False on error.
@@ -1134 +1135 @@
  *
  * @param array $args {
- *     @string $content The content of the activity update.
- *     @int $user_id Optional. Defaults to the logged-in user.
+ *     @type string $content The content of the activity update.
+ *     @type int $user_id Optional. Defaults to the logged-in user.
  * }
  * @return int $activity_id The activity id
@@ -1196 +1197 @@
  *
  * @param array $args {
- *     @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.
+ *     @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.
  * }
  * @return int|bool The ID of the comment on success, otherwise false.