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-buddybar.php

    r10876 r10899  
    3434 *                                                item is clicked.
    3535 * }
    36  * @param string $component The component the navigation is attached to. Defaults to 'members'.
     36 * @param string       $component The component the navigation is attached to. Defaults to 'members'.
    3737 * @return bool|null Returns false on failure.
    3838 */
     
    108108 *                                                item is clicked.
    109109 * }
    110  * @param string $component Optional. Component that the nav belongs to.
     110 * @param string       $component Optional. Component that the nav belongs to.
    111111 * @return bool|BP_Nav_Item Returns false on failure, new nav item on success.
    112112 */
     
    322322    }
    323323
    324     // Edit the screen function for the parent nav
     324    // Edit the screen function for the parent nav.
    325325    $bp->members->nav->edit_nav( array(
    326326        'screen_function'     => &$r['screen_function'],
     
    395395 *                                          Admin Bar menu for group admins. Default: false.
    396396 * }
    397  * @param string $component The component the navigation is attached to. Defaults to 'members'.
     397 * @param string       $component The component the navigation is attached to. Defaults to 'members'.
    398398 * @return bool|null Returns false on failure.
    399399 */
     
    406406         * a) the 'parent_slug' is the same as the slug of the current group, or
    407407         * b) the 'parent_slug' starts with the slug of the current group, and the members nav doesn't have
    408          *    a primary item with that slug
     408         *    a primary item with that slug.
    409409         */
    410410        $group_slug = bp_get_current_group_slug();
     
    475475 *                                          Default: false.
    476476 * }
    477  * @param string $component The component the navigation is attached to. Defaults to 'members'.
    478  * @return bool|BP_Nav_Item Returns false on failure, new nav item on success.
     477 * @param string       $component The component the navigation is attached to. Defaults to 'members'.
     478 * @return bool|object Returns false on failure, new BP_Nav_Item instance on success.
    479479 */
    480480function bp_core_create_subnav_link( $args = '', $component = 'members' ) {
     
    569569 *                                       Default: false.
    570570 * }
    571  * @param string $component The component the navigation is attached to. Defaults to 'members'.
     571 * @param string       $component The component the navigation is attached to. Defaults to 'members'.
    572572 * @return bool|null Returns false on failure.
    573573 */
Note: See TracChangeset for help on using the changeset viewer.