Changeset 10425

Timestamp:

12/22/2015 05:41:48 AM (11 years ago)

Author:

tw2113

Message:

Scrutinizr feedback cleanup.

See #6398.

Location:

trunk/src/bp-core

Files:

• bp-core-attachments.php (modified) (1 diff)
• bp-core-functions.php (modified) (1 diff)
• bp-core-template-loader.php (modified) (3 diffs)
• bp-core-template.php (modified) (1 diff)
• classes/class-bp-core-user.php (modified) (3 diffs)
• classes/class-bp-user-query.php (modified) (1 diff)

trunk/src/bp-core/bp-core-attachments.php

@@ -1070 +1070 @@
  *     @type string $cover_image_dir The Cover image dir to write the image into. Required.
  * }
- * @param BP_Attachment_Cover_Image $cover_image_class The class to use to fit the cover image.
+ * @param BP_Attachment_Cover_Image|null $cover_image_class The class to use to fit the cover image.
  * @return bool|array An array containing cover image data on success, false otherwise.
  */

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

@@ -2560 +2560 @@
  * @uses  wp_upload_dir()
  * @uses  restore_current_blog()
+ *
+ * @return string
  */
 function bp_upload_dir() {

trunk/src/bp-core/bp-core-template-loader.php

@@ -24 +24 @@
  * @uses get_template_part()
  *
- * @param string $slug Template part slug. Used to generate filenames,
- *                     eg 'friends' for 'friends.php'.
- * @param string $name Optional. Template part name. Used to generate
- *                     secondary filenames, eg 'personal' for 'activity-personal.php'.
+ * @param string      $slug Template part slug. Used to generate filenames,
+ *                          eg 'friends' for 'friends.php'.
+ * @param string|null $name Optional. Template part name. Used to generate
+ *                          secondary filenames, eg 'personal' for 'activity-personal.php'.
  * @return string Path to located template. See {@link bp_locate_template()}.
  */
@@ -256 +256 @@
  * @see bp_get_template_part() for a description of $slug and $name params.
  *
- * @param string $slug See {@link bp_get_template_part()}.
- * @param string $name See {@link bp_get_template_part()}.
- * @param bool   $echo If true, template content will be echoed. If false,
- *                     returned. Default: true.
+ * @param string      $slug See {@link bp_get_template_part()}.
+ * @param string|null $name See {@link bp_get_template_part()}.
+ * @param bool        $echo If true, template content will be echoed. If false,
+ *                          returned. Default: true.
  * @return string|null If $echo, returns the template content.
  */
@@ -372 +372 @@
  *
  * @param array $stacks Array of template locations.
- * @return array() Array of all template locations registered so far.
+ * @return array Array of all template locations registered so far.
  */
 function bp_add_template_stack_locations( $stacks = array() ) {

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

@@ -312 +312 @@
          *
          * @since 1.6.0
+         *
+         * @return string
          */
         function bp_get_site_name() {

trunk/src/bp-core/classes/class-bp-core-user.php

@@ -445 +445 @@
          * @global wpdb $wpdb WordPress database object.
          *
-         * @param string $letter          The letter the users names are to start with.
-         * @param int    $limit           The number of users we wish to retrive.
-         * @param int    $page            The page number we are currently on, used in conjunction
-         *                                with $limit to get the start position for the limit.
-         * @param bool   $populate_extras If we should populate extra user fields.
-         * @param string $exclude         Comma-separated IDs of users whose results
-         *                                aren't to be fetched.
+         * @param string   $letter          The letter the users names are to start with.
+         * @param int|null $limit           The number of users we wish to retrive.
+         * @param int      $page            The page number we are currently on, used in conjunction
+         *                                  with $limit to get the start position for the limit.
+         * @param bool     $populate_extras If we should populate extra user fields.
+         * @param string   $exclude         Comma-separated IDs of users whose results
+         *                                  aren't to be fetched.
          * @return mixed False on error, otherwise associative array of results.
          */
@@ -532 +532 @@
          * @global wpdb $wpdb WordPress database object.
          *
-         * @param array $user_ids        The user IDs of the users who we wish to
-         *                               fetch information on.
-         * @param int   $limit           The limit of results we want.
-         * @param int   $page            The page we are on for pagination.
-         * @param bool  $populate_extras If we should populate extra user fields.
+         * @param array    $user_ids        The user IDs of the users who we wish to
+         *                                  fetch information on.
+         * @param int|null $limit           The limit of results we want.
+         * @param int      $page            The page we are on for pagination.
+         * @param bool     $populate_extras If we should populate extra user fields.
          * @return array Associative array.
          */
@@ -627 +627 @@
          * @global wpdb $wpdb WordPress database object.
          *
-         * @param string  $search_terms    The terms to search the profile table
-         *                                 value column for.
-         * @param int     $limit           The limit of results we want.
-         * @param int     $page            The page we are on for pagination.
-         * @param boolean $populate_extras If we should populate extra user fields.
+         * @param string   $search_terms    The terms to search the profile table
+         *                                  value column for.
+         * @param int|null $limit           The limit of results we want.
+         * @param int      $page            The page we are on for pagination.
+         * @param boolean  $populate_extras If we should populate extra user fields.
          * @return array Associative array.
          */

trunk/src/bp-core/classes/class-bp-user-query.php

@@ -144 +144 @@
          * @since 1.7.0
          *
-         * @param string|array $query See {@link BP_User_Query}.
+         * @param string|array|null $query See {@link BP_User_Query}.
          */
         public function __construct( $query = null ) {