Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/12/2015 12:49:36 AM (9 years ago)
Author:
tw2113
Message:

First pass at BP-Core docs cleanup.

See #6398.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/bp-core-component.php

    r9847 r10012  
    109109
    110110    /**
    111      * Metadata tables for the component (if applicable)
     111     * Metadata tables for the component (if applicable).
    112112     *
    113113     * @since BuddyPress (2.0.0)
     
    118118
    119119    /**
    120      * Global tables for the component (if applicable)
     120     * Global tables for the component (if applicable).
    121121     *
    122122     * @since BuddyPress (2.0.0)
     
    141141     * @param array  $params {
    142142     *     Additional parameters used by the component.
    143      *     @type int   $adminbar_myaccount_order Set the position for our menu under the WP Toolbar's "My Account menu"
     143     *     @type int   $adminbar_myaccount_order Set the position for our menu under the WP Toolbar's "My Account menu".
    144144     *     @type array $features                 An array of feature names. This is used to load additional files from your
    145145     *                                           component directory and for feature active checks. eg. array( 'awesome' )
     
    331331     *
    332332     * @param array $includes An array of file names, or file name chunks,
    333      *        to be parsed and then included.
     333     *                        to be parsed and then included.
    334334     */
    335335    public function includes( $includes = array() ) {
     
    455455     *      in the $sub_nav parameter array should be formatted.
    456456     *
    457      * @param array $main_nav Optional. Passed directly to
    458      *        bp_core_new_nav_item(). See that function for a description.
    459      * @param array $sub_nav Optional. Multidimensional array, each item in
    460      *        which is passed to bp_core_new_subnav_item(). See that
    461      *        function for a description.
     457     * @param array $main_nav Optional. Passed directly to bp_core_new_nav_item().
     458     *                        See that function for a description.
     459     * @param array $sub_nav  Optional. Multidimensional array, each item in
     460     *                        which is passed to bp_core_new_subnav_item(). See that
     461     *                        function for a description.
    462462     */
    463463    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
     
    490490     * @see WP_Admin_Bar::add_menu() for a description of the syntax
    491491     *      required by each item in the $wp_admin_nav parameter array.
    492      * @global obj $wp_admin_bar
    493      *
    494      * @param array $wp_admin_nav An array of nav item arguments. Each item
    495      *        in this parameter array is passed to {@link WP_Admin_Bar::add_menu()}.
    496      *        See that method for a description of the required syntax for
    497      *        each item.
     492     * @global object $wp_admin_bar
     493     *
     494     * @param array $wp_admin_nav An array of nav item arguments. Each item in this parameter
     495     *                            array is passed to {@link WP_Admin_Bar::add_menu()}.
     496     *                            See that method for a description of the required syntax for
     497     *                            each item.
    498498     */
    499499    public function setup_admin_bar( $wp_admin_nav = array() ) {
     
    747747
    748748    /**
    749      * Add any permalink structures
     749     * Add any permalink structures.
    750750     *
    751751     * @since BuddyPress (1.9)
    752752     *
    753      * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_permastruct'
     753     * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_permastruct'.
    754754     */
    755755    public function add_permastructs() {
     
    766766
    767767    /**
    768      * Allow components to parse the main query
     768     * Allow components to parse the main query.
    769769     *
    770770     * @since BuddyPress (1.9)
    771771     *
    772772     * @uses do_action() Calls 'bp_{@link bp_Component::name}_parse_query'
    773      * @param object The main WP_Query
     773     * @param object $query The main WP_Query.
    774774     */
    775775    public function parse_query( $query ) {
     
    788788
    789789    /**
    790      * Generate any additional rewrite rules
     790     * Generate any additional rewrite rules.
    791791     *
    792792     * @since BuddyPress (1.5)
    793793     *
    794      * @uses do_action() Calls 'bp_{@link bp_Component::name}_generate_rewrite_rules'
     794     * @uses do_action() Calls 'bp_{@link bp_Component::name}_generate_rewrite_rules'.
    795795     */
    796796    public function generate_rewrite_rules() {
Note: See TracChangeset for help on using the changeset viewer.