Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/23/2016 06:31:58 AM (8 years ago)
Author:
tw2113
Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/bp-core-avatars.php

    r10825 r10899  
    649649         *
    650650         * @param string $default_grav The avatar default.
    651          * @param array $params The avatar's data.
     651         * @param array  $params      The avatar's data.
    652652         */
    653653        $default_grav = apply_filters( 'bp_core_avatar_default', $default_grav, $params );
     
    727727     * @since 2.5.1
    728728     *
    729      * @param bool $value Whether or not to delete the avatar.
     729     * @param bool  $value Whether or not to delete the avatar.
    730730     * @param array $args {
    731731     *     Array of function parameters.
     
    806806 * @since 2.3.0
    807807 *
    808  * @return string|null A json object containing success data if the avatar was deleted
     808 * @return string|null A JSON object containing success data if the avatar was deleted,
    809809 *                     error message otherwise.
    810810 */
     
    949949 * @since 2.3.0
    950950 *
    951  * @return  string|null A json object containing success data if the upload succeeded
    952  *                      error message otherwise.
     951 * @return string|null A JSON object containing success data if the upload succeeded
     952 *                     error message otherwise.
    953953 */
    954954function bp_avatar_ajax_upload() {
     
    960960    /**
    961961     * Sending the json response will be different if
    962      * the current Plupload runtime is html4
     962     * the current Plupload runtime is html4.
    963963     */
    964964    $is_html4 = false;
     
    11711171/**
    11721172 * Crop an uploaded avatar.
    1173  *
    1174  * $args has the following parameters:
    1175  *  object - What component the avatar is for, e.g. "user"
    1176  *  avatar_dir  The absolute path to the avatar
    1177  *  item_id - Item ID
    1178  *  original_file - The absolute path to the original avatar file
    1179  *  crop_w - Crop width
    1180  *  crop_h - Crop height
    1181  *  crop_x - The horizontal starting point of the crop
    1182  *  crop_y - The vertical starting point of the crop
    11831173 *
    11841174 * @since 1.1.0
     
    12471237 * @since 2.3.0
    12481238 *
    1249  * @return  string|null A json object containing success data if the crop/capture succeeded
    1250  *                      error message otherwise.
     1239 * @return string|null A JSON object containing success data if the crop/capture succeeded
     1240 *                     error message otherwise.
    12511241 */
    12521242function bp_avatar_ajax_set() {
     
    15121502 *
    15131503 * @since 2.3.0
     1504 *
     1505 * @return array
    15141506 */
    15151507function bp_core_get_allowed_avatar_types() {
     
    15381530 *
    15391531 * @since 2.3.0
     1532 *
     1533 * @return array
    15401534 */
    15411535function bp_core_get_allowed_avatar_mimes() {
     
    19441938 * notices, we need to make sure this 'week' query var is reset to 0.
    19451939 *
    1946  * @since  2.2.0
     1940 * @since 2.2.0
    19471941 *
    19481942 * @param WP_Query|null $posts_query The main query object.
     
    19781972 * Checks whether Avatar UI should be loaded.
    19791973 *
    1980  * @since  2.3.0
     1974 * @since 2.3.0
    19811975 *
    19821976 * @return bool True if Avatar UI should load, false otherwise.
     
    20102004     * - Completely disable the avatar UI introduced in 2.3 (eg: __return_false())
    20112005     *
    2012      * @since  2.3.0
     2006     * @since 2.3.0
    20132007     *
    20142008     * @param bool $retval Whether or not to load the Avatar UI.
     
    20202014 * Checks whether the Webcam Avatar UI part should be loaded.
    20212015 *
    2022  * @since  2.3.0
     2016 * @since 2.3.0
    20232017 *
    20242018 * @global $is_safari
     
    20412035     * Bail when the browser does not support getUserMedia.
    20422036     *
    2043      * @see  http://caniuse.com/#feat=stream
     2037     * @see http://caniuse.com/#feat=stream
    20442038     */
    20452039    if ( $is_safari || $is_IE || ( $is_chrome && ! is_ssl() ) ) {
     
    20612055 * Template function to load the Avatar UI javascript templates.
    20622056 *
    2063  * @since  2.3.0
     2057 * @since 2.3.0
    20642058 */
    20652059function bp_avatar_get_templates() {
     
    20772071 * help users to get the avatar UI.
    20782072 *
    2079  * @since  2.3.0
     2073 * @since 2.3.0
    20802074 */
    20812075function bp_avatar_template_check() {
Note: See TracChangeset for help on using the changeset viewer.