Changeset 13091 for trunk/src/bp-settings/classes/class-bp-settings-component.php

Timestamp:

08/23/2021 02:03:02 AM (2 years ago)

Author:

espellcaste

Message:

Making PHPDoc Improvements to the BP Notifications (component) files.

See #8553

File:

• trunk/src/bp-settings/classes/class-bp-settings-component.php (modified) (11 diffs)

trunk/src/bp-settings/classes/class-bp-settings-component.php

@@ -99 +99 @@
      * @since 1.5.0
      *
-     * @param array $args Array of arguments.
+     * @see BP_Component::setup_globals() for a description of arguments.
+     *
+     * @param array $args See BP_Component::setup_globals() for a description.
      */
     public function setup_globals( $args = array() ) {
@@ -120 +122 @@
      * @since 1.5.0
      *
-     * @param array $main_nav Array of main nav items.
-     * @param array $sub_nav  Array of sub nav items.
+     * @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() ) {
@@ -145 +151 @@
             'show_for_displayed_user' => $access,
             'screen_function'         => 'bp_settings_screen_general',
-            'default_subnav_slug'     => 'general'
+            'default_subnav_slug'     => 'general',
         );
 
@@ -156 +162 @@
             'screen_function' => 'bp_settings_screen_general',
             'position'        => 10,
-            'user_has_access' => $access
+            'user_has_access' => $access,
         );
 
@@ -168 +174 @@
             'screen_function' => 'bp_settings_screen_notification',
             'position'        => 20,
-            'user_has_access' => $access
+            'user_has_access' => $access,
         );
 
@@ -180 +186 @@
                 'screen_function' => 'bp_settings_screen_capabilities',
                 'position'        => 80,
-                'user_has_access' => ! bp_is_my_profile()
+                'user_has_access' => ! bp_is_my_profile(),
             );
         }
@@ -223 +229 @@
 
     /**
-     * Set up the Toolbar.
-     *
-     * @since 1.5.0
-     *
-     * @param array $wp_admin_nav Array of Admin Bar items.
+     * Set up the component entries in the WordPress Admin Bar.
+     *
+     * @since 1.5.0
+     *
+     * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
+     *      parameter array.
+     *
+     * @param array $wp_admin_nav See BP_Component::setup_admin_bar() for a
+     *                            description.
      */
     public function setup_admin_bar( $wp_admin_nav = array() ) {
@@ -242 +252 @@
                 'id'     => 'my-account-' . $this->id,
                 'title'  => __( 'Settings', 'buddypress' ),
-                'href'   => $settings_link
+                'href'   => $settings_link,
             );
 
@@ -251 +261 @@
                 'title'    => __( 'General', 'buddypress' ),
                 'href'     => $settings_link,
-                'position' => 10
+                'position' => 10,
             );
 
@@ -261 +271 @@
                     'title'    => __( 'Email', 'buddypress' ),
                     'href'     => trailingslashit( $settings_link . 'notifications' ),
-                    'position' => 20
+                    'position' => 20,
                 );
             }
@@ -286 +296 @@
                     'title'    => __( 'Delete Account', 'buddypress' ),
                     'href'     => trailingslashit( $settings_link . 'delete-account' ),
-                    'position' => 90
+                    'position' => 90,
                 );
             }