Changeset 9834 for trunk/src/bp-activity/classes/class-bp-activity-activity.php

Timestamp:

05/03/2015 10:51:31 PM (11 years ago)

Author:

tw2113

Message:

Punctuation is a key element to complete sentences.

See #6396.

File:

• trunk/src/bp-activity/classes/class-bp-activity-activity.php (modified) (11 diffs)

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

@@ -72 +72 @@
 
         /**
-         * Description of the activity, eg 'Alex updated his profile.'
+         * Description of the activity, eg 'Alex updated his profile.'.
          *
          * @var string
@@ -259 +259 @@
 
         /**
-         * Get activity items, as specified by parameters
+         * Get activity items, as specified by parameters.
          *
          * @see BP_Activity_Activity::get_filter_sql() for a description of the
@@ -859 +859 @@
          * @since BuddyPress (2.2.0)
          *
-         * @param  mixed $scope  The activity scope. Accepts string or array of scopes
+         * @param  mixed $scope  The activity scope. Accepts string or array of scopes.
          * @param  array $r      Current activity arguments. Same as those of BP_Activity_Activity::get(),
          *                       but merged with defaults.
          *
-         * @return array 'sql' WHERE SQL string and 'override' activity args
+         * @return array 'sql' WHERE SQL string and 'override' activity args.
          */
         public static function get_scope_query_sql( $scope = false, $r = array() ) {
@@ -917 +917 @@
                          *     @type array $override Optional. Override existing activity arguments passed by $r.
                          * }
-                         * @param array $r Current activity arguments passed in BP_Activity_Activity::get()
+                         * @param array $r Current activity arguments passed in BP_Activity_Activity::get().
                          */
                         $scope_args = apply_filters( "bp_activity_set_{$scope}_scope_args", array(), $r );
@@ -964 +964 @@
          * @deprecated Use BP_Activity_Activity::get() with an 'in' parameter instead.
          *
-         * @param mixed    $activity_ids     Array or comma-separated string of activity IDs to retrieve
-         * @param int|bool $max              Maximum number of results to return. (Optional; default is no maximum)
-         * @param int      $page             The set of results that the user is viewing. Used in pagination. (Optional; default is 1)
-         * @param int      $per_page         Specifies how many results per page. Used in pagination. (Optional; default is 25)
-         * @param string   $sort             MySQL column sort; ASC or DESC. (Optional; default is DESC)
-         * @param bool     $display_comments Retrieve an activity item's associated comments or not. (Optional; default is false)
+         * @param mixed    $activity_ids     Array or comma-separated string of activity IDs to retrieve.
+         * @param int|bool $max              Maximum number of results to return. (Optional; default is no maximum).
+         * @param int      $page             The set of results that the user is viewing. Used in pagination. (Optional; default is 1).
+         * @param int      $per_page         Specifies how many results per page. Used in pagination. (Optional; default is 25).
+         * @param string   $sort             MySQL column sort; ASC or DESC. (Optional; default is DESC).
+         * @param bool     $display_comments Retrieve an activity item's associated comments or not. (Optional; default is false).
+         *
          * @return array
          */
@@ -980 +981 @@
          * Get the first activity ID that matches a set of criteria.
          *
-         * @param int    $user_id           User ID to filter by
-         * @param string $component         Component to filter by
-         * @param string $type              Activity type to filter by
-         * @param int    $item_id           Associated item to filter by
-         * @param int    $secondary_item_id Secondary associated item to filter by
-         * @param string $action            Action to filter by
-         * @param string $content           Content to filter by
-         * @param string $date_recorded     Date to filter by
+         * @param int    $user_id           User ID to filter by.
+         * @param string $component         Component to filter by.
+         * @param string $type              Activity type to filter by.
+         * @param int    $item_id           Associated item to filter by.
+         * @param int    $secondary_item_id Secondary associated item to filter by.
+         * @param string $action            Action to filter by.
+         * @param string $content           Content to filter by.
+         * @param string $date_recorded     Date to filter by.
          *
          * @todo Should parameters be optional?
@@ -1152 +1153 @@
 
                 /**
-                 * Action to allow intercepting activity items to be deleted
+                 * Action to allow intercepting activity items to be deleted.
                  *
                  * @since BuddyPress (2.3.0)
                  *
-                 * @param array $activities Array of activities
-                 * @param array $r          Array of parsed arguments
+                 * @param array $activities Array of activities.
+                 * @param array $r          Array of parsed arguments.
                  */
                 do_action_ref_array( 'bp_activity_before_delete', array( $activities, $r ) );
@@ -1170 +1171 @@
 
                 /**
-                 * Action to allow intercepting activity items just deleted
+                 * Action to allow intercepting activity items just deleted.
                  *
                  * @since BuddyPress (2.3.0)
                  *
-                 * @param array $activities Array of activities
-                 * @param array $r          Array of parsed arguments
+                 * @param array $activities Array of activities.
+                 * @param array $r          Array of parsed arguments.
                  */
                 do_action_ref_array( 'bp_activity_after_delete', array( $activities, $r ) );
@@ -1273 +1274 @@
          * @since BuddyPress (1.2.0)
          *
-         * @global wpdb $wpdb WordPress database object
+         * @global wpdb $wpdb WordPress database object.
          *
          * @param array  $activities Activities to fetch comments for.
@@ -1459 +1460 @@
          * @since BuddyPress (1.2.0)
          *
-         * @global wpdb $wpdb WordPress database object
-         *
-         * @param  int $parent_id ID of an activity or activity comment
-         * @param  int $left      Node boundary start for activity or activity comment
-         * @return int Right      Node boundary of activity or activity comment
+         * @global wpdb $wpdb WordPress database object.
+         *
+         * @param  int $parent_id ID of an activity or activity comment.
+         * @param  int $left      Node boundary start for activity or activity comment.
+         * @return int Right      Node boundary of activity or activity comment.
          */
         public static function rebuild_activity_comment_tree( $parent_id, $left = 1 ) {
@@ -1760 +1761 @@
          * @see http://php.net/manual/en/function.array-replace-recursive.php#109390
          *
-         * @param  array $base         Array with keys needing to be replaced
-         * @param  array $replacements Array with the replaced keys
+         * @param  array $base         Array with keys needing to be replaced.
+         * @param  array $replacements Array with the replaced keys.
          *
          * @return array