Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
10/20/2013 07:21:38 PM (11 years ago)
Author:
boonebgorges
Message:

Improve inline docs in bp-core. See #5022

File:
1 edited

Legend:

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

    r7347 r7451  
    22
    33/**
    4  * BuddyPress Core Loader
    5  *
    6  * Core contains the commonly used functions, classes, and API's
     4 * BuddyPress Core Loader.
     5 *
     6 * Core contains the commonly used functions, classes, and APIs.
    77 *
    88 * @package BuddyPress
     
    1616
    1717    /**
    18      * Start the members component creation process
    19      *
    20      * @since BuddyPress (1.5)
     18     * Start the members component creation process.
     19     *
     20     * @since BuddyPress (1.5.0)
    2121     *
    2222     * @uses BP_Core::bootstrap()
     
    3333
    3434    /**
    35      * Populate the global data needed before BuddyPress can continue
     35     * Populate the global data needed before BuddyPress can continue.
    3636     *
    3737     * This involves figuring out the currently required, active, deactive,
    3838     * and optional components.
    3939     *
    40      * @since BuddyPress (1.5)
     40     * @since BuddyPress (1.5.0)
    4141     */
    4242    private function bootstrap() {
     
    109109    }
    110110
     111    /**
     112     * Include bp-core files.
     113     *
     114     * @see BP_Component::includes() for description of parameters.
     115     *
     116     * @param array $includes See {@link BP_Component::includes()}.
     117     */
    111118    public function includes( $includes = array() ) {
    112119
     
    122129
    123130    /**
     131     * Set up bp-core global settings.
     132     *
    124133     * Sets up a majority of the BuddyPress globals that require a minimal
    125134     * amount of processing, meaning they cannot be set in the BuddyPress class.
    126135     *
    127      * @since BuddyPress (1.5)
     136     * @since BuddyPress (1.5.0)
     137     *
     138     * @see BP_Component::setup_globals() for description of parameters.
     139     *
     140     * @param array $args See {@link BP_Component::setup_globals()}.
    128141     */
    129142    public function setup_globals( $args = array() ) {
     
    185198
    186199    /**
    187      * Setup BuddyBar navigation
    188      *
    189      * @since BuddyPress (1.5)
    190      */
    191     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
     200     * Set up component navigation.
     201     *
     202     * @since BuddyPress (1.5.0)
     203     *
     204     * @see BP_Component::setup_nav() for a description of arguments.
     205     *
     206     * @param array $main_nav Optional. See BP_Component::setup_nav() for
     207     *        description.
     208     * @param array $sub_nav Optional. See BP_Component::setup_nav() for
     209     *        description.
     210     */
     211         public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
    192212        $bp = buddypress();
    193213
     
    228248
    229249/**
    230  * Setup the BuddyPress Core component
    231  *
    232  * @since BuddyPress (1.6)
    233  *
    234  * @global BuddyPress $bp
     250 * Set up the BuddyPress Core component.
     251 *
     252 * @since BuddyPress (1.6.0)
     253 *
     254 * @global BuddyPress $bp BuddyPress global settings object.
    235255 */
    236256function bp_setup_core() {
Note: See TracChangeset for help on using the changeset viewer.