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

Timestamp:

02/03/2016 05:33:13 AM (11 years ago)

Author:

tw2113

Message:

Adds missed periods and some @since tags to the Settings component.

See #6405.

File:

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

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

@@ -11 +11 @@
 defined( 'ABSPATH' ) || exit;
 
+/**
+ * Creates our Settings component.
+ *
+ * @since 1.5.0
+ */
 class BP_Settings_Component extends BP_Component {
 
@@ -32 +37 @@
          * Include files.
          *
+         * @since 1.5.0
+         *
          * @param array $includes Array of values to include. Not used.
          */
@@ -49 +56 @@
          * backwards compatibility.
          *
+         * @since 1.5.0
+         *
          * @param array $args Array of arguments.
-         *
-         * @since 1.5.0
          */
         public function setup_globals( $args = array() ) {
 
-                // Define a slug, if necessary
+                // Define a slug, if necessary.
                 if ( ! defined( 'BP_SETTINGS_SLUG' ) ) {
                         define( 'BP_SETTINGS_SLUG', $this->id );
@@ -70 +77 @@
          * Set up navigation.
          *
+         * @since 1.5.0
+         *
          * @param array $main_nav Array of main nav items.
          * @param array $sub_nav  Array of sub nav items.
@@ -75 +84 @@
         public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 
-                // Determine user to use
+                // Determine user to use.
                 if ( bp_displayed_user_domain() ) {
                         $user_domain = bp_displayed_user_domain();
@@ -88 +97 @@
                 $settings_link = trailingslashit( $user_domain . $slug );
 
-                // Add the settings navigation item
+                // Add the settings navigation item.
                 $main_nav = array(
                         'name'                    => __( 'Settings', 'buddypress' ),
@@ -98 +107 @@
                 );
 
-                // Add General Settings nav item
+                // Add General Settings nav item.
                 $sub_nav[] = array(
                         'name'            => __( 'General', 'buddypress' ),
@@ -110 +119 @@
 
                 // Add Email nav item. Formerly called 'Notifications', we
-                // retain the old slug and function names for backward compat
+                // retain the old slug and function names for backward compat.
                 $sub_nav[] = array(
                         'name'            => __( 'Email', 'buddypress' ),
@@ -121 +130 @@
                 );
 
-                // Add Spam Account nav item
+                // Add Spam Account nav item.
                 if ( bp_current_user_can( 'bp_moderate' ) ) {
                         $sub_nav[] = array(
@@ -134 +143 @@
                 }
 
-                // Add Delete Account nav item
+                // Add Delete Account nav item.
                 if ( ( ! bp_disable_account_deletion() && bp_is_my_profile() ) || bp_current_user_can( 'delete_users' ) ) {
                         $sub_nav[] = array(
@@ -153 +162 @@
          * Set up the Toolbar.
          *
+         * @since 1.5.0
+         *
          * @param array $wp_admin_nav Array of Admin Bar items.
          */
         public function setup_admin_bar( $wp_admin_nav = array() ) {
 
-                // Menus for logged in user
+                // Menus for logged in user.
                 if ( is_user_logged_in() ) {
 
-                        // Setup the logged in user variables
+                        // Setup the logged in user variables.
                         $settings_link = trailingslashit( bp_loggedin_user_domain() . bp_get_settings_slug() );
 
-                        // Add main Settings menu
+                        // Add main Settings menu.
                         $wp_admin_nav[] = array(
                                 'parent' => buddypress()->my_account_menu_id,
@@ -171 +182 @@
                         );
 
-                        // General Account
+                        // General Account.
                         $wp_admin_nav[] = array(
                                 'parent' => 'my-account-' . $this->id,
@@ -189 +200 @@
                         }
 
-                        // Delete Account
+                        // Delete Account.
                         if ( !bp_current_user_can( 'bp_moderate' ) && ! bp_core_get_root_option( 'bp-disable-account-deletion' ) ) {
                                 $wp_admin_nav[] = array(
@@ -204 +215 @@
 }
 
+/**
+ * Instantiates the settings component.
+ *
+ * @since 1.6.0
+ */
 function bp_setup_settings() {
         buddypress()->settings = new BP_Settings_Component();