Changeset 10712

Timestamp:

04/17/2016 12:24:44 AM (9 years ago)

Author:

tw2113

Message:

Revisited Scrutinizer and fixed some items it found.

Location:

trunk/src

Files:

• bp-activity/bp-activity-functions.php (modified) (3 diffs)
• bp-blogs/bp-blogs-functions.php (modified) (1 diff)
• bp-blogs/bp-blogs-template.php (modified) (1 diff)
• bp-forums/bp-forums-template.php (modified) (1 diff)
• bp-members/classes/class-bp-members-list-table.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-template.php (modified) (1 diff)

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

@@ -1064 +1064 @@
      * @since 1.1.0
      *
-     * @param BP_Activity_Activity $content_exists ID of the activity if found, else null.
+     * @param BP_Activity_Activity $value ID of the activity if found, else null.
      */
     return apply_filters( 'bp_activity_check_exists_by_content', BP_Activity_Activity::check_exists_by_content( $content ) );
@@ -2305 +2305 @@
  * @since 2.5.0
  *
- * @param  int  $comment_id  ID of the comment.
- * @param  bool $is_approved Whether the comment is approved or not.
- * @param  object $activity_post_object the post type tracking args object.
- *
+ * @param  int         $comment_id           ID of the comment.
+ * @param  bool        $is_approved          Whether the comment is approved or not.
+ * @param  object|null $activity_post_object The post type tracking args object.
  * @return int|bool The ID of the activity on success. False on error.
  */
@@ -2498 +2497 @@
  * @since 2.5.0
  *
- * @param  int    $comment_id           ID of the comment.
- * @param  object $activity_post_object The post type tracking args object.
- *
+ * @param  int         $comment_id           ID of the comment.
+ * @param  object|null $activity_post_object The post type tracking args object.
  * @return bool True on success. False on error.
  */

trunk/src/bp-blogs/bp-blogs-functions.php

@@ -564 +564 @@
  * @since  2.5.0
  *
- * @param  int|bool   $activity_id          ID of recorded activity, or false if sync is active.
- * @param  WP_Comment $comment              The comment object.
- * @param  array      $activity_args        Array of activity arguments.
- * @param  object     $activity_post_object The post type tracking args object.
- * @return int|bool   Returns false if no activity, the activity id otherwise.
+ * @param  int|bool        $activity_id          ID of recorded activity, or false if sync is active.
+ * @param  WP_Comment|null $comment              The comment object.
+ * @param  array           $activity_args        Array of activity arguments.
+ * @param  object|null     $activity_post_object The post type tracking args object.
+ * @return int|bool Returns false if no activity, the activity id otherwise.
  */
 function bp_blogs_comment_sync_activity_comment( &$activity_id, $comment = null, $activity_args = array(), $activity_post_object = null ) {

trunk/src/bp-blogs/bp-blogs-template.php

@@ -1142 +1142 @@
  * @param string       $user_email The email of the user who created the blog. Unused.
  * @param string|array $meta       Meta values associated with the new blog. Unused.
- * @param int          $blog_id    ID of the newly created blog.
+ * @param int|null     $blog_id    ID of the newly created blog.
  */
 function bp_blogs_confirm_blog_signup( $domain, $path, $blog_title, $user_name, $user_email = '', $meta = '', $blog_id = null ) {

trunk/src/bp-forums/bp-forums-template.php

@@ -1815 +1815 @@
      *
      * @todo Deprecate? Seems unused
+     *
+     * @return bool|string
      */
     function bp_get_forums_tag_name() {

trunk/src/bp-members/classes/class-bp-members-list-table.php

@@ -335 +335 @@
      * @since 2.0.0
      *
-     * @param object $signup_object The signup data object.
+     * @param object|null $signup_object The signup data object.
      */
     public function column_name( $signup_object = null ) {

trunk/src/bp-xprofile/bp-xprofile-template.php

@@ -116 +116 @@
  * @since 1.0.0
  *
- * @param array|string $class Extra classes to append to class attribute.
- *                            Pass mutiple class names as an array or
- *                            space-delimited string.
- *
+ * @param array|string|false $class Extra classes to append to class attribute.
+ *                                  Pass mutiple class names as an array or
+ *                                  space-delimited string.
  * @return string
  */