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

Timestamp:

09/06/2011 12:30:01 PM (15 years ago)

Author:

boonebgorges

Message:

Adds PHPDoc throughout the activity component. References #2345. Turbo props cnorris23

File:

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

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

@@ -1 +1 @@
 <?php
+
 /**
  * BuddyPress Activity Streams Loader
@@ -6 +7 @@
  *
  * @package BuddyPress
- * @subpackage Activity Core
+ * @subpackage ActivityCore
  */
 
@@ -12 +13 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Main Activity Class
+ *
+ * @since 1.5.0
+ */
 class BP_Activity_Component extends BP_Component {
 
@@ -17 +23 @@
      * Start the activity component creation process
      *
-     * @since 1.5
+     * @since 1.5.0
      */
     function BP_Activity_Component() {
@@ -33 +39 @@
     /**
      * Include files
+     *
+     * @since 1.5.0
      */
     function includes() {
@@ -55 +63 @@
      * backwards compatibility.
      *
-     * @since 1.5
-     * @global obj $bp
+     * @since 1.5.0
+     *
+     * @global object $bp BuddyPress global settings
      */
     function setup_globals() {
@@ -89 +98 @@
      * Setup BuddyBar navigation
      *
-     * @global obj $bp
+     * @since 1.5.0
+     *
+     * @global object $bp BuddyPress global settings
+     * @uses bp_is_active()
+     * @uses is_user_logged_in()
+     * @uses bp_get_friends_slug()
+     * @uses bp_get_groups_slug()
      */
     function setup_nav() {
@@ -183 +198 @@
      * Set up the admin bar
      *
-     * @global obj $bp
+     * @since 1.5.0
+     *
+     * @global object $bp BuddyPress global settings
+     * @uses is_user_logged_in()
+     * @uses trailingslashit()
+     * @uses bp_get_total_mention_count_for_user()
+     * @uses bp_loggedin_user_id()
+     * @uses bp_is_active()
+     * @uses bp_get_friends_slug()
+     * @uses bp_get_groups_slug()
      */
     function setup_admin_bar() {
@@ -259 +283 @@
      * Sets up the title for pages and <title>
      *
-     * @global obj $bp
+     * @since 1.5.0
+     *
+     * @global object $bp BuddyPress global settings
+     * @uses bp_is_activity_component()
+     * @uses bp_is_my_profile()
+     * @uses bp_core_fetch_avatar()
      */
     function setup_title() {
@@ -280 +309 @@
     }
 }
+
 // Create the activity component
 $bp->activity = new BP_Activity_Component();