Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/17/2014 01:49:22 AM (12 years ago)
Author:
boonebgorges
Message:

Improved inline documentation in bp-groups

See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-groups/bp-groups-loader.php

    r8982 r9027  
    1818
    1919        /**
    20          * Auto join group when non group member performs group activity
    21          *
    22          * @since BuddyPress (1.5)
     20         * Auto-join group when non group member performs group activity
     21         *
     22         * @since BuddyPress (1.5.0)
     23         * @access public
    2324         * @var bool
    2425         */
    … …  
    2627
    2728        /**
    28          * The group being currently accessed
    29          *
    30          * @since BuddyPress (1.5)
     29         * The group being currently accessed.
     30         *
     31         * @since BuddyPress (1.5.0)
     32         * @access public
    3133         * @var BP_Groups_Group
    3234         */
    … …  
    3436
    3537        /**
    36          * Default group extension
    37          *
    38          * @since BuddyPress (1.6)
     38         * Default group extension.
     39         *
     40         * @since BuddyPress (1.6.0)
     41         * @access public
    3942         * @todo Is this used anywhere? Is this a duplicate of $default_extension?
    4043         */
    … …  
    4245
    4346        /**
    44          * Default group extension
    45          *
    46          * @since BuddyPress (1.6)
     47         * Default group extension.
     48         *
     49         * @since BuddyPress (1.6.0)
     50         * @access public
    4751         * @var string
    4852         */
    … …  
    5054
    5155        /**
    52          * Illegal group names/slugs
    53          *
    54          * @since BuddyPress (1.5)
     56         * Illegal group names/slugs.
     57         *
     58         * @since BuddyPress (1.5.0)
     59         * @access public
    5560         * @var array
    5661         */
    … …  
    5863
    5964        /**
    60          * Group creation/edit steps (e.g. Details, Settings, Avatar, Invites)
    61          *
    62          * @since BuddyPress (1.5)
     65         * Group creation/edit steps (e.g. Details, Settings, Avatar, Invites).
     66         *
     67         * @since BuddyPress (1.5.0)
     68         * @access public
    6369         * @var array
    6470         */
    … …  
    6672
    6773        /**
    68          * Types of group statuses (Public, Private, Hidden)
    69          *
    70          * @since BuddyPress (1.5)
     74         * Types of group statuses (Public, Private, Hidden).
     75         *
     76         * @since BuddyPress (1.5.0)
     77         * @access public
    7178         * @var array
    7279         */
    … …  
    7481
    7582        /**
    76          * Start the groups component creation process
    77          *
    78          * @since BuddyPress (1.5)
     83         * Start the groups component creation process.
     84         *
     85         * @since BuddyPress (1.5.0)
    7986         */
    8087        public function __construct() {
    … …  
    9097
    9198        /**
    92          * Include files
     99         * Include Groups component files.
     100         *
     101         * @since BuddyPress (1.5.0)
     102         *
     103         * @see BP_Component::includes() for a description of arguments.
     104         *
     105         * @param array $includes See BP_Component::includes() for a description.
    93106         */
    94107        public function includes( $includes = array() ) {
    … …  
    115128
    116129        /**
    117          * Setup globals
     130         * Set up component global data.
    118131         *
    119132         * The BP_GROUPS_SLUG constant is deprecated, and only used here for
    120133         * backwards compatibility.
    121134         *
    122          * @since BuddyPress (1.5)
     135         * @since BuddyPress (1.5.0)
     136         *
     137         * @see BP_Component::setup_globals() for a description of arguments.
     138         *
     139         * @param array $args See BP_Component::setup_globals() for a description.
    123140         */
    124141        public function setup_globals( $args = array() ) {
    … …  
    321338
    322339        /**
    323          * Set up navigation.
    324          *
    325          * @global BuddyPress $bp The one true BuddyPress instance
     340         * Set up component navigation.
     341         *
     342         * @since BuddyPress (1.5.0)
     343         *
     344         * @see BP_Component::setup_nav() for a description of arguments.
     345         *
     346         * @param array $main_nav Optional. See BP_Component::setup_nav() for
     347         *        description.
     348         * @param array $sub_nav Optional. See BP_Component::setup_nav() for
     349         *        description.
    326350         */
    327351        public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
    … …  
    497521
    498522        /**
    499          * Set up the Toolbar
     523         * Set up the component entries in the WordPress Admin Bar.
     524         *
     525         * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
     526         *      parameter array.
     527         *
     528         * @param array $wp_admin_nav See BP_Component::setup_admin_bar() for a
     529         *        description.
    500530         */
    501531        public function setup_admin_bar( $wp_admin_nav = array() ) {
    … …  
    558588
    559589        /**
    560          * Sets up the title for pages and <title>
     590         * Set up the title for pages and <title>.
    561591         */
    562592        public function setup_title() {
    … …  
    598628}
    599629
    600 
     630/**
     631 * Bootstrap the Notifications component.
     632 *
     633 * @since BuddyPress (1.5.0)
     634 */
    601635function bp_setup_groups() {
    602636        buddypress()->groups = new BP_Groups_Component();
Note: See TracChangeset for help on using the changeset viewer.