Changeset 10899 for trunk/src/bp-core/bp-core-avatars.php

Timestamp:

06/23/2016 06:31:58 AM (9 years ago)

Author:

tw2113

Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:

• trunk/src/bp-core/bp-core-avatars.php (modified) (16 diffs)

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

@@ -649 +649 @@
          *
          * @param string $default_grav The avatar default.
-         * @param array $params The avatar's data.
+         * @param array  $params       The avatar's data.
          */
         $default_grav = apply_filters( 'bp_core_avatar_default', $default_grav, $params );
@@ -727 +727 @@
      * @since 2.5.1
      *
-     * @param bool $value Whether or not to delete the avatar.
+     * @param bool  $value Whether or not to delete the avatar.
      * @param array $args {
      *     Array of function parameters.
@@ -806 +806 @@
  * @since 2.3.0
  *
- * @return string|null A json object containing success data if the avatar was deleted
+ * @return string|null A JSON object containing success data if the avatar was deleted,
  *                     error message otherwise.
  */
@@ -949 +949 @@
  * @since 2.3.0
  *
- * @return  string|null A json object containing success data if the upload succeeded
- *                      error message otherwise.
+ * @return string|null A JSON object containing success data if the upload succeeded
+ *                     error message otherwise.
  */
 function bp_avatar_ajax_upload() {
@@ -960 +960 @@
     /**
      * Sending the json response will be different if
-     * the current Plupload runtime is html4
+     * the current Plupload runtime is html4.
      */
     $is_html4 = false;
@@ -1171 +1171 @@
 /**
  * Crop an uploaded avatar.
- *
- * $args has the following parameters:
- *  object - What component the avatar is for, e.g. "user"
- *  avatar_dir  The absolute path to the avatar
- *  item_id - Item ID
- *  original_file - The absolute path to the original avatar file
- *  crop_w - Crop width
- *  crop_h - Crop height
- *  crop_x - The horizontal starting point of the crop
- *  crop_y - The vertical starting point of the crop
  *
  * @since 1.1.0
@@ -1247 +1237 @@
  * @since 2.3.0
  *
- * @return  string|null A json object containing success data if the crop/capture succeeded
- *                      error message otherwise.
+ * @return string|null A JSON object containing success data if the crop/capture succeeded
+ *                     error message otherwise.
  */
 function bp_avatar_ajax_set() {
@@ -1512 +1502 @@
  *
  * @since 2.3.0
+ *
+ * @return array
  */
 function bp_core_get_allowed_avatar_types() {
@@ -1538 +1530 @@
  *
  * @since 2.3.0
+ *
+ * @return array
  */
 function bp_core_get_allowed_avatar_mimes() {
@@ -1944 +1938 @@
  * notices, we need to make sure this 'week' query var is reset to 0.
  *
- * @since  2.2.0
+ * @since 2.2.0
  *
  * @param WP_Query|null $posts_query The main query object.
@@ -1978 +1972 @@
  * Checks whether Avatar UI should be loaded.
  *
- * @since  2.3.0
+ * @since 2.3.0
  *
  * @return bool True if Avatar UI should load, false otherwise.
@@ -2010 +2004 @@
      * - Completely disable the avatar UI introduced in 2.3 (eg: __return_false())
      *
-     * @since  2.3.0
+     * @since 2.3.0
      *
      * @param bool $retval Whether or not to load the Avatar UI.
@@ -2020 +2014 @@
  * Checks whether the Webcam Avatar UI part should be loaded.
  *
- * @since  2.3.0
+ * @since 2.3.0
  *
  * @global $is_safari
@@ -2041 +2035 @@
      * Bail when the browser does not support getUserMedia.
      *
-     * @see  http://caniuse.com/#feat=stream
+     * @see http://caniuse.com/#feat=stream
      */
     if ( $is_safari || $is_IE || ( $is_chrome && ! is_ssl() ) ) {
@@ -2061 +2055 @@
  * Template function to load the Avatar UI javascript templates.
  *
- * @since  2.3.0
+ * @since 2.3.0
  */
 function bp_avatar_get_templates() {
@@ -2077 +2071 @@
  * help users to get the avatar UI.
  *
- * @since  2.3.0
+ * @since 2.3.0
  */
 function bp_avatar_template_check() {