Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
10/16/2013 01:36:51 PM (11 years ago)
Author:
boonebgorges
Message:

Improve inline docs in bp-core. See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/bp-core/bp-core-admin.php

    r7427 r7433  
    22
    33/**
    4  * Main BuddyPress Admin Class
     4 * Main BuddyPress Admin Class.
    55 *
    66 * @package BuddyPress
    … …  
    1313if ( !class_exists( 'BP_Admin' ) ) :
    1414/**
    15  * Loads BuddyPress plugin admin area
     15 * Load BuddyPress plugin admin area.
    1616 *
    1717 * @package BuddyPress
    1818 * @subpackage CoreAdministration
    19  * @since BuddyPress (1.6)
     19 *
     20 * @since BuddyPress (1.6.0)
    2021 */
    2122class BP_Admin {
    … …  
    2425
    2526    /**
    26      * @var string Path to the BuddyPress admin directory
     27     * Path to the BuddyPress admin directory.
     28     *
     29     * @var string $admin_dir
    2730     */
    2831    public $admin_dir = '';
    … …  
    3134
    3235    /**
    33      * @var string URL to the BuddyPress admin directory
     36     * URL to the BuddyPress admin directory.
     37     *
     38     * @var string $admin_url
    3439     */
    3540    public $admin_url = '';
    3641
    3742    /**
    38      * @var string URL to the BuddyPress images directory
     43     * URL to the BuddyPress images directory.
     44     *
     45     * @var string $images_url
    3946     */
    4047    public $images_url = '';
    4148
    4249    /**
    43      * @var string URL to the BuddyPress admin CSS directory
     50     * URL to the BuddyPress admin CSS directory.
     51     *
     52     * @var string $css_url
    4453     */
    4554    public $css_url = '';
    4655
    4756    /**
    48      * @var string URL to the BuddyPress admin JS directory
     57     * URL to the BuddyPress admin JS directory.
     58     *
     59     * @var string
    4960     */
    5061    public $js_url = '';
    … …  
    5364
    5465    /**
    55      * The main BuddyPress admin loader
    56      *
    57      * @since BuddyPress (1.6)
    58      *
    59      * @uses BP_Admin::setup_globals() Setup the globals needed
    60      * @uses BP_Admin::includes() Include the required files
    61      * @uses BP_Admin::setup_actions() Setup the hooks and actions
     66     * The main BuddyPress admin loader.
     67     *
     68     * @since BuddyPress (1.6.0)
     69     *
     70     * @uses BP_Admin::setup_globals() Setup the globals needed.
     71     * @uses BP_Admin::includes() Include the required files.
     72     * @uses BP_Admin::setup_actions() Setup the hooks and actions.
    6273     */
    6374    public function __construct() {
    … …  
    6879
    6980    /**
    70      * Admin globals
    71      *
    72      * @since BuddyPress (1.6)
     81     * Set admin-related globals.
     82     *
    7383     * @access private
     84     * @since BuddyPress (1.6.0)
    7485     */
    7586    private function setup_globals() {
    … …  
    8899
    89100    /**
    90      * Include required files
    91      *
    92      * @since BuddyPress (1.6)
     101     * Include required files.
     102     *
     103     * @since BuddyPress (1.6.0)
    93104     * @access private
    94105     */
    … …  
    102113
    103114    /**
    104      * Setup the admin hooks, actions and filters
    105      *
    106      * @since BuddyPress (1.6)
     115     * Set up the admin hooks, actions, and filters.
     116     *
    107117     * @access private
    108      *
    109      * @uses add_action() To add various actions
    110      * @uses add_filter() To add various filters
     118     * @since BuddyPress (1.6.0)
     119     *
     120     * @uses add_action() To add various actions.
     121     * @uses add_filter() To add various filters.
    111122     */
    112123    private function setup_actions() {
    … …  
    139150
    140151    /**
    141      * Add the navigational menu elements
     152     * Add the navigational menu elements.
    142153     *
    143154     * @since BuddyPress (1.6)
    144155     *
    145      * @uses add_management_page() To add the Recount page in Tools section
     156     * @uses add_management_page() To add the Recount page in Tools section.
    146157     * @uses add_options_page() To add the Forums settings page in Settings
    147      *                           section
     158     *       section.
    148159     */
    149160    public function admin_menus() {
    … …  
    227238
    228239    /**
    229      * Register the settings
    230      *
    231      * @since BuddyPress (1.6)
    232      *
    233      * @uses add_settings_section() To add our own settings section
    234      * @uses add_settings_field() To add various settings fields
    235      * @uses register_setting() To register various settings
     240     * Register the settings.
     241     *
     242     * @since BuddyPress (1.6.0)
     243     *
     244     * @uses add_settings_section() To add our own settings section.
     245     * @uses add_settings_field() To add various settings fields.
     246     * @uses register_setting() To register various settings.
    236247     */
    237248    public function register_admin_settings() {
    … …  
    316327
    317328    /**
    318      * Add Settings link to plugins area
    319      *
    320      * @since BuddyPress (1.6)
    321      *
    322      * @param array $links Links array in which we would prepend our link
    323      * @param string $file Current plugin basename
    324      * @return array Processed links
     329     * Add Settings link to plugins area.
     330     *
     331     * @since BuddyPress (1.6.0)
     332     *
     333     * @param array $links Links array in which we would prepend our link.
     334     * @param string $file Current plugin basename.
     335     * @return array Processed links.
    325336     */
    326337    public function modify_plugin_action_links( $links, $file ) {
    … …  
    338349
    339350    /**
    340      * Add some general styling to the admin area
    341      *
    342      * @since BuddyPress (1.6)
     351     * Add some general styling to the admin area.
     352     *
     353     * @since BuddyPress (1.6.0)
    343354     */
    344355    public function admin_head() {
    … …  
    354365
    355366    /**
    356      * Add some general styling to the admin area
    357      *
    358      * @since BuddyPress (1.6)
     367     * Add some general styling to the admin area.
     368     *
     369     * @since BuddyPress (1.6.0)
    359370     */
    360371    public function enqueue_scripts() {
    … …  
    370381
    371382    /**
    372      * Output the about screen
    373      *
    374      * @since BuddyPress (1.7)
     383     * Output the about screen.
     384     *
     385     * @since BuddyPress (1.7.0)
    375386     */
    376387    public function about_screen() {
    … …  
    481492
    482493    /**
    483      * Output the credits screen
    484      *
    485      * Hardcoding this in here is pretty janky. It's fine for 2.2, but we'll
     494     * Output the credits screen.
     495     *
     496     * Hardcoding this in here is pretty janky. It's fine for now, but we'll
    486497     * want to leverage api.wordpress.org eventually.
    487498     *
    488      * @since BuddyPress (1.7)
     499     * @since BuddyPress (1.7.0)
    489500     */
    490501    public function credits_screen() {
    … …  
    613624
    614625/**
    615  * Setup BuddyPress Admin
     626 * Setup BuddyPress Admin.
    616627 *
    617  * @since BuddyPress (1.6)
     628 * @since BuddyPress (1.6.0)
    618629 *
    619630 * @uses BP_Admin
Note: See TracChangeset for help on using the changeset viewer.