Changeset 9994 for trunk/src/bp-settings/bp-settings-loader.php

Timestamp:

07/04/2015 10:19:15 PM (9 years ago)

Author:

tw2113

Message:

Docs cleanup for Settings component.

See #6405.

File:

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

trunk/src/bp-settings/bp-settings-loader.php

@@ -2 +2 @@
 
 /**
- * BuddyPress Settings Loader
+ * BuddyPress Settings Loader.
  *
  * @package BuddyPress
@@ -14 +14 @@
 
     /**
-     * Start the settings component creation process
+     * Start the settings component creation process.
      *
      * @since BuddyPress (1.5.0)
@@ -30 +30 @@
 
     /**
-     * Include files
+     * Include files.
+     *
+     * @param array $includes Array of values to include. Not used.
      */
     public function includes( $includes = array() ) {
@@ -42 +44 @@
 
     /**
-     * Setup globals
+     * Setup globals.
      *
      * The BP_SETTINGS_SLUG constant is deprecated, and only used here for
      * backwards compatibility.
+     *
+     * @param array $args Array of arguments.
      *
      * @since BuddyPress (1.5.0)
@@ -65 +69 @@
     /**
      * Set up navigation.
+     *
+     * @param array $main_nav Array of main nav items.
+     * @param array $sub_nav  Array of sub nav items.
      */
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
@@ -144 +151 @@
 
     /**
-     * Set up the Toolbar
+     * Set up the Toolbar.
+     *
+     * @param array $wp_admin_nav Array of Admin Bar items.
      */
     public function setup_admin_bar( $wp_admin_nav = array() ) {