Changeset 7451 for trunk/bp-core/bp-core-loader.php

Timestamp:

10/20/2013 07:21:38 PM (12 years ago)

Author:

boonebgorges

Message:

Improve inline docs in bp-core. See #5022

File:

• trunk/bp-core/bp-core-loader.php (modified) (7 diffs)

trunk/bp-core/bp-core-loader.php

@@ -2 +2 @@
 
 /**
- * BuddyPress Core Loader
- *
- * Core contains the commonly used functions, classes, and API's
+ * BuddyPress Core Loader.
+ *
+ * Core contains the commonly used functions, classes, and APIs.
  *
  * @package BuddyPress
@@ -16 +16 @@
 
     /**
-     * Start the members component creation process
-     *
-     * @since BuddyPress (1.5)
+     * Start the members component creation process.
+     *
+     * @since BuddyPress (1.5.0)
      *
      * @uses BP_Core::bootstrap()
@@ -33 +33 @@
 
     /**
-     * Populate the global data needed before BuddyPress can continue
+     * Populate the global data needed before BuddyPress can continue.
      *
      * This involves figuring out the currently required, active, deactive,
      * and optional components.
      *
-     * @since BuddyPress (1.5)
+     * @since BuddyPress (1.5.0)
      */
     private function bootstrap() {
@@ -109 +109 @@
     }
 
+    /**
+     * Include bp-core files.
+     *
+     * @see BP_Component::includes() for description of parameters.
+     *
+     * @param array $includes See {@link BP_Component::includes()}.
+     */
     public function includes( $includes = array() ) {
 
@@ -122 +129 @@
 
     /**
+     * Set up bp-core global settings.
+     *
      * Sets up a majority of the BuddyPress globals that require a minimal
      * amount of processing, meaning they cannot be set in the BuddyPress class.
      *
-     * @since BuddyPress (1.5)
+     * @since BuddyPress (1.5.0)
+     *
+     * @see BP_Component::setup_globals() for description of parameters.
+     *
+     * @param array $args See {@link BP_Component::setup_globals()}.
      */
     public function setup_globals( $args = array() ) {
@@ -185 +198 @@
 
     /**
-     * Setup BuddyBar navigation
-     *
-     * @since BuddyPress (1.5)
-     */
-    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
+     * Set up component navigation.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @see BP_Component::setup_nav() for a description of arguments.
+     *
+     * @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() ) {
         $bp = buddypress();
 
@@ -228 +248 @@
 
 /**
- * Setup the BuddyPress Core component
- *
- * @since BuddyPress (1.6)
- *
- * @global BuddyPress $bp
+ * Set up the BuddyPress Core component.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @global BuddyPress $bp BuddyPress global settings object.
  */
 function bp_setup_core() {