Changeset 7400 for trunk/bp-activity/bp-activity-loader.php

Timestamp:

10/08/2013 08:58:10 PM (12 years ago)

Author:

boonebgorges

Message:

Improve inline docs in bp-activity-loader.php

See #5022

File:

• trunk/bp-activity/bp-activity-loader.php (modified) (12 diffs)

trunk/bp-activity/bp-activity-loader.php

@@ -2 +2 @@
 
 /**
- * BuddyPress Activity Streams Loader
+ * BuddyPress Activity Streams Loader.
  *
  * An activity stream component, for users, groups, and site tracking.
@@ -14 +14 @@
 
 /**
- * Main Activity Class
+ * Main Activity Class.
  *
  * @since BuddyPress (1.5)
@@ -21 +21 @@
 
     /**
-     * Start the activity component creation process
+     * Start the activity component setup process.
      *
      * @since BuddyPress (1.5)
@@ -34 +34 @@
 
     /**
-     * Include files
-     *
-     * @since BuddyPress (1.5)
+     * Include component files.
+     *
+     * @since BuddyPress (1.5)
+     *
+     * @see BP_Component::includes() for a description of arguments.
+     *
+     * @param array $includes See BP_Component::includes() for a description.
      */
     public function includes( $includes = array() ) {
@@ -65 +69 @@
 
     /**
-     * Setup globals
+     * Set up component global variables.
      *
      * The BP_ACTIVITY_SLUG constant is deprecated, and only used here for
@@ -71 +75 @@
      *
      * @since BuddyPress (1.5)
+     *
+     * @see BP_Component::setup_globals() for a description of arguments.
+     *
+     * @param array $args See BP_Component::setup_globals() for a description.
      */
     public function setup_globals( $args = array() ) {
@@ -100 +108 @@
 
     /**
-     * Setup BuddyBar navigation
-     *
-     * @since BuddyPress (1.5)
-     *
-     * @global object $bp BuddyPress global settings
+     * Set up component navigation.
+     *
+     * @since BuddyPress (1.5)
+     *
+     * @see BP_Component::setup_nav() for a description of arguments.
      * @uses bp_is_active()
      * @uses is_user_logged_in()
      * @uses bp_get_friends_slug()
      * @uses bp_get_groups_slug()
+     *
+     * @param array $main_nav Optional. See BP_Component::setup_nav() for
+     *                        description.
+     * @param array $sub_nav Optional. See BP_Component::setup_nav() for
+     *                       description.
      */
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
@@ -202 +215 @@
 
     /**
-     * Set up the Toolbar
-     *
-     * @since BuddyPress (1.5)
-     *
-     * @global object $bp BuddyPress global settings
+     * Set up the component entries in the WordPress Admin Bar.
+     *
+     * @since BuddyPress (1.5)
+     *
+     * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
+     *      parameter array.
      * @uses is_user_logged_in()
      * @uses trailingslashit()
@@ -214 +228 @@
      * @uses bp_get_friends_slug()
      * @uses bp_get_groups_slug()
+     *
+     * @param array $wp_admin_nav See BP_Component::setup_admin_bar() for a
+     *                            description.
      */
     public function setup_admin_bar( $wp_admin_nav = array() ) {
@@ -294 +311 @@
 
     /**
-     * Sets up the title for pages and <title>
-     *
-     * @since BuddyPress (1.5)
-     *
-     * @global object $bp BuddyPress global settings
+     * Set up the title for pages and <title>.
+     *
+     * @since BuddyPress (1.5)
+     *
      * @uses bp_is_activity_component()
      * @uses bp_is_my_profile()
@@ -324 +340 @@
 
     /**
-     * Setup the actions
+     * Set up actions necessary for the component.
      *
      * @since BuddyPress (1.6)
@@ -336 +352 @@
 }
 
+/**
+ * Bootstrap the Activity component.
+ */
 function bp_setup_activity() {
     buddypress()->activity = new BP_Activity_Component();