Changeset 7561 for trunk/bp-groups/bp-groups-activity.php

Timestamp:

11/11/2013 02:24:01 AM (12 years ago)

Author:

boonebgorges

Message:

Improve inline docs in bp-groups component. See #5022

File:

• trunk/bp-groups/bp-groups-activity.php (modified) (3 diffs)

trunk/bp-groups/bp-groups-activity.php

@@ -14 +14 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Register activity actions for the Groups component.
+ */
 function groups_register_activity_actions() {
     global $bp;
@@ -36 +39 @@
 add_action( 'bp_register_activity_actions', 'groups_register_activity_actions' );
 
+/**
+ * Record an activity item related to the Groups component.
+ *
+ * A wrapper for {@link bp_activity_add()} that provides some Groups-specific
+ * defaults.
+ *
+ * @see bp_activity_add() for more detailed description of parameters and
+ *      return values.
+ *
+ * @param array $args {
+ *     An array of arguments for the new activity item. Accepts all parameters
+ *     of {@link bp_activity_add()}. However, this wrapper provides some
+ *     additional defaults, as described below:
+ *     @type string $component Default: the id of your Groups component
+ *           (usually 'groups').
+ *     @type bool $hide_sitewide Default: True if the current group is not
+ *           public, otherwise false.
+ * }
+ * @return bool See {@link bp_activity_add()}.
+ */
 function groups_record_activity( $args = '' ) {
     global $bp;
@@ -76 +99 @@
 }
 
+/**
+ * Update the last_activity meta value for a given group.
+ *
+ * @param int $group_id Optional. The ID of the group whose last_activity is
+ *        being updated. Default: the current group's ID.
+ */
 function groups_update_last_activity( $group_id = 0 ) {
     global $bp;