Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
04/24/2014 09:59:14 PM (10 years ago)
Author:
boonebgorges
Message:

Improve inline documentation in Members component. See #5022.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-members/bp-members-loader.php

    r8223 r8319  
    33 * BuddyPress Member Loader
    44 *
    5  * A members component to help contain all of the user specific slugs
    6  *
    75 * @package BuddyPress
    86 * @subpackage Members
     
    1513
    1614    /**
    17      * Start the members component creation process
    18      *
    19      * @since BuddyPress (1.5)
     15     * Start the members component creation process.
     16     *
     17     * @since BuddyPress (1.5.0)
    2018     */
    2119    public function __construct() {
     
    3129
    3230    /**
    33      * Include files
    34      *
    35      * @global BuddyPress $bp The one true BuddyPress instance
     31     * Include bp-members files.
     32     *
     33     * @see BP_Component::includes() for description of parameters.
     34     *
     35     * @param array $includes See {@link BP_Component::includes()}.
    3636     */
    3737    public function includes( $includes = array() ) {
     
    5656
    5757    /**
    58      * Setup globals
     58     * Set up bp-members global settings.
    5959     *
    6060     * The BP_MEMBERS_SLUG constant is deprecated, and only used here for
    6161     * backwards compatibility.
    6262     *
    63      * @since BuddyPress (1.5)
     63     * @since BuddyPress (1.5.0)
     64     *
     65     * @see BP_Component::setup_globals() for description of parameters.
     66     *
     67     * @param array $args See {@link BP_Component::setup_globals()}.
    6468     */
    6569    public function setup_globals( $args = array() ) {
     
    168172
    169173    /**
    170      * Setup BuddyBar navigation
     174     * Set up component navigation.
     175     *
     176     * @since BuddyPress (1.5.0)
     177     *
     178     * @see BP_Component::setup_nav() for a description of arguments.
     179     *
     180     * @param array $main_nav Optional. See BP_Component::setup_nav() for
     181     *        description.
     182     * @param array $sub_nav Optional. See BP_Component::setup_nav() for
     183     *        description.
    171184     */
    172185    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
     
    209222
    210223    /**
    211      * Sets up the title for pages and <title>
    212      *
    213      * @global BuddyPress $bp The one true BuddyPress instance
     224     * Set up the title for pages and <title>.
    214225     */
    215226    public function setup_title() {
     
    231242}
    232243
     244/**
     245 * Set up the bp-members component.
     246 */
    233247function bp_setup_members() {
    234248    buddypress()->members = new BP_Members_Component();
Note: See TracChangeset for help on using the changeset viewer.