Changeset 9833 for trunk/src/bp-activity/bp-activity-actions.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-actions.php (modified) (12 diffs)

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

@@ -167 +167 @@
          *
          * @param int $activity_id The activity ID.
-         * @param int $user_id The user associated with the activity.
+         * @param int $user_id     The user associated with the activity.
          */
         do_action( 'bp_activity_before_action_delete_activity', $activity_id, $activity->user_id );
@@ -183 +183 @@
          *
          * @param int $activity_id The activity ID.
-         * @param int $user_id The user associated with the activity.
+         * @param int $user_id     The user associated with the activity.
          */
         do_action( 'bp_activity_action_delete_activity', $activity_id, $activity->user_id );
@@ -201 +201 @@
  *
  * @param int $activity_id Activity id to be deleted. Defaults to 0.
+ *
  * @return bool False on failure.
  */
@@ -235 +236 @@
          *
          * @param int    $activity_id Activity ID to be marked as spam.
-         * @param object $activity Activity object for the ID to be marked as spam.
+         * @param object $activity    Activity object for the ID to be marked as spam.
          */
         do_action( 'bp_activity_before_action_spam_activity', $activity->id, $activity );
@@ -252 +253 @@
          *
          * @param int $activity_id Activity ID that was marked as spam.
-         * @param int $user_id User ID associated with activity.
+         * @param int $user_id     User ID associated with activity.
          */
         do_action( 'bp_activity_action_spam_activity', $activity_id, $activity->user_id );
@@ -299 +300 @@
          * @since BuddyPress (1.2.0)
          *
-         * @param string $whats-new Activity message being posted.
+         * @param string $value Activity message being posted.
          */
         $content = apply_filters( 'bp_activity_post_update_content', $_POST['whats-new'] );
@@ -310 +311 @@
                  * @since BuddyPress (1.2.0)
                  *
-                 * @param string $whats-new-post-object Item type to associate with.
+                 * @param string $value Item type to associate with.
                  */
                 $object = apply_filters( 'bp_activity_post_update_object', $_POST['whats-new-post-object'] );
@@ -322 +323 @@
                  * @since BuddyPress (1.2.0)
                  *
-                 * @param string $whats-new-post-in Chosen component to post activity to.
+                 * @param string $value Chosen component to post activity to.
                  */
                 $item_id = apply_filters( 'bp_activity_post_update_item_id', $_POST['whats-new-post-in'] );
@@ -350 +351 @@
                  * @since BuddyPress (1.2.0)
                  *
-                 * @param string $object Activity item being associated to.
+                 * @param string $object  Activity item being associated to.
                  * @param string $item_id Component ID being posted to.
                  * @param string $content Activity content being posted.
@@ -399 +400 @@
          * @since BuddyPress (1.2.0)
          *
-         * @param string $comment_form_id ID of the activity being replied to.
+         * @param string $value ID of the activity being replied to.
          */
         $activity_id = apply_filters( 'bp_activity_post_comment_activity_id', $_POST['comment_form_id'] );
@@ -408 +409 @@
          * @since BuddyPress (1.2.0)
          *
-         * @param string $ac_input_activity_id Comment content being posted.
+         * @param string $value Comment content being posted.
          */
         $content = apply_filters( 'bp_activity_post_comment_content', $_POST['ac_input_' . $activity_id] );
@@ -729 +730 @@
          * @since BuddyPress (1.6.0)
          *
-         * @param bool bp_is_akismet_active Return value of bp_is_akismet_active boolean function.
+         * @param bool $value Return value of bp_is_akismet_active boolean function.
          */
         if ( ! apply_filters( 'bp_activity_use_akismet', bp_is_akismet_active() ) )