Skip to:
Content

BuddyPress.org

Changeset 9964


Ignore:
Timestamp:
06/23/2015 02:08:22 PM (5 years ago)
Author:
boonebgorges
Message:

Improve formatting for docblocks of group avatar functions.

Props lenasterg.
See #6525.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-template.php

    r9943 r9964  
    874874}
    875875    /**
    876      * Return the group avatar while in the groups loop.
     876     * Get a group's avatar.
    877877     *
    878878     * @since BuddyPress (1.0.0)
    879879     *
    880      * @param array|string $args {
    881      *     Array of arguments. See {@link bp_core_fetch_avatar()} for
    882      *     detailed description. Default values that differ from that
    883      *     function are described below.
    884      *
    885      *     @type string $type Default: 'full'.
    886      *     @type string $id   Passed to $css_id parameter.
     880     * @see bp_core_fetch_avatar() For a description of arguments and return values.
     881
     882     * @param array $args  {
     883     *     Arguments are listed here with an explanation of their defaults.
     884     *     For more information about the arguments, see {@link bp_core_fetch_avatar()}.
     885     *
     886     *     @type string   $alt     Default: 'Group logo of [group name]'.
     887     *     @type string   $class   Default: 'avatar'.
     888     *     @type string   $type    Default: 'full'.
     889     *     @type int|bool $width   Default: false.
     890     *     @type int|bool $height  Default: false.
     891     *     @type bool     $id      Passed to `$css_id` parameter.
    887892     * }
    888      * @return string
     893     * @return string Group avatar string.
    889894     */
    890895    function bp_get_group_avatar( $args = '' ) {
     
    46924697     * @since BuddyPress (1.1.0)
    46934698     *
    4694      * @see bp_core_fetch_avatar() For more information on accepted arguments
    4695      *
    4696      * @param  array  $args See bp_core_fetch_avatar()
     4699     * @see bp_core_fetch_avatar() For a description of arguments and return values.
     4700     *
     4701     * @param array $args  {
     4702     *     Arguments are listed here with an explanation of their defaults.
     4703     *     For more information about the arguments, see {@link bp_core_fetch_avatar()}.
     4704     *
     4705     *     @type string   $alt     Default: 'Group photo'.
     4706     *     @type string   $class   Default: 'avatar'.
     4707     *     @type string   $type    Default: 'full'.
     4708     *     @type int|bool $width   Default: false.
     4709     *     @type int|bool $height  Default: false.
     4710     *     @type string   $id      Passed to $css_id parameter. Default: 'avatar-crop-preview'.
     4711     * }
    46974712     * @return string       The avatar for the group being created
    46984713     */
Note: See TracChangeset for help on using the changeset viewer.