Skip to:
Content

BuddyPress.org

Changeset 9994


Ignore:
Timestamp:
07/04/2015 10:19:15 PM (5 years ago)
Author:
tw2113
Message:

Docs cleanup for Settings component.

See #6405.

Location:
trunk/src/bp-settings
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-settings/bp-settings-actions.php

    r9819 r9994  
    1313
    1414/**
    15  * Handles the changing and saving of user email addresses and passwords
     15 * Handles the changing and saving of user email addresses and passwords.
    1616 *
    1717 * We do quite a bit of logic and error handling here to make sure that users
     
    281281
    282282/**
    283  * Handles the changing and saving of user notification settings
     283 * Handles the changing and saving of user notification settings.
    284284 */
    285285function bp_settings_action_notifications() {
     
    402402
    403403/**
    404  * Handles the deleting of a user
     404 * Handles the deleting of a user.
    405405 */
    406406function bp_settings_action_delete_account() {
  • trunk/src/bp-settings/bp-settings-loader.php

    r9936 r9994  
    22
    33/**
    4  * BuddyPress Settings Loader
     4 * BuddyPress Settings Loader.
    55 *
    66 * @package BuddyPress
     
    1414
    1515    /**
    16      * Start the settings component creation process
     16     * Start the settings component creation process.
    1717     *
    1818     * @since BuddyPress (1.5.0)
     
    3030
    3131    /**
    32      * Include files
     32     * Include files.
     33     *
     34     * @param array $includes Array of values to include. Not used.
    3335     */
    3436    public function includes( $includes = array() ) {
     
    4244
    4345    /**
    44      * Setup globals
     46     * Setup globals.
    4547     *
    4648     * The BP_SETTINGS_SLUG constant is deprecated, and only used here for
    4749     * backwards compatibility.
     50     *
     51     * @param array $args Array of arguments.
    4852     *
    4953     * @since BuddyPress (1.5.0)
     
    6569    /**
    6670     * Set up navigation.
     71     *
     72     * @param array $main_nav Array of main nav items.
     73     * @param array $sub_nav  Array of sub nav items.
    6774     */
    6875    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
     
    144151
    145152    /**
    146      * Set up the Toolbar
     153     * Set up the Toolbar.
     154     *
     155     * @param array $wp_admin_nav Array of Admin Bar items.
    147156     */
    148157    public function setup_admin_bar( $wp_admin_nav = array() ) {
  • trunk/src/bp-settings/bp-settings-screens.php

    r9819 r9994  
    22
    33/**
    4  * BuddyPress Settings Screens
     4 * BuddyPress Settings Screens.
    55 *
    66 * @package BuddyPress
     
    1212
    1313/**
    14  * Show the general settings template
     14 * Show the general settings template.
    1515 *
    1616 * @since BuddyPress (1.5.0)
     
    3434
    3535/**
    36  * Show the notifications settings template
     36 * Show the notifications settings template.
    3737 *
    3838 * @since BuddyPress (1.5.0)
     
    5656
    5757/**
    58  * Show the delete-account settings template
     58 * Show the delete-account settings template.
    5959 *
    6060 * @since BuddyPress (1.5.0)
     
    7878
    7979/**
    80  * Show the capabilities settings template
     80 * Show the capabilities settings template.
    8181 *
    8282 * @since BuddyPress (1.6.0)
  • trunk/src/bp-settings/bp-settings-template.php

    r9819 r9994  
    22
    33/**
    4  * BuddyPress Settings Template Functions
     4 * BuddyPress Settings Template Functions.
    55 *
    66 * @package BuddyPress
     
    1212
    1313/**
    14  * Output the settings component slug
     14 * Output the settings component slug.
    1515 *
    1616 * @package BuddyPress
     
    2424}
    2525    /**
    26      * Return the settings component slug
     26     * Return the settings component slug.
    2727     *
    2828     * @package BuddyPress
     
    4343
    4444/**
    45  * Output the settings component root slug
     45 * Output the settings component root slug.
    4646 *
    4747 * @package BuddyPress
     
    5555}
    5656    /**
    57      * Return the settings component root slug
     57     * Return the settings component root slug.
    5858     *
    5959     * @package BuddyPress
Note: See TracChangeset for help on using the changeset viewer.