Changeset 9833 for trunk/src/bp-activity/bp-activity-admin.php

Timestamp:

05/03/2015 06:51:25 PM (11 years ago)

Author:

tw2113

Message:

First pass at cleanup of Activity component documetnation.

See #6396.

File:

• trunk/src/bp-activity/bp-activity-admin.php (modified) (13 diffs)

trunk/src/bp-activity/bp-activity-admin.php

@@ -53 +53 @@
  *
  * @param array $custom_menus The list of top-level BP menu items.
+ *
  * @return array $custom_menus List of top-level BP menu items, with Activity added
  */
@@ -139 +140 @@
  * @since BuddyPress (1.6.0)
  *
- * @param string $value Will always be false unless another plugin filters it
- *        first.
- * @param string $option Screen option name.
+ * @param string $value     Will always be false unless another plugin filters it first.
+ * @param string $option    Screen option name.
  * @param string $new_value Screen option form value.
+ *
  * @return string Option value. False to abandon update.
  */
@@ -162 +163 @@
  * @since BuddyPress (1.6.0)
  *
+ * @param array     $hidden Array of items to hide.
  * @param WP_Screen $screen Screen identifier.
+ *
  * @return array Hidden Meta Boxes.
  */
@@ -194 +197 @@
  * @since BuddyPress (1.6.0)
  *
- * @global object $bp BuddyPress global settings.
+ * @global object                 $bp                     BuddyPress global settings.
  * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
  */
@@ -412 +415 @@
                  * @since BuddyPress (1.6.0)
                  *
-                 * @param array  Array holding spam, not spam, deleted counts, error IDs.
-                 * @param string $redirect_to URL to redirect to.
+                 * @param array  $value        Array holding spam, not spam, deleted counts, error IDs.
+                 * @param string $redirect_to  URL to redirect to.
                  * @param array  $activity_ids Original array of activity IDs.
                  */
@@ -640 +643 @@
          * @since BuddyPress (1.6.0)
          *
-         * @param array Array holding single activity object.
+         * @param array $value Array holding single activity object that was passed by reference.
          */
         do_action_ref_array( 'bp_activity_admin_edit', array( &$activity ) ); ?>
@@ -889 +892 @@
  * @since BuddyPress (1.6.0)
  *
- * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list
- *         table.
- * @global string $plugin_page The current plugin page.
+ * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
+ * @global string                 $plugin_page            The current plugin page.
  */
 function bp_activity_admin_index() {
@@ -1289 +1291 @@
                          *
                          * @param string $url_base Current URL base for view.
-                         * @param string $view Current view being displayed.
+                         * @param string $view     Current view being displayed.
                          */
                         do_action( 'bp_activity_list_table_get_views', $url_base, $this->view ); ?>
@@ -1522 +1524 @@
                  *
                  * @param array $actions Array of available actions user could use.
-                 * @param array $item Current item being added to page.
+                 * @param array $item    Current item being added to page.
                  */
                 $actions = apply_filters( 'bp_activity_admin_comment_row_actions', array_filter( $actions ), $item );
@@ -1574 +1576 @@
                  * @since BuddyPress (1.6.0)
                  *
-                 * @param array Array of default activity types.
-                 * @param array $item Current item being displayed.
+                 * @param array $value Array of default activity types.
+                 * @param array $item  Current item being displayed.
                  */
                 if ( empty( $item['item_id'] ) || ! in_array( $item['type'], apply_filters( 'bp_activity_admin_root_activity_types', array( 'activity_comment' ), $item ) ) ) {
@@ -1606 +1608 @@
          *
          * @param int $activity_id Activity ID to retrieve User ID for.
+         *
          * @return int User ID of the activity item in question.
          */
@@ -1646 +1649 @@
          *
          * @param array $item An array version of the BP_Activity_Activity object.
+         *
          * @return bool
          */
@@ -1710 +1714 @@
          *
          * @param array $tree Source array.
+         *
          * @return array Flattened array.
          */