Skip to:
Content

BuddyPress.org

Changeset 7400


Ignore:
Timestamp:
10/08/2013 08:58:10 PM (11 years ago)
Author:
boonebgorges
Message:

Improve inline docs in bp-activity-loader.php

See #5022

File:
1 edited

Legend:

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

    r7352 r7400  
    22
    33/**
    4  * BuddyPress Activity Streams Loader
     4 * BuddyPress Activity Streams Loader.
    55 *
    66 * An activity stream component, for users, groups, and site tracking.
     
    1414
    1515/**
    16  * Main Activity Class
     16 * Main Activity Class.
    1717 *
    1818 * @since BuddyPress (1.5)
     
    2121
    2222    /**
    23      * Start the activity component creation process
     23     * Start the activity component setup process.
    2424     *
    2525     * @since BuddyPress (1.5)
     
    3434
    3535    /**
    36      * Include files
    37      *
    38      * @since BuddyPress (1.5)
     36     * Include component files.
     37     *
     38     * @since BuddyPress (1.5)
     39     *
     40     * @see BP_Component::includes() for a description of arguments.
     41     *
     42     * @param array $includes See BP_Component::includes() for a description.
    3943     */
    4044    public function includes( $includes = array() ) {
     
    6569
    6670    /**
    67      * Setup globals
     71     * Set up component global variables.
    6872     *
    6973     * The BP_ACTIVITY_SLUG constant is deprecated, and only used here for
     
    7175     *
    7276     * @since BuddyPress (1.5)
     77     *
     78     * @see BP_Component::setup_globals() for a description of arguments.
     79     *
     80     * @param array $args See BP_Component::setup_globals() for a description.
    7381     */
    7482    public function setup_globals( $args = array() ) {
     
    100108
    101109    /**
    102      * Setup BuddyBar navigation
    103      *
    104      * @since BuddyPress (1.5)
    105      *
    106      * @global object $bp BuddyPress global settings
     110     * Set up component navigation.
     111     *
     112     * @since BuddyPress (1.5)
     113     *
     114     * @see BP_Component::setup_nav() for a description of arguments.
    107115     * @uses bp_is_active()
    108116     * @uses is_user_logged_in()
    109117     * @uses bp_get_friends_slug()
    110118     * @uses bp_get_groups_slug()
     119     *
     120     * @param array $main_nav Optional. See BP_Component::setup_nav() for
     121     *                        description.
     122     * @param array $sub_nav Optional. See BP_Component::setup_nav() for
     123     *                       description.
    111124     */
    112125    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
     
    202215
    203216    /**
    204      * Set up the Toolbar
    205      *
    206      * @since BuddyPress (1.5)
    207      *
    208      * @global object $bp BuddyPress global settings
     217     * Set up the component entries in the WordPress Admin Bar.
     218     *
     219     * @since BuddyPress (1.5)
     220     *
     221     * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
     222     *      parameter array.
    209223     * @uses is_user_logged_in()
    210224     * @uses trailingslashit()
     
    214228     * @uses bp_get_friends_slug()
    215229     * @uses bp_get_groups_slug()
     230     *
     231     * @param array $wp_admin_nav See BP_Component::setup_admin_bar() for a
     232     *                            description.
    216233     */
    217234    public function setup_admin_bar( $wp_admin_nav = array() ) {
     
    294311
    295312    /**
    296      * Sets up the title for pages and <title>
    297      *
    298      * @since BuddyPress (1.5)
    299      *
    300      * @global object $bp BuddyPress global settings
     313     * Set up the title for pages and <title>.
     314     *
     315     * @since BuddyPress (1.5)
     316     *
    301317     * @uses bp_is_activity_component()
    302318     * @uses bp_is_my_profile()
     
    324340
    325341    /**
    326      * Setup the actions
     342     * Set up actions necessary for the component.
    327343     *
    328344     * @since BuddyPress (1.6)
     
    336352}
    337353
     354/**
     355 * Bootstrap the Activity component.
     356 */
    338357function bp_setup_activity() {
    339358    buddypress()->activity = new BP_Activity_Component();
Note: See TracChangeset for help on using the changeset viewer.