Changeset 9964

Timestamp:

06/23/2015 02:08:22 PM (9 years ago)

Author:

boonebgorges

Message:

Improve formatting for docblocks of group avatar functions.

Props lenasterg.
See #6525.

File:

• trunk/src/bp-groups/bp-groups-template.php (modified) (2 diffs)

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

@@ -874 +874 @@
 }
     /**
-     * Return the group avatar while in the groups loop.
+     * Get a group's avatar.
      *
      * @since BuddyPress (1.0.0)
      *
-     * @param array|string $args {
-     *     Array of arguments. See {@link bp_core_fetch_avatar()} for
-     *     detailed description. Default values that differ from that
-     *     function are described below.
-     *
-     *     @type string $type Default: 'full'.
-     *     @type string $id   Passed to $css_id parameter.
+     * @see bp_core_fetch_avatar() For a description of arguments and return values.
+
+     * @param array $args  {
+     *     Arguments are listed here with an explanation of their defaults.
+     *     For more information about the arguments, see {@link bp_core_fetch_avatar()}.
+     *
+     *     @type string   $alt     Default: 'Group logo of [group name]'.
+     *     @type string   $class   Default: 'avatar'.
+     *     @type string   $type    Default: 'full'.
+     *     @type int|bool $width   Default: false.
+     *     @type int|bool $height  Default: false.
+     *     @type bool     $id      Passed to `$css_id` parameter.
      * }
-     * @return string
+     * @return string Group avatar string.
      */
     function bp_get_group_avatar( $args = '' ) {
@@ -4692 +4697 @@
      * @since BuddyPress (1.1.0)
      *
-     * @see bp_core_fetch_avatar() For more information on accepted arguments
-     *
-     * @param  array  $args See bp_core_fetch_avatar()
+     * @see bp_core_fetch_avatar() For a description of arguments and return values.
+     *
+     * @param array $args  {
+     *     Arguments are listed here with an explanation of their defaults.
+     *     For more information about the arguments, see {@link bp_core_fetch_avatar()}.
+     *
+     *     @type string   $alt     Default: 'Group photo'.
+     *     @type string   $class   Default: 'avatar'.
+     *     @type string   $type    Default: 'full'.
+     *     @type int|bool $width   Default: false.
+     *     @type int|bool $height  Default: false.
+     *     @type string   $id      Passed to $css_id parameter. Default: 'avatar-crop-preview'.
+     * }
      * @return string       The avatar for the group being created
      */