Changeset 10010

Timestamp:

07/11/2015 11:00:19 PM (11 years ago)

Author:

tw2113

Message:

Initial documentation cleanup for the bp-loader.php file.

See #6401.

File:

• trunk/src/bp-loader.php (modified) (14 diffs)

trunk/src/bp-loader.php

@@ -1 +1 @@
 <?php
 /**
- * The BuddyPress Plugin
+ * The BuddyPress Plugin.
  *
  * BuddyPress is social networking software with a twist from the creators of WordPress.
@@ -28 +28 @@
 if ( !class_exists( 'BuddyPress' ) ) :
 /**
- * Main BuddyPress Class
+ * Main BuddyPress Class.
  *
  * Tap tap tap... Is this thing on?
@@ -113 +113 @@
          * Main BuddyPress Instance.
          *
-         * BuddyPress is great
-         * Please load it only one time
-         * For this, we thank you
+         * BuddyPress is great.
+         * Please load it only one time.
+         * For this, we thank you.
          *
          * Insures that only one instance of BuddyPress exists in memory at any
@@ -182 +182 @@
          *
          * @since BuddyPress (1.7.0)
+         *
+         * @param string $key Key to check the set status for.
+         *
+         * @return bool
          */
         public function __isset( $key ) { return isset( $this->data[$key] ); }
@@ -189 +193 @@
          *
          * @since BuddyPress (1.7.0)
+         *
+         * @param string $key Key to return the value for.
+         *
+         * @return mixed
          */
         public function __get( $key ) { return isset( $this->data[$key] ) ? $this->data[$key] : null; }
@@ -196 +204 @@
          *
          * @since BuddyPress (1.7.0)
+         *
+         * @param string $key   Key to set a value for.
+         * @param mixed  $value Value to set.
          */
         public function __set( $key, $value ) { $this->data[$key] = $value; }
@@ -203 +214 @@
          *
          * @since BuddyPress (1.7.0)
+         *
+         * @param string $key Key to unset a value for.
          */
         public function __unset( $key ) { if ( isset( $this->data[$key] ) ) unset( $this->data[$key] ); }
@@ -210 +223 @@
          *
          * @since BuddyPress (1.7.0)
+         *
+         * @param string $name
+         * @param array  $args
+         *
+         * @return null
          */
         public function __call( $name = '', $args = array() ) { unset( $name, $args ); return null; }
@@ -320 +338 @@
                  * @since BuddyPress (2.0.0)
                  *
-                 * @param constant BP_IGNORE_DEPRECATED Whether or not to ignore deprecated functionality.
+                 * @const constant BP_IGNORE_DEPRECATED Whether or not to ignore deprecated functionality.
                  */
                 $this->load_deprecated = ! apply_filters( 'bp_ignore_deprecated', BP_IGNORE_DEPRECATED );
@@ -327 +345 @@
 
                 /**
-                 * @var string The primary toolbar ID
+                 * @var string The primary toolbar ID.
                  */
                 $this->my_account_menu_id = '';
@@ -347 +365 @@
 
                 /**
-                 * @var string Name of the current BuddyPress component (primary)
+                 * @var string Name of the current BuddyPress component (primary).
                  */
                 $this->current_component = '';
 
                 /**
-                 * @var string Name of the current BuddyPress item (secondary)
+                 * @var string Name of the current BuddyPress item (secondary).
                  */
                 $this->current_item = '';
 
                 /**
-                 * @var string Name of the current BuddyPress action (tertiary)
+                 * @var string Name of the current BuddyPress action (tertiary).
                  */
                 $this->current_action = '';
 
                 /**
-                 * @var bool Displaying custom 2nd level navigation menu (I.E a group)
+                 * @var bool Displaying custom 2nd level navigation menu (I.E a group).
                  */
                 $this->is_single_item = false;
@@ -368 +386 @@
                 /** Root **************************************************************/
 
-                // BuddyPress Root blog ID
                 /**
                  * Filters the BuddyPress Root blog ID.
@@ -374 +391 @@
                  * @since BuddyPress (1.5.0)
                  *
-                 * @param constant BP_ROOT_BLOG BuddyPress Root blog ID.
+                 * @const constant BP_ROOT_BLOG BuddyPress Root blog ID.
                  */
                 $this->root_blog_id = (int) apply_filters( 'bp_get_root_blog_id', BP_ROOT_BLOG );
@@ -653 +670 @@
 
 /**
- * Hook BuddyPress early onto the 'plugins_loaded' action..
+ * Hook BuddyPress early onto the 'plugins_loaded' action.
  *
  * This gives all other plugins the chance to load before BuddyPress, to get