Changeset 10012

trunk/src/bp-core/admin/bp-core-admin-actions.php

-                      r9819
+                      r10012
  * @since BuddyPress (1.7.0)
+ *
  * @param int $blog_id
  * @param int $user_id
+ * @param int    $blog_id
+ * @param int    $user_id
  * @param string $domain
  * @param string $path
  * @param int $site_id
  * @param array $meta
+ * @param int    $site_id
+ * @param array  $meta
  */
 function bp_new_site( $blog_id, $user_id, $domain, $path, $site_id, $meta ) {

trunk/src/bp-core/admin/bp-core-admin-components.php

-                      r9819
+                      r10012
 /**
  * BuddyPress Admin Component Functions
+ * BuddyPress Admin Component Functions.
+ *
  * @package BuddyPress
 …
 /**
  * Handle saving the Component settings
+ * Handle saving the Component settings.
+ *
  * @since BuddyPress (1.6.0)
 …
 /**
  * Calculates the components that should be active after save, based on submitted settings
+ * Calculates the components that should be active after save, based on submitted settings.
+ *
  * The way that active components must be set after saving your settings must
 …
  * @since BuddyPress (1.7.0)
+ *
+ * @param array This is the array of component settings coming from the POST
+ *   global. You should stripslashes_deep() before passing to this function
+ * @param array $submitted This is the array of component settings coming from the POST
+ *                         global. You should stripslashes_deep() before passing to this function.
+ *
  * @return array The calculated list of component settings
  */
 …
 /**
  * Return a list of component information, optionally filtered by type
+ * Return a list of component information, optionally filtered by type.
+ *
  * We use this information both to build the markup for the admin screens, as
 …
  * @since BuddyPress (1.7.0)
+ *
+ * @param string $type 'all', 'optional', 'retired', 'required'
+ * @param string $type 'all', 'optional', 'retired', 'required'.
+ *
  * @return array An array of requested component data
  */

trunk/src/bp-core/admin/bp-core-admin-functions.php

-                      r9873
+                      r10012
 /**
  * BuddyPress Common Admin Functions
+ * BuddyPress Common Admin Functions.
+ *
  * @package BuddyPress
 …
 /**
  * Print admin messages to admin_notices or network_admin_notices
+ * Print admin messages to admin_notices or network_admin_notices.
+ *
  * BuddyPress combines all its messages into a single notice, to avoid a preponderance of yellow
 …
  * @since BuddyPress (1.5.0)
+ *
  * @uses bp_current_user_can() to check current user permissions before showing the notices
+ * @uses bp_current_user_can() to check current user permissions before showing the notices.
  * @uses bp_is_root_blog()
  */
 …
 /**
  * Add an admin notice to the BP queue
+ * Add an admin notice to the BP queue.
+ *
  * Messages added with this function are displayed in BuddyPress's general purpose admin notices
 …
+ *
  * @param string $notice The notice you are adding to the queue.
  * @param string $type The notice type; optional. Usually either "updated" or "error".
+ * @param string $type   The notice type; optional. Usually either "updated" or "error".
  */
 function bp_core_add_admin_notice( $notice = '', $type = 'updated' ) {
 …
 /**
  * Verify that some BP prerequisites are set up properly, and notify the admin if not
+ * Verify that some BP prerequisites are set up properly, and notify the admin if not.
+ *
  * On every Dashboard page, this function checks the following:
  *   - that pretty permalinks are enabled
  *   - that every BP component that needs a WP page for a directory has one
  *   - that no WP page has multiple BP components associated with it
+ *   - that pretty permalinks are enabled.
+ *   - that every BP component that needs a WP page for a directory has one.
+ *   - that no WP page has multiple BP components associated with it.
  * The administrator will be shown a notice for each check that fails.
+ *
 …
 /**
  * Redirect user to BuddyPress's What's New page on activation
+ * Redirect user to BuddyPress's What's New page on activation.
+ *
  * @since BuddyPress (1.7.0)
+ *
  * @internal Used internally to redirect BuddyPress to the about page on activation
+ *
  * @uses get_transient() To see if transient to redirect exists
  * @uses delete_transient() To delete the transient if it exists
  * @uses is_network_admin() To bail if being network activated
  * @uses wp_safe_redirect() To redirect
  * @uses add_query_arg() To help build the URL to redirect to
  * @uses admin_url() To get the admin URL to index.php
+ * @internal Used internally to redirect BuddyPress to the about page on activation.
+ *
+ * @uses get_transient() To see if transient to redirect exists.
+ * @uses delete_transient() To delete the transient if it exists.
+ * @uses is_network_admin() To bail if being network activated.
+ * @uses wp_safe_redirect() To redirect.
+ * @uses add_query_arg() To help build the URL to redirect to.
+ * @uses admin_url() To get the admin URL to index.php.
  */
 function bp_do_activation_redirect() {
 …
 /**
  * Output the tabs in the admin area
+ * Output the tabs in the admin area.
+ *
  * @since BuddyPress (1.5.0)
+ *
  * @param string $active_tab Name of the tab that is active. Optional.
  */
 …
+ *
  * @since BuddyPress (2.2.0)
+ *
  * @param string $active_tab Name of the tab that is active. Optional.
+ *
+ * @return string
  */
 function bp_core_get_admin_tabs( $active_tab = '' ) {
 …
 /**
  * adds contextual help to BuddyPress admin pages
+ * adds contextual help to BuddyPress admin pages.
+ *
  * @since BuddyPress (1.7.0)
  * @todo Make this part of the BP_Component class and split into each component
+ *
+ * @param string $screen
  */
 function bp_core_add_contextual_help( $screen = '' ) {
 …
 /**
  * renders contextual help content to contextual help tabs
+ * renders contextual help content to contextual help tabs.
+ *
  * @since BuddyPress (1.7.0)
+ *
+ * @param string $tab
+ *
+ * @return string
  */
 function bp_core_add_contextual_help_content( $tab = '' ) {
 …
 /**
  * Add a separator to the WordPress admin menus
+ * Add a separator to the WordPress admin menus.
+ *
  * @since BuddyPress (1.7.0)
+ *
  * @uses bp_current_user_can() To check users capability on root blog
+ * @uses bp_current_user_can() To check users capability on root blog.
  */
 function bp_admin_separator() {
 …
 /**
  * Tell WordPress we have a custom menu order
+ * Tell WordPress we have a custom menu order.
+ *
  * @since BuddyPress (1.7.0)
+ *
+ * @param bool $menu_order Menu order
+ * @uses bp_current_user_can() To check users capability on root blog
+ * @uses bp_current_user_can() To check users capability on root blog.
+ *
+ * @param bool $menu_order Menu order.
+ *
  * @return bool Always true
  */
 …
 /**
  * Move our custom separator above our custom post types
+ * Move our custom separator above our custom post types.
+ *
  * @since BuddyPress (1.7.0)
+ *
+ * @param array $menu_order Menu Order
+ * @uses bp_current_user_can() To check users capability on root blog
+ * @uses bp_current_user_can() To check users capability on root blog.
+ *
+ * @param array $menu_order Menu Order.
+ *
  * @return array Modified menu order
  */
 …
 /**
  * When using a WP_List_Table, get the currently selected bulk action
+ * When using a WP_List_Table, get the currently selected bulk action.
+ *
  * WP_List_Tables have bulk actions at the top and at the bottom of the tables,
 …
+ *
  * @since BuddyPress (1.7.0)
+ *
  * @return string
  */
 …
 /**
  * Register meta box and associated JS for BuddyPress WP Nav Menu .
+ * Register meta box and associated JS for BuddyPress WP Nav Menu.
+ *
  * @since BuddyPress (1.9.0)
 …
  * @since BuddyPress (2.0.0)
+ *
  * @param array $actions User row action links.
+ * @param array  $actions     User row action links.
  * @param object $user_object Current user information.
+ *
  * @return array $actions User row action links.
  */

trunk/src/bp-core/admin/bp-core-admin-schema.php

-                      r9819
+                      r10012
 /**
  * BuddyPress DB schema
+ * BuddyPress DB schema.
+ *
  * @package BuddyPress
 …
 /**
  * Get the DB schema to use for BuddyPress components
+ * Get the DB schema to use for BuddyPress components.
+ *
  * @since BuddyPress (1.1.0)
+ *
  * @global $wpdb $wpdb
  * @return string The default database character-set, if set
+ * @return string The default database character-set, if set.
  */
 function bp_core_set_charset() {
 …
 /**
  * Main installer
+ * Main installer.
+ *
  * Can be passed an optional array of components to explicitly run installation
 …
  * @since BuddyPress (1.0.0)
+ *
  * @param array $active_components Components to install
+ * @param array|bool $active_components Components to install.
  */
 function bp_core_install( $active_components = false ) {
 …
 /**
  * Install database tables for the Notifications component
+ * Install database tables for the Notifications component.
+ *
  * @since BuddyPress (1.0.0)
 …
 /**
  * Install database tables for the Activity component
+ * Install database tables for the Activity component.
+ *
  * @since BuddyPress (1.0.0)
 …
 /**
  * Install database tables for the Notifications component
+ * Install database tables for the Notifications component.
+ *
  * @since BuddyPress (1.0.0)
 …
 /**
  * Install database tables for the Groups component
+ * Install database tables for the Groups component.
+ *
  * @since BuddyPress (1.0.0)
 …
 /**
  * Install database tables for the Messages component
+ * Install database tables for the Messages component.
+ *
  * @since BuddyPress (1.0.0)
 …
 /**
  * Install database tables for the Profiles component
+ * Install database tables for the Profiles component.
+ *
  * @since BuddyPress (1.0.0)
 …
 /**
  * Install database tables for the Sites component
+ * Install database tables for the Sites component.
+ *
  * @since BuddyPress (1.0.0)
 …
  * This is necessary because WordPress's `pre_schema_upgrade()` function wraps
  * table ALTER's in multisite checks, and other plugins may have installed their
  * own sign-ups table; Eg: Gravity Forms User Registration Add On
+ * own sign-ups table; Eg: Gravity Forms User Registration Add On.
+ *
  * @since BuddyPress (2.0.1)

trunk/src/bp-core/admin/bp-core-admin-settings.php

-                      r9828
+                      r10012
 /**
  * BuddyPress Admin Settings
+ * BuddyPress Admin Settings.
+ *
  * @package BuddyPress
 …
 /**
  * Main settings section description for the settings page
+ * Main settings section description for the settings page.
+ *
  * @since BuddyPress (1.6.0)
 …
 /**
  * Admin bar for logged out users setting field
+ *
  * @since BuddyPress (1.6.0)
+ *
  * @uses bp_form_option() To output the option value
+ * Admin bar for logged out users setting field.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @uses bp_form_option() To output the option value.
  */
 function bp_admin_setting_callback_admin_bar() {
 …
 /**
  * Allow members to delete their accounts setting field
+ *
  * @since BuddyPress (1.6.0)
+ *
  * @uses checked() To display the checked attribute
+ * Allow members to delete their accounts setting field.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @uses checked() To display the checked attribute.
  */
 function bp_admin_setting_callback_account_deletion() {
 …
 /**
  * Groups settings section description for the settings page
+ * Groups settings section description for the settings page.
+ *
  * @since BuddyPress (1.6.0)
 …
 /**
  * Allow Akismet setting field
+ *
  * @since BuddyPress (1.6.0)
+ *
  * @uses checked() To display the checked attribute
+ * Allow Akismet setting field.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @uses checked() To display the checked attribute.
  */
 function bp_admin_setting_callback_activity_akismet() {
 …
 /**
  * Allow activity comments on blog posts and forum posts
+ * Allow activity comments on blog posts and forum posts.
+ *
  * @since BuddyPress (1.6.0)
 …
 /**
  * Sanitization for bp-disable-blogforum-comments setting
+ * Sanitization for bp-disable-blogforum-comments setting.
+ *
  * In the UI, a checkbox asks whether you'd like to *enable* blog/forum activity comments. For
 …
+ *
  * @since BuddyPress (1.6.0)
+ *
+ * @param bool $value
+ *
+ * @return bool
  */
 function bp_admin_sanitize_callback_blogforum_comments( $value = false ) {
 …
 /**
  * Profile settings section description for the settings page
+ * Profile settings section description for the settings page.
+ *
  * @since BuddyPress (1.6.0)
 …
 /**
  * Enable BP->WP profile syncing field
+ *
  * @since BuddyPress (1.6.0)
+ *
  * @uses bp_form_option() To output the option value
+ * Enable BP->WP profile syncing field.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @uses bp_form_option() To output the option value.
  */
 function bp_admin_setting_callback_profile_sync() {
 …
 /**
  * Allow members to upload avatars field
+ *
  * @since BuddyPress (1.6.0)
+ *
  * @uses checked() To display the checked attribute
+ * Allow members to upload avatars field.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @uses checked() To display the checked attribute.
  */
 function bp_admin_setting_callback_avatar_uploads() {
 …
 /**
  * Groups settings section description for the settings page
+ * Groups settings section description for the settings page.
+ *
  * @since BuddyPress (1.6.0)
 …
 /**
  * Allow all users to create groups field
+ *
  * @since BuddyPress (1.6.0)
+ *
  * @uses checked() To display the checked attribute
+ * Allow all users to create groups field.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @uses checked() To display the checked attribute.
  */
 function bp_admin_setting_callback_group_creation() {
 …
 /**
  * Forums settings section description for the settings page
+ * Forums settings section description for the settings page.
+ *
  * @since BuddyPress (1.6.0)
 …
 /**
  * bb-config.php location field
+ *
  * @since BuddyPress (1.6.0)
  * @uses checked() To display the checked attribute
  * @uses bp_get_option() To get the config location
  * @uses bp_form_option() To get the sanitized form option
+ * bb-config.php location field.
+ *
+ * @since BuddyPress (1.6.0)
+ * @uses checked() To display the checked attribute.
+ * @uses bp_get_option() To get the config location.
+ * @uses bp_form_option() To get the sanitized form option.
  */
 function bp_admin_setting_callback_bbpress_configuration() {
 …
  * @since BuddyPress (1.6.0)
+ *
  * @uses screen_icon() To display the screen icon
  * @uses settings_fields() To output the hidden fields for the form
  * @uses do_settings_sections() To output the settings sections
+ * @uses screen_icon() To display the screen icon.
+ * @uses settings_fields() To output the hidden fields for the form.
+ * @uses do_settings_sections() To output the settings sections.
  */
 function bp_core_admin_settings() {
 …
 /**
  * Save our settings
+ * Save our settings.
+ *
  * @since BuddyPress (1.6.0)
 …
 /**
  * Output settings API option
+ * Output settings API option.
+ *
  * @since BuddyPress (1.6.0)
 …
  * @param string $option
  * @param string $default
  * @param bool $slug
+ * @param bool   $slug
  */
 function bp_form_option( $option, $default = '' , $slug = false ) {
 …
      * @param string $option
      * @param string $default
+     * @param bool $slug
+     * @param bool   $slug
+     *
+     * @return string
      */
     function bp_get_form_option( $option, $default = '', $slug = false ) {

trunk/src/bp-core/admin/bp-core-admin-slugs.php

-                      r9819
+                      r10012
 /**
  * BuddyPress Admin Slug Functions
+ * BuddyPress Admin Slug Functions.
+ *
  * @package BuddyPress
 …
 /**
  * Handle saving of the BuddyPress slugs
+ * Handle saving of the BuddyPress slugs.
+ *
  * @since BuddyPress (1.6.0)

trunk/src/bp-core/admin/bp-core-admin-tools.php

-                      r9819
+                      r10012
 /**
  * BuddyPress Tools panel
+ * BuddyPress Tools panel.
+ *
  * @since BuddyPress (2.0.0)
 …
 /**
  * Recalculate user-to-blog relationships and useful blog meta data
+ * Recalculate user-to-blog relationships and useful blog meta data.
+ *
  * @since BuddyPress (2.1.0)
 …
  * @since BuddyPress (2.0.0)
+ *
+ * @param string $message Feedback message.
+ * @param unknown $class Unused.
+ * @param string      $message Feedback message.
+ * @param string|bool $class   Unused.
+ *
+ * @return bool
  */
 function bp_admin_tools_feedback( $message, $class = false ) {

trunk/src/bp-core/bp-core-actions.php

-                      r9819
+                      r10012
 /**
  * bp_loaded - Attached to 'plugins_loaded' above
+ * bp_loaded - Attached to 'plugins_loaded' above.
+ *
  * Attach various loader actions to the bp_loaded action.
 …
 /**
  * bp_init - Attached to 'init' above
+ * bp_init - Attached to 'init' above.
+ *
  * Attach various initialization actions to the bp_init action.
 …
 /**
  * bp_template_redirect - Attached to 'template_redirect' above
+ * bp_template_redirect - Attached to 'template_redirect' above.
+ *
  * Attach various template actions to the bp_template_redirect action.
 …
 /**
  * Add the BuddyPress functions file
+ * Add the BuddyPress functions file.
  */
 add_action( 'bp_after_setup_theme', 'bp_load_theme_functions', 1 );

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

-                      r9909
+                      r10012
      * @since BuddyPress (1.6.0)
+     *
+     * @param array $links Links array in which we would prepend our link.
+     * @param string $file Current plugin basename.
+     * @param array  $links Links array in which we would prepend our link.
+     * @param string $file  Current plugin basename.
+     *
      * @return array Processed links.
      */
 …
     /**
      * Output welcome text and badge for What's New and Credits pages
+     * Output welcome text and badge for What's New and Credits pages.
+     *
      * @since BuddyPress (2.2.0)
 …
     /**
      * Output tab navigation for `What's New` and `Credits` pages
+     * Output tab navigation for `What's New` and `Credits` pages.
+     *
      * @since BuddyPress (2.2.0)
 …
     /**
      * Return true/false based on whether a query argument is set
+     * Return true/false based on whether a query argument is set.
+     *
      * @see bp_do_activation_redirect()
+     *
      * @since BuddyPress (2.2.0)
+     *
      * @return bool
      */
 …
     /**
      * Return a user-friendly version-number string, for use in translations
+     * Return a user-friendly version-number string, for use in translations.
+     *
      * @since BuddyPress (2.2.0)
+     *
      * @return string
      */

trunk/src/bp-core/bp-core-adminbar.php

r9819	r10012
111	111
112	112	/**
113		* Enqueue supplemental WordPress Toolbar styling
	113	* Enqueue supplemental WordPress Toolbar styling.
114	114	*
115	115	* @since BuddyPress (2.1.0)

trunk/src/bp-core/bp-core-attachments.php

-                      r9860
+                      r10012
  * @since  BuddyPress (2.3.0)
+ *
  * @return bool True if WordPress is 3.9+, false otherwise
+ * @return bool True if WordPress is 3.9+, false otherwise.
  */
 function bp_attachments_is_wp_version_supported() {
 …
 /**
  * Get the BuddyPress Plupload settings
+ *
  * @since  BuddyPress (2.3.0)
+ *
  * @return array list of BuddyPress Plupload settings
+ * Get the BuddyPress Plupload settings.
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @return array list of BuddyPress Plupload settings.
  */
 function bp_attachments_get_plupload_default_settings() {
 …
 /**
  * Builds localization strings for the BuddyPress Uploader scripts
+ *
  * @since  BuddyPress (2.3.0)
+ *
  * @return array Plupload default localization strings
+ * Builds localization strings for the BuddyPress Uploader scripts.
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @return array Plupload default localization strings.
  */
 function bp_attachments_get_plupload_l10n() {
 …
 /**
  * Enqueues the script needed for the Uploader UI
+ * Enqueues the script needed for the Uploader UI.
+ *
  * @see  BP_Attachment::script_data() && BP_Attachment_Avatar::script_data() for examples showing how
+ * to set specific script data
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @param  string $class name of the class extending BP_Attachment (eg: BP_Attachment_Avatar)
+ * to set specific script data.
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @param  string $class name of the class extending BP_Attachment (eg: BP_Attachment_Avatar).
+ *
+ * @return null|WP_Error
  */
 function bp_attachments_enqueue_scripts( $class = '' ) {
 …
         /**
          * Use this filter to add a navigation to a custom tool to set the object's avatar
+         * Use this filter to add a navigation to a custom tool to set the object's avatar.
+         *
          * @since BuddyPress (2.3.0)
 …
          * @param array $avatar_nav An associative array of available nav items where each item is an array organized this way:
          * $avatar_nav[ $nav_item_id ] {
          *     @type string $nav_item_id the nav item id in lower case without special characters or space
          *     @type string $caption     the name of the item nav that will be displayed in the nav
          *     @type int    $order       An integer to specify the priority of the item nav, choose one
          *                               between 1 and 99 to be after the uploader nav item and before the delete nav item
          *     @type int    $hide        if set to 1 the item nav will be hidden
          *                               (only used for the delete nav item)
+         *     @type string $nav_item_id The nav item id in lower case without special characters or space.
+         *     @type string $caption     The name of the item nav that will be displayed in the nav.
+         *     @type int    $order       An integer to specify the priority of the item nav, choose one.
+         *                               between 1 and 99 to be after the uploader nav item and before the delete nav item.
+         *     @type int    $hide        If set to 1 the item nav will be hidden
+         *                               (only used for the delete nav item).
          * }
          * @param string $object the object the avatar belongs to (eg: user or group)
 …
      * to avoid the scripts to be loaded more than once.
+     *
      * @since BuddyPress 2.3.0
+     * @since BuddyPress (2.3.0)
      */
     do_action( 'bp_attachments_enqueue_scripts' );
 …
 /**
+ * Check the current user's capability to edit an avatar for a given object
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @param  string $capability the capability to check
+ * @param  array  $args an array containing the item_id and the object to check
+ * Check the current user's capability to edit an avatar for a given object.
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @param  string $capability The capability to check.
+ * @param  array  $args       An array containing the item_id and the object to check.
+ *
+ * @return bool
  */
 function bp_attachments_current_user_can( $capability, $args = array() ) {
 …
  * @since  BuddyPress (2.3.0)
+ *
  * @param  bool true for a success, false otherwise
  * @param  bool true if the Plupload runtime used is html4, false otherwise.
  * @param  mixed $data Data to encode as JSON, then print and die.
+ * @param  bool  $success  True for a success, false otherwise.
+ * @param  bool  $is_html4 True if the Plupload runtime used is html4, false otherwise.
+ * @param  mixed $data     Data to encode as JSON, then print and die.
  */
 function bp_attachments_json_response( $success, $is_html4 = false, $data = null ) {
 …
  * Get an Attachment template part.
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @param  string Template part slug. eg 'uploader' for 'uploader.php'.
+ * @since BuddyPress (2.3.0)
+ *
+ * @param string $slug Template part slug. eg 'uploader' for 'uploader.php'.
+ *
+ * @return bool
  */
 function bp_attachments_get_template_part( $slug ) {

trunk/src/bp-core/bp-core-avatars.php

-                      r9860
+                      r10012
  *    add_filter( 'bp_core_fetch_avatar_no_grav', '__return_true' );
+ *
  * @param array $args {
+ * @param array|string $args {
  *     An array of arguments. All arguments are technically optional; some
  *     will, if not provided, be auto-detected by bp_core_fetch_avatar(). This
 …
  *     arguments.
+ *
  *     @type int|bool $item_id The numeric ID of the item for which you're
  *           requesting an avatar (eg, a user ID). If no 'item_id' is present,
  *           the function attempts to infer an ID from the 'object' + the
  *           current context: if 'object' is 'user' and the current page is a
  *           user page, 'item_id' will default to the displayed user ID; if
  *           'group' and on a group page, to the current group ID; if 'blog',
  *           to the current blog's ID. If no 'item_id' can be determined in
  *           this way, the function returns false. Default: false.
  *     @type string $object The kind of object for which you're getting an
  *           avatar. BuddyPress natively supports three options: 'user',
  *           'group', 'blog'; a plugin may register more.  Default: 'user'.
  *     @type string $type When a new avatar is uploaded to BP, 'thumb' and
  *           'full' versions are saved. This parameter specifies whether you'd
  *           like the 'full' or smaller 'thumb' avatar. Default: 'thumb'.
+ *     @type int|bool    $item_id    The numeric ID of the item for which you're requesting
+ *                                   an avatar (eg, a user ID). If no 'item_id' is present,
+ *                                   the function attempts to infer an ID from the 'object' + the
+ *                                   current context: if 'object' is 'user' and the current page is a
+ *                                   user page, 'item_id' will default to the displayed user ID; if
+ *                                   'group' and on a group page, to the current group ID; if 'blog',
+ *                                   to the current blog's ID. If no 'item_id' can be determined in
+ *                                   this way, the function returns false. Default: false.
+ *     @type string      $object     The kind of object for which you're getting an
+ *                                   avatar. BuddyPress natively supports three options: 'user',
+ *                                   'group', 'blog'; a plugin may register more.  Default: 'user'.
+ *     @type string      $type       When a new avatar is uploaded to BP, 'thumb' and
+ *                                   'full' versions are saved. This parameter specifies whether you'd
+ *                                   like the 'full' or smaller 'thumb' avatar. Default: 'thumb'.
  *     @type string|bool $avatar_dir The name of the subdirectory where the
  *           requested avatar should be found. If no value is passed,
  *           'avatar_dir' is inferred from 'object': 'user' becomes 'avatars',
  *           'group' becomes 'group-avatars', 'blog' becomes 'blog-avatars'.
  *           Remember that this string denotes a subdirectory of BP's main
  *           avatar directory (usually based on {@link wp_upload_dir()}); it's a
  *           string like 'group-avatars' rather than the full directory path.
  *           Generally, it'll only be necessary to override the default value if
  *           storing avatars in a non-default location. Defaults to false
  *           (auto-detected).
  *     @type int|bool $width Requested avatar width. The unit is px. This value
  *           is used to build the 'width' attribute for the <img> element. If
  *           no value is passed, BP uses the global avatar width for this
  *           avatar type. Default: false (auto-detected).
  *     @type int|bool $height Requested avatar height. The unit is px. This
  *           value is used to build the 'height' attribute for the <img>
  *           element. If no value is passed, BP uses the global avatar height
  *           for this avatar type. Default: false (auto-detected).
  *     @type string $class The CSS class for the <img> element. Note that BP
  *           uses the 'avatar' class fairly extensively in its default styling,
  *           so if you plan to pass a custom value, consider appending it to
  *           'avatar' (eg 'avatar foo') rather than replacing it altogether.
  *           Default: 'avatar'.
  *     @type string|bool $css_id The CSS id for the <img> element.
  *           Default: false.
  *     @type string $title The title attribute for the <img> element.
  *           Default: false.
  *     @type string $alt The alt attribute for the <img> element. In BP, this
  *           value is generally passed by the wrapper functions, where the data
  *           necessary for concatenating the string is at hand; see
  *           {@link bp_get_activity_avatar()} for an example. Default: ''.
  *     @type string|bool $email An email to use in Gravatar queries. Unless
  *           otherwise configured, BP uses Gravatar as a fallback for avatars
  *           that are not provided locally. Gravatar's API requires using a hash
  *           of the user's email address; this argument provides it. If not
  *           provided, the function will infer it: for users, by getting the
  *           user's email from the database, for groups/blogs, by concatenating
  *           "{$item_id}-{$object}@{bp_get_root_domain()}". The user query adds
  *           overhead, so it's recommended that wrapper functions provide a
  *           value for 'email' when querying user IDs. Default: false.
  *     @type bool $no_grav Whether to disable the default Gravatar fallback.
  *           By default, BP will fall back on Gravatar when it cannot find a
  *           local avatar. In some cases, this may be undesirable, in which
  *           case 'no_grav' should be set to true. To disable Gravatar
  *           fallbacks globally, see the 'bp_core_fetch_avatar_no_grav' filter.
  *           Default: false.
  *     @type bool $html Whether to return an <img> HTML element, vs a raw URL
  *           to an avatar. If false, <img>-specific arguments (like 'css_id')
  *           will be ignored. Default: true.
+ *                                   requested avatar should be found. If no value is passed,
+ *                                   'avatar_dir' is inferred from 'object': 'user' becomes 'avatars',
+ *                                   'group' becomes 'group-avatars', 'blog' becomes 'blog-avatars'.
+ *                                   Remember that this string denotes a subdirectory of BP's main
+ *                                   avatar directory (usually based on {@link wp_upload_dir()}); it's a
+ *                                   string like 'group-avatars' rather than the full directory path.
+ *                                   Generally, it'll only be necessary to override the default value if
+ *                                   storing avatars in a non-default location. Defaults to false
+ *                                   (auto-detected).
+ *     @type int|bool    $width      Requested avatar width. The unit is px. This value
+ *                                   is used to build the 'width' attribute for the <img> element. If
+ *                                   no value is passed, BP uses the global avatar width for this
+ *                                   avatar type. Default: false (auto-detected).
+ *     @type int|bool    $height     Requested avatar height. The unit is px. This
+ *                                   value is used to build the 'height' attribute for the <img>
+ *                                   element. If no value is passed, BP uses the global avatar height
+ *                                   for this avatar type. Default: false (auto-detected).
+ *     @type string      $class      The CSS class for the <img> element. Note that BP
+ *                                   uses the 'avatar' class fairly extensively in its default styling,
+ *                                   so if you plan to pass a custom value, consider appending it to
+ *                                   'avatar' (eg 'avatar foo') rather than replacing it altogether.
+ *                                   Default: 'avatar'.
+ *     @type string|bool $css_id     The CSS id for the <img> element.
+ *                                   Default: false.
+ *     @type string      $title      The title attribute for the <img> element.
+ *                                   Default: false.
+ *     @type string      $alt        The alt attribute for the <img> element. In BP, this
+ *                                   value is generally passed by the wrapper functions, where the data
+ *                                   necessary for concatenating the string is at hand; see
+ *                                   {@link bp_get_activity_avatar()} for an example. Default: ''.
+ *     @type string|bool $email      An email to use in Gravatar queries. Unless
+ *                                   otherwise configured, BP uses Gravatar as a fallback for avatars
+ *                                   that are not provided locally. Gravatar's API requires using a hash
+ *                                   of the user's email address; this argument provides it. If not
+ *                                   provided, the function will infer it: for users, by getting the
+ *                                   user's email from the database, for groups/blogs, by concatenating
+ *                                   "{$item_id}-{$object}@{bp_get_root_domain()}". The user query adds
+ *                                   overhead, so it's recommended that wrapper functions provide a
+ *                                   value for 'email' when querying user IDs. Default: false.
+ *     @type bool       $no_grav     Whether to disable the default Gravatar fallback.
+ *                                   By default, BP will fall back on Gravatar when it cannot find a
+ *                                   local avatar. In some cases, this may be undesirable, in which
+ *                                   case 'no_grav' should be set to true. To disable Gravatar
+ *                                   fallbacks globally, see the 'bp_core_fetch_avatar_no_grav' filter.
+ *                                   Default: false.
+ *     @type bool       $html        Whether to return an <img> HTML element, vs a raw URL
+ *                                   to an avatar. If false, <img>-specific arguments (like 'css_id')
+ *                                   will be ignored. Default: true.
  * }
+ *
  * @return string Formatted HTML <img> element, or raw avatar URL based on $html arg.
  */
 …
                 return apply_filters( 'bp_core_fetch_avatar', '<img src="' . $avatar_url . '"' . $html_class . $html_css_id  . $html_width . $html_height . $html_alt . $html_title . ' />', $params, $params['item_id'], $params['avatar_dir'], $html_css_id, $html_width, $html_height, $avatar_folder_url, $avatar_folder_dir );
             // ...or only the URL
+                // ...or only the URL
             } else {
 …
+        }
     // No avatar was found, and we've been told not to use a gravatar.
+        // No avatar was found, and we've been told not to use a gravatar.
     } else {
 …
  * Delete an existing avatar.
+ *
  * @param array $args {
+ * @param array|string $args {
  *     Array of function parameters.
  *     @type bool|int $item_id ID of the item whose avatar you're deleting.
 …
 /**
  * Ajax delete an avatar for a given object and item id
+ *
  * @since  BuddyPress (2.3.0)
+ *
  * @return  string a json object containing success data if the avatar was deleted
  *                 error message otherwise
+ * Ajax delete an avatar for a given object and item id.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @return string|null A json object containing success data if the avatar was deleted
+ *                     error message otherwise.
  */
 function bp_avatar_ajax_delete() {
 …
 /**
  * Ajax upload an avatar
+ * Ajax upload an avatar.
+ *
  * @since BuddyPress (2.3.0)
+ *
  * @return  string a json object containing success data if the upload succeeded
  *                 error message otherwise
+ * @return  string|null A json object containing success data if the upload succeeded
+ *                      error message otherwise.
  */
 function bp_avatar_ajax_upload() {
 …
     } else {
         /**
          * Filter here to deal with other components
+         * Filter here to deal with other components.
+         *
          * @since BuddyPress (2.3.0)
+         *
          * @var array $bp_params the BuddyPress Ajax parameters
+         * @var array $bp_params the BuddyPress Ajax parameters.
          */
         $bp_params = apply_filters( 'bp_core_avatar_ajax_upload_params', $bp_params );
 …
  * @since BuddyPress (2.3.0)
+ *
+ * @param string $data base64 encoded image.
+ * @param int $item_id.
+ * @param string $data     Base64 encoded image.
+ * @param int    $item_id.
+  *
  * @return bool True on success, false on failure.
  */
 …
+    }
+    /**
+     * Filters the Avatar folder directory.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $avatar_dir Directory for storing avatars.
+     * @param int    $item_id    ID of the item being acted on.
+     * @param string $value      Avatar type.
+     * @param string $value      Avatars word.
+     */
     $avatar_folder_dir = apply_filters( 'bp_core_avatar_folder_dir', $avatar_dir . '/' . $item_id, $item_id, 'user', 'avatars' );
 …
         $crop_args = array( 'item_id' => $item_id, 'original_file' => $avatar_to_crop, 'crop_x' => 0, 'crop_y' => 0 );
+        /**
+         * Fires if the new avatar was successfully captured.
+         *
+         * @since BuddyPress (2.3.0)
+         */
         do_action( 'xprofile_avatar_uploaded' );
 …
  *  crop_y - The vertical starting point of the crop
+ *
  * @param array $args {
+ * @param array|string $args {
  *     Array of function parameters.
+ *     @type string $object Object type of the item whose avatar you're
+ *           handling. 'user', 'group', 'blog', or custom. Default: 'user'.
+ *     @type string $avatar_dir Subdirectory where avatar should be stored.
+ *           Default: 'avatars'.
+ *     @type bool|int $item_id ID of the item that the avatar belongs to.
+ *     @type bool|string $original_file Absolute path to the original avatar
+ *           file.
+ *     @type int $crop_w Crop width. Default: the global 'full' avatar width,
+ *           as retrieved by bp_core_avatar_full_width().
+ *     @type int $crop_h Crop height. Default: the global 'full' avatar height,
+ *           as retrieved by bp_core_avatar_full_height().
+ *     @type int $crop_x The horizontal starting point of the crop. Default: 0.
+ *     @type int $crop_y The vertical starting point of the crop. Default: 0.
+ *
+ *     @type string      $object        Object type of the item whose avatar you're
+ *                                      handling. 'user', 'group', 'blog', or custom.
+ *                                      Default: 'user'.
+ *     @type string      $avatar_dir    Subdirectory where avatar should be stored.
+ *                                      Default: 'avatars'.
+ *     @type bool|int    $item_id       ID of the item that the avatar belongs to.
+ *     @type bool|string $original_file Absolute path to the original avatar file.
+ *     @type int         $crop_w        Crop width. Default: the global 'full' avatar width,
+ *                                      as retrieved by bp_core_avatar_full_width().
+ *     @type int         $crop_h        Crop height. Default: the global 'full' avatar height,
+ *                                      as retrieved by bp_core_avatar_full_height().
+ *     @type int         $crop_x        The horizontal starting point of the crop. Default: 0.
+ *     @type int         $crop_y        The vertical starting point of the crop. Default: 0.
  * }
+ *
  * @return bool True on success, false on failure.
  */
 …
+     *
      * @param bool  $value Whether or not to crop.
      * @param array $r     Array of parsed arguments for function
+     * @param array $r     Array of parsed arguments for function.
      */
     if ( ! apply_filters( 'bp_core_pre_avatar_handle_crop', true, $r ) ) {
 …
 /**
  * Ajax set an avatar for a given object and item id
+ * Ajax set an avatar for a given object and item id.
+ *
  * @since BuddyPress (2.3.0)
+ *
  * @return  string a json object containing success data if the crop/capture succeeded
  *                 error message otherwise
+ * @return  string|null A json object containing success data if the crop/capture succeeded
+ *                      error message otherwise.
  */
 function bp_avatar_ajax_set() {
 …
  * Filters 'get_avatar'.
+ *
+ * @param string $avatar The avatar path passed to 'get_avatar'.
+ * @param int|string|object $user A user ID, email address, or comment object.
+ * @param int $size Size of the avatar image ('thumb' or 'full').
+ * @param string $default URL to a default image to use if no avatar is available.
+ * @param string $alt Alternate text to use in image tag. Default: ''.
+ * @param string            $avatar  The avatar path passed to 'get_avatar'.
+ * @param int|string|object $user    A user ID, email address, or comment object.
+ * @param int               $size    Size of the avatar image ('thumb' or 'full').
+ * @param string            $default URL to a default image to use if no avatar is available.
+ * @param string            $alt     Alternate text to use in image tag. Default: ''.
+ *
  * @return string BP avatar path, if found; else the original avatar path.
  */
 …
+ *
  * @param array $file The $_FILES array.
+ *
  * @return bool True if no errors are found. False if there are errors.
  */
 …
+ *
  * @param array $file The $_FILES array.
+ *
  * @return bool True if the avatar is under the size limit, otherwise false.
  */
 …
 /**
  * Get allowed avatar types
+ *
  * @since  BuddyPress (2.3.0)
+ * Get allowed avatar types.
+ *
+ * @since BuddyPress (2.3.0)
  */
 function bp_core_get_allowed_avatar_types() {
 …
     /**
      * Use this filter to restrict image types
+     * Filters the list of allowed image types.
+     *
      * @since BuddyPress (2.3.0)
+     *
      * @param array list of image types
+     * @param array $allowed_types List of image types.
      */
     $avatar_types = (array) apply_filters( 'bp_core_get_allowed_avatar_types', $allowed_types );
 …
 /**
  * Get allowed avatar mime types
+ *
  * @since  BuddyPress (2.3.0)
+ * Get allowed avatar mime types.
+ *
+ * @since BuddyPress (2.3.0)
  */
 function bp_core_get_allowed_avatar_mimes() {
 …
+ *
  * @param array $file The $_FILES array.
+ *
  * @return bool True if the file extension is permitted, otherwise false.
  */
 …
  * @since BuddyPress (1.8.0)
+ *
+ * @param string $type The variable we want to return from the $bp->avatars
+ *        object. Only 'upload_path' and 'url' are supported. Default: 'upload_path'.
+ * @param string $type The variable we want to return from the $bp->avatars object.
+ *                     Only 'upload_path' and 'url' are supported. Default: 'upload_path'.
+ *
  * @return string The avatar upload directory path.
  */
 …
  * Get the absolute upload path for the WP installation.
+ *
  * @uses bp_core_get_upload_dir() To get upload directory info
+ * @uses bp_core_get_upload_dir() To get upload directory info.
+ *
  * @return string Absolute path to WP upload directory.
 …
+ *
  * @param int $user_id ID of the user whose avatar is being checked.
+ *
  * @return bool True if the user has uploaded a local avatar. Otherwise false.
  */
 …
  * @since BuddyPress (1.5.0)
+ *
  * @param string $type Dimension type you're fetching dimensions for. 'thumb'
  *        or 'full'. Default: 'thumb'.
+ * @param string $type   Dimension type you're fetching dimensions for. 'thumb'
+ *                       or 'full'. Default: 'thumb'.
  * @param string $h_or_w Which dimension is being fetched. 'height' or 'width'.
+ *        Default: 'height'.
+ * @return int $dim The dimension.
+ *                       Default: 'height'.
+ *
+ * @return int|bool $dim The dimension.
  */
 function bp_core_avatar_dimension( $type = 'thumb', $h_or_w = 'height' ) {
 …
      * @since BuddyPress (1.5.0)
+     *
      * @param int    $dim    Dimension setting for the type.
      * @param string $type   The type of avatar whose dimensions are requested. Default 'thumb'.
      * @param string $h_or_w The dimension parameter being requested. Default 'height'.
+     * @param int|bool $dim    Dimension setting for the type.
+     * @param string   $type   The type of avatar whose dimensions are requested. Default 'thumb'.
+     * @param string   $h_or_w The dimension parameter being requested. Default 'height'.
      */
     return apply_filters( 'bp_core_avatar_dimension', $dim, $type, $h_or_w );
 …
 /**
  * Get the 'full' avatar width setting
+ * Get the 'full' avatar width setting.
+ *
  * @since BuddyPress (1.5.0)
 …
  * @since BuddyPress (1.5.0)
+ *
+ * @param string $type 'local' if the fallback should be the locally-hosted
+ *        version of the mystery-man, 'gravatar' if the fallback should be
+ *        Gravatar's version. Default: 'gravatar'.
+ * @param string $type 'local' if the fallback should be the locally-hosted version
+ *                     of the mystery-man, 'gravatar' if the fallback should be
+ *                     Gravatar's version. Default: 'gravatar'.
+ *
  * @return string The URL of the default avatar.
  */
 …
  * @since BuddyPress (1.5.0)
+ *
+ * @param string $type 'local' if the fallback should be the locally-hosted
+ *        version of the mystery-man, 'gravatar' if the fallback should be
+ *        Gravatar's version. Default: 'gravatar'.
+ * @param string $type 'local' if the fallback should be the locally-hosted version
+ *                     of the mystery-man, 'gravatar' if the fallback should be
+ *                     Gravatar's version. Default: 'gravatar'.
+ *
  * @return string The URL of the default avatar thumb.
  */
 …
 /**
  * Reset the week parameter of the WordPress main query if needed
+ * Reset the week parameter of the WordPress main query if needed.
+ *
  * When cropping an avatar, a $_POST['w'] var is sent, setting the 'week'
  * parameter of the WordPress main query to this posted var. To avoid
  * notices, we need to make sure this 'week' query var is reset to 0
+ * notices, we need to make sure this 'week' query var is reset to 0.
+ *
  * @since  BuddyPress (2.2.0)
+ *
+ * @param  WP_Query $posts_query the main query object
+ * @param  WP_Query|null $posts_query the main query object.
+ *
  * @uses   bp_is_group_create()
  * @uses   bp_is_group_admin_page()
 …
 /**
  * Checks whether Avatar UI should be loaded
+ * Checks whether Avatar UI should be loaded.
+ *
  * @since  BuddyPress (2.3.0)
+ *
  * @return bool True if Avatar UI should load, false otherwise
+ * @return bool True if Avatar UI should load, false otherwise.
  */
 function bp_avatar_is_front_edit() {
 …
      * @since  BuddyPress (2.3.0)
+     *
      * @var  bool whether to load the Avatar UI
+     * @param bool whether to load the Avatar UI.
      */
     return apply_filters( 'bp_avatar_is_front_edit', $retval );
 …
 /**
  * Checks whether the Webcam Avatar UI part should be loaded
+ * Checks whether the Webcam Avatar UI part should be loaded.
+ *
  * @since  BuddyPress (2.3.0)
 …
      * by returning false.
+     *
      * @since  BuddyPress (2.3.0)
+     *
      * @var  bool whether to load Webcam Avatar UI part
+     * @since BuddyPress (2.3.0)
+     *
+     * @param bool whether to load Webcam Avatar UI part.
      */
     return apply_filters( 'bp_avatar_use_webcam', true );
 …
 /**
  * Template function to load the Avatar UI javascript templates
+ * Template function to load the Avatar UI javascript templates.
+ *
  * @since  BuddyPress (2.3.0)
 …
 /**
  * Trick to check if the theme's BuddyPress templates are up to date
+ * Trick to check if the theme's BuddyPress templates are up to date.
+ *
  * If the "avatar templates" are not including the new template tag, this will

trunk/src/bp-core/bp-core-buddybar.php

-                      r10003
+                      r10012
 /**
  * Add an item to the main BuddyPress navigation array.
+ *
+ * @param array|string $args {
+ *     Array describing the new nav item.
+ *     @type string      $name                    Display name for the nav item.
+ *     @type string      $slug                    Unique URL slug for the nav item.
+ *     @type bool|string $item_css_id             Optional. 'id' attribute for the nav item. Default: the value of `$slug`.
+ *     @type bool        $show_for_displayed_user Optional. Whether the nav item should be visible when viewing a
+ *                                                member profile other than your own. Default: true.
+ *     @type bool        $site_admin_only         Optional. Whether the nav item should be visible only to site admins
+ *                                                (those with the 'bp_moderate' cap). Default: false.
+ *     @type int         $position                Optional. Numerical index specifying where the item should appear in
+ *                                                the nav array. Default: 99.
+ *     @type callable    $screen_function         The callback function that will run when the nav item is clicked.
+ *     @type bool|string $default_subnav_slug     Optional. The slug of the default subnav item to select when the nav
+ *                                                item is clicked.
+ * }
+ * @return bool|null Returns false on failure.
+ */
+function bp_core_new_nav_item( $args = '' ) {
+    $defaults = array(
+        'name'                    => false, // Display name for the nav item
+        'slug'                    => false, // URL slug for the nav item
+        'item_css_id'             => false, // The CSS ID to apply to the HTML of the nav item
+        'show_for_displayed_user' => true,  // When viewing another user does this nav item show up?
+        'site_admin_only'         => false, // Can only site admins see this nav item?
+        'position'                => 99,    // Index of where this nav item should be positioned
+        'screen_function'         => false, // The name of the function to run when clicked
+        'default_subnav_slug'     => false  // The slug of the default subnav item to select when clicked
+    );
+    $r = wp_parse_args( $args, $defaults );
+    // First, add the nav item link to the bp_nav array.
+    $created = bp_core_create_nav_link( $r );
+    // To mimic the existing behavior, if bp_core_create_nav_link()
+    // returns false, we make an early exit and don't attempt to register
+    // the screen function.
+    if ( false === $created ) {
+        return false;
+    }
+    // Then, hook the screen function for the added nav item.
+    bp_core_register_nav_screen_function( $r );
+    /**
+     * Fires after adding an item to the main BuddyPress navigation array.
+     * Note that, when possible, the more specific action hooks
+     * `bp_core_create_nav_link` or `bp_core_register_nav_screen_function`
+     * should be used.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param array $r        Parsed arguments for the nav item.
+     * @param array $args     Originally passed in arguments for the nav item.
+     * @param array $defaults Default arguments for a nav item.
+     */
+    do_action( 'bp_core_new_nav_item', $r, $args, $defaults );
+}
+/**
+ * Add a link to the main BuddyPress navigation array.
+ *
+ * @since BuddyPress (2.4.0)
+ *
  * @param array $args {
 …
  * @return bool|null Returns false on failure.
  */
+function bp_core_new_nav_item( $args = '' ) {
+function bp_core_create_nav_link( $args = '' ) {
+    $bp = buddypress();
     $defaults = array(
 …
     $r = wp_parse_args( $args, $defaults );
+    // First, add the nav item link to the bp_nav array.
+    $created = bp_core_create_nav_link( $r );
+    // To mimic the existing behavior, if bp_core_create_nav_link()
+    // returns false, we make an early exit and don't attempt to register
+    // the screen function.
+    if ( false === $created ) {
+        return false;
+    }
+    // Then, hook the screen function for the added nav item.
+    bp_core_register_nav_screen_function( $r );
+    // If we don't have the required info we need, don't create this nav item.
+    if ( empty( $r['name'] ) || empty( $r['slug'] ) ) {
+        return false;
+    }
+    // If this is for site admins only and the user is not one, don't create the nav item.
+    if ( ! empty( $r['site_admin_only'] ) && ! bp_current_user_can( 'bp_moderate' ) ) {
+        return false;
+    }
     /**
+     * Fires after adding an item to the main BuddyPress navigation array.
+     * Note that, when possible, the more specific action hooks
+     * `bp_core_create_nav_link` or `bp_core_register_nav_screen_function`
+     * should be used.
+     * If this nav item is hidden for the displayed user, and
+     * the logged in user is not the displayed user
+     * looking at their own profile, don't create the nav item.
+     */
+    if ( empty( $r['show_for_displayed_user'] ) && ! bp_user_has_access() ) {
+        return false;
+    }
+    if ( empty( $r['item_css_id'] ) ) {
+        $r['item_css_id'] = $r['slug'];
+    }
+    $bp->bp_nav[$r['slug']] = array(
+        'name'                    => $r['name'],
+        'slug'                    => $r['slug'],
+        'link'                    => trailingslashit( bp_loggedin_user_domain() . $r['slug'] ),
+        'css_id'                  => $r['item_css_id'],
+        'show_for_displayed_user' => $r['show_for_displayed_user'],
+        'position'                => $r['position'],
+        'screen_function'         => &$r['screen_function'],
+        'default_subnav_slug'     => $r['default_subnav_slug']
+    );
+    /**
+     * Fires after a link is added to the main BuddyPress navigation array.
+     *
      * @since BuddyPress (1.5.0)
+     * @since BuddyPress (2.4.0)
+     *
      * @param array $r        Parsed arguments for the nav item.
 …
      * @param array $defaults Default arguments for a nav item.
      */
     do_action( 'bp_core_new_nav_item', $r, $args, $defaults );
+}
 /**
  * Add a link to the main BuddyPress navigation array.
+    do_action( 'bp_core_create_nav_link', $r, $args, $defaults );
+}
+/**
+ * Register a screen function for an item in the main nav array.
+ *
  * @since BuddyPress (2.4.0)
 …
  * @return bool|null Returns false on failure.
  */
 function bp_core_create_nav_link( $args = '' ) {
+function bp_core_register_nav_screen_function( $args = '' ) {
     $bp = buddypress();
 …
     $r = wp_parse_args( $args, $defaults );
-    // If we don't have the required info we need, don't create this nav item.
-    if ( empty( $r['name'] ) || empty( $r['slug'] ) ) {
-        return false;
+    }
-    // If this is for site admins only and the user is not one, don't create the nav item.
-    if ( ! empty( $r['site_admin_only'] ) && ! bp_current_user_can( 'bp_moderate' ) ) {
-        return false;
+    }
-    /**
-     * If this nav item is hidden for the displayed user, and
-     * the logged in user is not the displayed user
-     * looking at their own profile, don't create the nav item.
-     */
-    if ( empty( $r['show_for_displayed_user'] ) && ! bp_user_has_access() ) {
-        return false;
+    }
-    if ( empty( $r['item_css_id'] ) ) {
-        $r['item_css_id'] = $r['slug'];
+    }
-    $bp->bp_nav[$r['slug']] = array(
-        'name'                    => $r['name'],
-        'slug'                    => $r['slug'],
-        'link'                    => trailingslashit( bp_loggedin_user_domain() . $r['slug'] ),
-        'css_id'                  => $r['item_css_id'],
-        'show_for_displayed_user' => $r['show_for_displayed_user'],
-        'position'                => $r['position'],
-        'screen_function'         => &$r['screen_function'],
-        'default_subnav_slug'     => $r['default_subnav_slug']
-    );
-    /**
-     * Fires after a link is added to the main BuddyPress navigation array.
+     *
-     * @since BuddyPress (2.4.0)
+     *
-     * @param array $r        Parsed arguments for the nav item.
-     * @param array $args     Originally passed in arguments for the nav item.
-     * @param array $defaults Default arguments for a nav item.
-     */
-    do_action( 'bp_core_create_nav_link', $r, $args, $defaults );
+}
-/**
- * Register a screen function for an item in the main nav array.
+ *
- * @since BuddyPress (2.4.0)
+ *
- * @param array $args {
- *     Array describing the new nav item.
- *     @type string      $name                    Display name for the nav item.
- *     @type string      $slug                    Unique URL slug for the nav item.
- *     @type bool|string $item_css_id             Optional. 'id' attribute for the nav item. Default: the value of `$slug`.
- *     @type bool        $show_for_displayed_user Optional. Whether the nav item should be visible when viewing a
- *                                                member profile other than your own. Default: true.
- *     @type bool        $site_admin_only         Optional. Whether the nav item should be visible only to site admins
- *                                                (those with the 'bp_moderate' cap). Default: false.
- *     @type int         $position                Optional. Numerical index specifying where the item should appear in
- *                                                the nav array. Default: 99.
- *     @type callable    $screen_function         The callback function that will run when the nav item is clicked.
- *     @type bool|string $default_subnav_slug     Optional. The slug of the default subnav item to select when the nav
- *                                                item is clicked.
- * }
- * @return bool|null Returns false on failure.
- */
-function bp_core_register_nav_screen_function( $args = '' ) {
-    $bp = buddypress();
-    $defaults = array(
-        'name'                    => false, // Display name for the nav item
-        'slug'                    => false, // URL slug for the nav item
-        'item_css_id'             => false, // The CSS ID to apply to the HTML of the nav item
-        'show_for_displayed_user' => true,  // When viewing another user does this nav item show up?
-        'site_admin_only'         => false, // Can only site admins see this nav item?
-        'position'                => 99,    // Index of where this nav item should be positioned
-        'screen_function'         => false, // The name of the function to run when clicked
-        'default_subnav_slug'     => false  // The slug of the default subnav item to select when clicked
-    );
-    $r = wp_parse_args( $args, $defaults );
     // If we don't have the required info we need, don't register this screen function.
     if ( empty( $r['slug'] ) ) {
 …
                  * @since BuddyPress (1.5.0)
+                 *
                  * @param string $default_subnav_slug The slug of the default subnav item
                  *                                    to select when clicked.
                  * @param array  $r                   Parsed arguments for the nav item.
+                 * @param string $value The slug of the default subnav item
+                 *                      to select when clicked.
+                 * @param array  $r     Parsed arguments for the nav item.
                  */
                 $bp->current_action = apply_filters( 'bp_default_component_subnav', $r['default_subnav_slug'], $r );
 …
  * Modify the default subnav item that loads when a top level nav item is clicked.
+ *
  * @param array $args {
+ * @param array|string $args {
  *     @type string   $parent_slug     The slug of the nav item whose default is being changed.
  *     @type callable $screen_function The new default callback function that will run when the nav item is clicked.
 …
  * Add a subnav item to the BuddyPress navigation.
+ *
  * @param array $args {
+ * @param array|string $args {
  *     Array describing the new subnav item.
  *     @type string      $name              Display name for the subnav item.
 …
  * Add a subnav link to the BuddyPress navigation.
+ *
  * @param array $args {
+ * @param array|string $args {
  *     Array describing the new subnav item.
  *     @type string $name Display name for the subnav item.
  *     @type string $slug Unique URL slug for the subnav item.
  *     @type string $parent_slug Slug of the top-level nav item under which the
  *           new subnav item should be added.
  *     @type string $parent_url URL of the parent nav item.
  *     @type bool|string $item_css_id Optional. 'id' attribute for the nav
  *           item. Default: the value of $slug.
  *     @type bool $user_has_access Optional. True if the logged-in user has
  *           access to the subnav item, otherwise false. Can be set dynamically
  *           when registering the subnav; eg, use bp_is_my_profile() to restrict
  *           access to profile owners only. Default: true.
  *     @type bool $site_admin_only Optional. Whether the nav item should be
  *           visible only to site admins (those with the 'bp_moderate' cap).
  *           Default: false.
  *     @type int $position Optional. Numerical index specifying where the item
  *           should appear in the subnav array. Default: 90.
  *     @type callable $screen_function The callback function that will run
  *           when the nav item is clicked.
  *     @type string $link Optional. The URL that the subnav item should point
  *           to. Defaults to a value generated from the $parent_url + $slug.
  *     @type bool $show_in_admin_bar Optional. Whether the nav item should be
  *           added into the group's "Edit" Admin Bar menu for group admins.
  *           Default: false.
+ *     @type string      $name              Display name for the subnav item.
+ *     @type string      $slug              Unique URL slug for the subnav item.
+ *     @type string      $parent_slug       Slug of the top-level nav item under which the
+ *                                          new subnav item should be added.
+ *     @type string      $parent_url        URL of the parent nav item.
+ *     @type bool|string $item_css_id       Optional. 'id' attribute for the nav
+ *                                          item. Default: the value of $slug.
+ *     @type bool        $user_has_access   Optional. True if the logged-in user has access to the
+ *                                          subnav item, otherwise false. Can be set dynamically
+ *                                          when registering the subnav; eg, use bp_is_my_profile()
+ *                                          to restrict access to profile owners only. Default: true.
+ *     @type bool        $site_admin_only   Optional. Whether the nav item should be visible only
+ *                                          to site admins (those with the 'bp_moderate' cap).
+ *                                          Default: false.
+ *     @type int         $position          Optional. Numerical index specifying where the item
+ *                                          should appear in the subnav array. Default: 90.
+ *     @type callable    $screen_function   The callback function that will run
+ *                                          when the nav item is clicked.
+ *     @type string      $link              Optional. The URL that the subnav item should point
+ *                                          to. Defaults to a value generated from the $parent_url + $slug.
+ *     @type bool        $show_in_admin_bar Optional. Whether the nav item should be added into
+ *                                          the group's "Edit" Admin Bar menu for group admins.
+ *                                          Default: false.
  * }
+ *
  * @return bool|null Returns false on failure.
  */
 …
  * Register a screen function, whether or not a related subnav link exists.
+ *
  * @param array $args {
+ * @param array|string $args {
  *     Array describing the new subnav item.
  *     @type string $slug Unique URL slug for the subnav item.
  *     @type string $parent_slug Slug of the top-level nav item under which the
  *           new subnav item should be added.
  *     @type string $parent_url URL of the parent nav item.
  *     @type bool $user_has_access Optional. True if the logged-in user has
  *           access to the subnav item, otherwise false. Can be set dynamically
  *           when registering the subnav; eg, use bp_is_my_profile() to restrict
  *           access to profile owners only. Default: true.
  *     @type bool $site_admin_only Optional. Whether the nav item should be
  *           visible only to site admins (those with the 'bp_moderate' cap).
  *           Default: false.
  *     @type int $position Optional. Numerical index specifying where the item
  *           should appear in the subnav array. Default: 90.
  *     @type callable $screen_function The callback function that will run
  *           when the nav item is clicked.
  *     @type string $link Optional. The URL that the subnav item should point
  *           to. Defaults to a value generated from the $parent_url + $slug.
  *     @type bool $show_in_admin_bar Optional. Whether the nav item should be
  *           added into the group's "Edit" Admin Bar menu for group admins.
  *           Default: false.
+ *     @type string   $slug              Unique URL slug for the subnav item.
+ *     @type string   $parent_slug       Slug of the top-level nav item under which the
+ *                                       new subnav item should be added.
+ *     @type string   $parent_url        URL of the parent nav item.
+ *     @type bool     $user_has_access   Optional. True if the logged-in user has access to the
+ *                                       subnav item, otherwise false. Can be set dynamically
+ *                                       when registering the subnav; eg, use bp_is_my_profile()
+ *                                       to restrict access to profile owners only. Default: true.
+ *     @type bool     $site_admin_only   Optional. Whether the nav item should be visible
+ *                                       only to site admins (those with the 'bp_moderate' cap).
+ *                                       Default: false.
+ *     @type int      $position          Optional. Numerical index specifying where the item
+ *                                       should appear in the subnav array. Default: 90.
+ *     @type callable $screen_function   The callback function that will run
+ *                                       when the nav item is clicked.
+ *     @type string   $link              Optional. The URL that the subnav item should point to.
+ *                                       Defaults to a value generated from the $parent_url + $slug.
+ *     @type bool     $show_in_admin_bar Optional. Whether the nav item should be added into
+ *                                       the group's "Edit" Admin Bar menu for group admins.
+ *                                       Default: false.
  * }
+ *
  * @return bool|null Returns false on failure.
  */
 …
+ *
  * @param array $subnav_item The subnav array added to bp_options_nav in `bp_core_new_subnav_item()`.
+ *
  * @return array
  */
 …
  * @param string $nav_item The slug of the top-level nav item whose subnav items you're checking.
  *                         Default: the current component slug.
+ *
  * @return bool $has_subnav True if the nav item is found and has subnav items; false otherwise.
  */
 …
+ *
  * @param int $parent_id The slug of the parent navigation item.
+ * @param bool Returns false on failure, ie if the nav item can't be found.
+ *
+ * @return bool Returns false on failure, ie if the nav item can't be found.
  */
 function bp_core_remove_nav_item( $parent_id ) {
 …
  * @param string $context Context of this preference check. 'admin' or 'front'.
  * @param int    $user    Optional. ID of the user to check. Default: 0 (which falls back to the logged-in user's ID).
+ *
  * @return bool True if the toolbar should be showing for this user.
  */

trunk/src/bp-core/bp-core-cache.php

-                      r9819
+                      r10012
  * When wp-super-cache is installed this function will clear cached pages
  * so that success/error messages are not cached, or time sensitive content.
+ *
+ * @return int
  */
 function bp_core_clear_cache() {
 …
 /**
  * Clear all cached objects for a user, or those that a user is part of.
+ *
+ * @param string $user_id
  */
 function bp_core_clear_user_object_cache( $user_id ) {
 …
  * @since BuddyPress (2.0.0)
+ *
  * @param array $item_ids ID list.
+ * @param array  $item_ids    ID list.
  * @param string $cache_group The cache group to check against.
+ *
  * @return array
  */
 …
  * @since BuddyPress (1.6.0)
+ *
  * @global $wpdb WordPress database object for queries..
+ * @global object $wpdb WordPress database object for queries..
+ *
  * @param array $args {
  *     Array of arguments.
  *     @type array|string $object_ids List of object IDs to fetch metadata for.
  *           Accepts an array or a comma-separated list of numeric IDs.
  *     @type string $object_type The type of object, eg 'groups' or 'activity'.
  *     @type string $meta_table The name of the metadata table being queried.
  *     @type string $object_column Optional. The name of the database column
  *           where IDs (those provided by $object_ids) are found. Eg, 'group_id'
  *           for the groups metadata tables. Default: $object_type . '_id'.
  *     @type string $cache_key_prefix Optional. The prefix to use when creating
  *           cache key names. Default: the value of $meta_table.
+ *     @type array|string $object_ids       List of object IDs to fetch metadata for.
+ *                                          Accepts an array or a comma-separated list of numeric IDs.
+ *     @type string       $object_type      The type of object, eg 'groups' or 'activity'.
+ *     @type string       $meta_table       The name of the metadata table being queried.
+ *     @type string       $object_column    Optional. The name of the database column where IDs
+ *                                          (those provided by $object_ids) are found. Eg, 'group_id'
+ *                                          for the groups metadata tables. Default: $object_type . '_id'.
+ *     @type string       $cache_key_prefix Optional. The prefix to use when creating
+ *                                          cache key names. Default: the value of $meta_table.
  * }
+ *
  * @return array|bool Metadata cache for the specified objects, or false on failure.
  */
 …
         'object_column'    => '',      // DB column for the object ids (group_id, etc)
         'cache_key_prefix' => ''       // Prefix to use when creating cache key names. Eg
                            //    'bp_groups_groupmeta'
+                                       // 'bp_groups_groupmeta'
     );
     $r = wp_parse_args( $args, $defaults );

trunk/src/bp-core/bp-core-caps.php

-                      r9957
+                      r10012
 /**
  * Return an array of roles from the currently loaded blog
+ * Return an array of roles from the currently loaded blog.
+ *
  * WordPress roles are dynamically flipped when calls to switch_to_blog() and
 …
  *       args.
+ *
+ * @param array $caps See {@link WP_User::has_cap()}.
+ * @param string $cap See {@link WP_User::has_cap()}.
+ * @param int $user_id See {@link WP_User::has_cap()}.
+ * @param mixed $args See {@link WP_User::has_cap()}.
+ * @param array  $caps    See {@link WP_User::has_cap()}.
+ * @param string $cap     See {@link WP_User::has_cap()}.
+ * @param int    $user_id See {@link WP_User::has_cap()}.
+ * @param mixed  $args    See {@link WP_User::has_cap()}.
+ *
  * @return array Actual capabilities for meta capability. See {@link WP_User::has_cap()}.
  */
 …
+ *
  * @param string $role The role for which you're loading caps.
+ *
  * @return array Capabilities for $role.
  */
 …
  *     @type mixed $a,...   Optional. Extra arguments applicable to the capability check.
  * }
+ *
  * @return bool True if the user has the cap for the given parameters.
  */
 …
  * @see WP_User::has_cap()
+ *
+ * @param array $allcaps The caps that WP associates with the given role.
+ * @param array $caps The caps being tested for in WP_User::has_cap().
+ * @param array $args Miscellaneous arguments passed to the user_has_cap filter.
+ * @param array  $caps    The caps that WP associates with the given role.
+ * @param string $cap     The caps being tested for in WP_User::has_cap().
+ * @param int    $user_id ID of the user being checked against.
+ * @param array  $args    Miscellaneous arguments passed to the user_has_cap filter.
+ *
  * @return array $allcaps The user's cap list, with 'bp_moderate' appended, if relevant.
  */

trunk/src/bp-core/bp-core-catchuri.php

-                      r9914
+                      r10012
+ *
  * @param array $templates Array of templates to attempt to load.
+ *
  * @return bool|null Returns false on failure.
  */
 …
  * @since BuddyPress (1.5.0)
+ *
+ * @param array $args {
+ *     @type int $mode Specifies the destination of the redirect. 1 will
+ *           direct to the root domain (home page), which assumes you have a
+ *           log-in form there; 2 directs to wp-login.php. Default: 2.
+ *     @type string $redirect The URL the user will be redirected to after
+ *           successfully logging in. Default: the URL originally requested.
+ *     @type string $root The root URL of the site, used in case of error or
+ *           mode 1 redirects. Default: the value of {@link bp_get_root_domain()}.
+ *     @type string $message An error message to display to the user on the
+ *           log-in page. Default: "You must log in to access the page you
+ *           requested."
+ * @param array|string $args {
+ *     @type int    $mode     Specifies the destination of the redirect. 1 will
+ *                            direct to the root domain (home page), which assumes you have a
+ *                            log-in form there; 2 directs to wp-login.php. Default: 2.
+ *     @type string $redirect The URL the user will be redirected to after successfully
+ *                            logging in. Default: the URL originally requested.
+ *     @type string $root     The root URL of the site, used in case of error or mode 1 redirects.
+ *                            Default: the value of {@link bp_get_root_domain()}.
+ *     @type string $message  An error message to display to the user on the log-in page.
+ *                            Default: "You must log in to access the page you requested."
  * }
  */
 …
  * @since BuddyPress (1.5.0)
+ *
  * @global $error Error message to pass to wp-login.php
+ * @global string $error Error message to pass to wp-login.php.
  */
 function bp_core_no_access_wp_login_error() {
 …
  *     Optional array of arguments.
  *     @type bool $include_query_args Whether to include current URL arguments
  *           in the canonical URL returned from the function.
+ *                                    in the canonical URL returned from the function.
  * }
+ *
  * @return string Canonical URL for the current page.
  */

trunk/src/bp-core/bp-core-component.php

-                      r9847
+                      r10012
     /**
      * Metadata tables for the component (if applicable)
+     * Metadata tables for the component (if applicable).
+     *
      * @since BuddyPress (2.0.0)
 …
     /**
      * Global tables for the component (if applicable)
+     * Global tables for the component (if applicable).
+     *
      * @since BuddyPress (2.0.0)
 …
      * @param array  $params {
      *     Additional parameters used by the component.
      *     @type int   $adminbar_myaccount_order Set the position for our menu under the WP Toolbar's "My Account menu"
+     *     @type int   $adminbar_myaccount_order Set the position for our menu under the WP Toolbar's "My Account menu".
      *     @type array $features                 An array of feature names. This is used to load additional files from your
      *                                           component directory and for feature active checks. eg. array( 'awesome' )
 …
+     *
      * @param array $includes An array of file names, or file name chunks,
      *        to be parsed and then included.
+     *                        to be parsed and then included.
      */
     public function includes( $includes = array() ) {
 …
      *      in the $sub_nav parameter array should be formatted.
+     *
      * @param array $main_nav Optional. Passed directly to
      *        bp_core_new_nav_item(). See that function for a description.
      * @param array $sub_nav Optional. Multidimensional array, each item in
      *        which is passed to bp_core_new_subnav_item(). See that
      *        function for a description.
+     * @param array $main_nav Optional. Passed directly to bp_core_new_nav_item().
+     *                        See that function for a description.
+     * @param array $sub_nav  Optional. Multidimensional array, each item in
+     *                        which is passed to bp_core_new_subnav_item(). See that
+     *                        function for a description.
      */
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
 …
      * @see WP_Admin_Bar::add_menu() for a description of the syntax
      *      required by each item in the $wp_admin_nav parameter array.
      * @global obj $wp_admin_bar
+     *
      * @param array $wp_admin_nav An array of nav item arguments. Each item
      *        in this parameter array is passed to {@link WP_Admin_Bar::add_menu()}.
      *        See that method for a description of the required syntax for
      *        each item.
+     * @global object $wp_admin_bar
+     *
+     * @param array $wp_admin_nav An array of nav item arguments. Each item in this parameter
+     *                            array is passed to {@link WP_Admin_Bar::add_menu()}.
+     *                            See that method for a description of the required syntax for
+     *                            each item.
      */
     public function setup_admin_bar( $wp_admin_nav = array() ) {
 …
     /**
      * Add any permalink structures
+     * Add any permalink structures.
+     *
      * @since BuddyPress (1.9)
+     *
      * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_permastruct'
+     * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_permastruct'.
      */
     public function add_permastructs() {
 …
     /**
      * Allow components to parse the main query
+     * Allow components to parse the main query.
+     *
      * @since BuddyPress (1.9)
+     *
      * @uses do_action() Calls 'bp_{@link bp_Component::name}_parse_query'
      * @param object The main WP_Query
+     * @param object $query The main WP_Query.
      */
     public function parse_query( $query ) {
 …
     /**
      * Generate any additional rewrite rules
+     * Generate any additional rewrite rules.
+     *
      * @since BuddyPress (1.5)
+     *
      * @uses do_action() Calls 'bp_{@link bp_Component::name}_generate_rewrite_rules'
+     * @uses do_action() Calls 'bp_{@link bp_Component::name}_generate_rewrite_rules'.
      */
     public function generate_rewrite_rules() {

trunk/src/bp-core/bp-core-cssjs.php

r9819	r10012
121	121
122	122	/**
123		* Enqueues the css and js required by the Avatar UI
	123	* Enqueues the css and js required by the Avatar UI.
124	124	*
125	125	* @since BuddyPress (2.3.0)
…	…
316	316	* @since BuddyPress (2.0.0)
317	317	*
318		* @uses apply_filters() to allow other component to load extra dependencies
	318	* @uses apply_filters() to allow other component to load extra dependencies.
319	319	*
320	320	* @return array The JavaScript dependencies.

trunk/src/bp-core/bp-core-dependency.php

-                      r9819
+                      r10012
+ *
  * @param array $query_vars See {@link WP::parse_request()}.
+ *
  * @return array $query_vars See {@link WP::parse_request()}.
  */
 …
  * @since BuddyPress (1.7.0)
+ *
  * @param string $redirect_to See 'login_redirect'.
+ * @param string $redirect_to     See 'login_redirect'.
  * @param string $redirect_to_raw See 'login_redirect'.
+ *
  * @param bool   $user See 'login_redirect'.
+ *
 …
+ *
  * @param string $template See 'template_include'.
+ *
  * @return string Template file to use.
  */
 …
+ *
  * @uses apply_filters() Calls 'bp_allowed_themes' with the allowed themes list.
+ *
+ * @param array $themes
+ *
+ * @return array
  */
 function bp_allowed_themes( $themes ) {
 …
 /**
  * The main action used for handling theme-side POST requests
+ * The main action used for handling theme-side POST requests.
+ *
  * @since BuddyPress (1.9.0)
 …
 /**
  * The main action used for handling theme-side GET requests
+ * The main action used for handling theme-side GET requests.
+ *
  * @since BuddyPress (1.9.0)

trunk/src/bp-core/bp-core-filters.php

-                      r9848
+                      r10012
+ *
  * @param array $pages List of excluded page IDs, as passed to the
+ *        'wp_list_pages_excludes' filter.
+ *                     'wp_list_pages_excludes' filter.
+ *
  * @return array The exclude list, with BP's pages added.
  */
 …
  * @uses buddypress() gets BuddyPress main instance
+ *
+ * @param object $object The post type object used in the meta box
+ * @return object The $object, with a query argument to remove register and activate pages id.
+ * @param object|null $object The post type object used in the meta box.
+ *
+ * @return object|null The $object, with a query argument to remove register and activate pages id.
  */
 function bp_core_exclude_pages_from_nav_menu_admin( $object = null ) {
 …
  * @since BuddyPress (2.2.0)
+ *
+ * @param array   $retval CSS classes for the current menu page in the menu
+ * @param WP_Post $page   The page properties for the current menu item
+ * @param array   $retval CSS classes for the current menu page in the menu.
+ * @param WP_Post $page   The page properties for the current menu item.
+ *
  * @return array
  */
 …
  * @since BuddyPress (2.2.0)
+ *
+ * @param array   $retval CSS classes for the current nav menu item in the menu
+ * @param WP_Post $item   The properties for the current nav menu item
+ * @param array   $retval CSS classes for the current nav menu item in the menu.
+ * @param WP_Post $item   The properties for the current nav menu item.
+ *
  * @return array
  */
 …
+ *
  * @param array $comments The array of comments supplied to the comments template.
+ * @param int $post->ID The post ID.
+ * @param int   $post_id  The post ID.
+ *
  * @return array $comments The modified comment array.
  */
 …
  *       are redirected to on login.
+ *
  * @param string $redirect_to The URL to be redirected to, sanitized
  *        in wp-login.php.
  * @param string $redirect_to_raw The unsanitized redirect_to URL ($_REQUEST['redirect_to'])
  * @param WP_User $user The WP_User object corresponding to a successfully
  *        logged-in user. Otherwise a WP_Error object.
+ * @param string  $redirect_to     The URL to be redirected to, sanitized in wp-login.php.
+ * @param string  $redirect_to_raw The unsanitized redirect_to URL ($_REQUEST['redirect_to']).
+ * @param WP_User $user            The WP_User object corresponding to a successfully
+ *                                 logged-in user. Otherwise a WP_Error object.
+ *
  * @return string The redirect URL.
  */
 …
      * @since BuddyPress (1.6.0)
+     *
     * @param bool    $value           Whether or not to redirect.
+  * @param bool    $value           Whether or not to redirect.
      * @param string  $redirect_to     Sanitized URL to be redirected to.
      * @param string  $redirect_to_raw Unsanitized URL to be redirected to.
 …
+ *
  * @param string $welcome_email Complete email passed through WordPress.
+ *
  * @return string Filtered $welcome_email with the password replaced
  *         by '[User Set]'.
+ *                by '[User Set]'.
  */
 function bp_core_filter_user_welcome_email( $welcome_email ) {
 …
+ *
  * @param string $welcome_email Complete email passed through WordPress.
+ * @param int $blog_id ID of the blog user is joining.
+ * @param int $user_id ID of the user joining.
+ * @param string $password Password of user.
+ * @param int    $blog_id       ID of the blog user is joining.
+ * @param int    $user_id       ID of the user joining.
+ * @param string $password      Password of user.
+ *
  * @return string Filtered $welcome_email with $password replaced by '[User Set]'.
  */
 …
  * @see wpmu_signup_blog_notification() for a description of parameters.
+ *
  * @param string $domain The new blog domain.
  * @param string $path The new blog path.
  * @param string $title The site title.
  * @param string $user The user's login name.
+ * @param string $domain     The new blog domain.
+ * @param string $path       The new blog path.
+ * @param string $title      The site title.
+ * @param string $user       The user's login name.
  * @param string $user_email The user's email address.
+ * @param string $key The activation key created in wpmu_signup_blog()
+ * @param array $meta By default, contains the requested privacy setting and
+ *        lang_id.
+ * @param string $key        The activation key created in wpmu_signup_blog()
+ * @param array  $meta       By default, contains the requested privacy setting and
+ *                           lang_id.
+ *
  * @return bool True on success, false on failure.
  */
 …
      * @param string $subject     Subject used in the notification email.
      * @param string $message     Message used in the notification email.
      * @param string domain       The new blog domain.
+     * @param string $domain      The new blog domain.
      * @param string $path        The new blog path.
      * @param string $title       The site title.
 …
  * @see wpmu_signup_user_notification() for a full description of params.
+ *
  * @param string $user The user's login name.
+ * @param string $user       The user's login name.
  * @param string $user_email The user's email address.
+ * @param string $key The activation key created in wpmu_signup_user()
+ * @param array $meta By default, an empty array.
+ * @return bool True on success, false on failure.
+ * @param string $key        The activation key created in wpmu_signup_user()
+ * @param array  $meta       By default, an empty array.
+ *
+ * @return bool|string True on success, false on failure.
  */
 function bp_core_activation_signup_user_notification( $user, $user_email, $key, $meta ) {
 …
+ *
  * @param  string $title_part
+ *
  * @return string
  */
 …
+ *
  * @param WP_Post $menu_item The menu item.
+ * @return obj The modified WP_Post object.
+ *
+ * @return WP_Post The modified WP_Post object.
  */
 function bp_setup_nav_menu_item( $menu_item ) {
 …
+ *
  * @param string $q SQL query.
+ *
  * @return string
  */
 …
 /**
  * Filter the edit post link to avoid its display in BuddyPress pages
+ * Filter the edit post link to avoid its display in BuddyPress pages.
+ *
  * @since BuddyPress (2.1.0)
 …
  * @param  string $edit_link The edit link.
  * @param  int    $post_id   Post ID.
+ * @return mixed  Will be a boolean (false) if $post_id is 0. Will be a string (the unchanged edit link)
+ *                otherwise
+ *
+ * @return bool|string Will be a boolean (false) if $post_id is 0. Will be a string (the unchanged edit link)
+ *                     otherwise
  */
 function bp_core_filter_edit_post_link( $edit_link = '', $post_id = 0 ) {
 …
  * mentions suggestions?
+ *
+ * @param bool $load_mentions True to load mentions assets, false otherwise.
+ * @since BuddyPress (2.2.0)
+ *
+ * @param bool $load_mentions    True to load mentions assets, false otherwise.
  * @param bool $mentions_enabled True if mentions are enabled.
+ *
  * @return bool True if mentions scripts should be loaded.
- * @since BuddyPress (2.2.0)
  */
 function bp_maybe_load_mentions_scripts_for_blog_content( $load_mentions, $mentions_enabled ) {

trunk/src/bp-core/bp-core-functions.php

-                      r9819
+                      r10012
  *        the time elapsed. Enter either as an integer Unix timestamp, or as a
  *        date string of the format 'Y-m-d h:i:s'.
  * @param int $newer_date Optional. Unix timestamp of date to compare older
+ * @param int|bool $newer_date Optional. Unix timestamp of date to compare older
  *        date to. Default: false (current time).
  * @return string String representing the time since the older date, eg
 …
  * @uses apply_filters() Filter 'bp_get_user_meta_key' to modify keys individually.
+ *
  * @param string $key The usermeta meta_key.
+ * @param string|bool $key The usermeta meta_key.
  * @return string $key The usermeta meta_key.
  */

trunk/src/bp-core/bp-core-moderation.php

-                      r9819
+                      r10012
+ *
  * @param int $user_id User id to check for flood.
+ *
  * @return bool True if there is no flooding, false if there is.
  */
 …
  * @uses bp_current_user_can() Allow super admins to bypass blacklist.
+ *
  * @param int $user_id Topic or reply author ID.
  * @param string $title The title of the content.
+ * @param int    $user_id Topic or reply author ID.
+ * @param string $title   The title of the content.
  * @param string $content The content being posted.
+ *
  * @return bool True if test is passed, false if fail.
  */
 …
  * @uses bp_current_user_can() Allow super admins to bypass blacklist.
+ *
  * @param int $user_id Topic or reply author ID.
  * @param string $title The title of the content.
+ * @param int    $user_id Topic or reply author ID.
+ * @param string $title   The title of the content.
  * @param string $content The content being posted.
+ *
  * @return bool True if test is passed, false if fail.
  */
 …
      * @since BuddyPress (1.6.0)
+     *
      * @param string $retval Current user's user-agent
+     * @param string $retval Current user's user-agent.
      */
     return apply_filters( 'bp_core_current_user_ua', $retval );

trunk/src/bp-core/bp-core-options.php

-                      r9828
+                      r10012
  * @since BuddyPress (1.6.0)
+ *
+ * @param bool $value Optional. Default value false
+ * @return mixed false if not overloaded, mixed if set
+ * @param bool $value Optional. Default value false.
+ *
+ * @return mixed False if not overloaded, mixed if set.
  */
 function bp_pre_get_option( $value = false ) {
 …
+ *
  * @param string $option_name The option to be retrieved.
+ * @param string $default Optional. Default value to be returned if the option
+ *        isn't set. See {@link get_blog_option()}.
+ * @param string $default     Optional. Default value to be returned if the option
+ *                            isn't set. See {@link get_blog_option()}.
+ *
  * @return mixed The value for the option.
  */
 …
+ *
  * @param string $option_name The option key to be set.
+ * @param mixed $value The value to be set.
+ * @param mixed  $value       The value to be set.
+ *
  * @return bool True on success, false on failure.
  */
 …
+ *
  * @param string $option_name The option key to be set.
+ * @param string $value The value to be set.
+ * @param string $value       The value to be set.
+ *
  * @return bool True on success, false on failure.
  */
 …
+ *
  * @param string $option_name The option key to be deleted.
+ *
  * @return bool True on success, false on failure.
  */
 …
+ *
  * @deprecated 1.6.0
+ *
+ * @param array $keys
+ *
+ * @return bool
  */
 function bp_core_activate_site_options( $keys = array() ) {
 …
+ *
  * @param  string $option Name of the option key.
+ *
  * @return mixed Value, if found.
  */
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if profile sync is enabled, otherwise false.
  */
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if the admin bar should be hidden for logged-out users,
  *         otherwise false.
+ *              otherwise false.
  */
 function bp_hide_loggedout_adminbar( $default = true ) {
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if avatar uploads are disabled, otherwise false.
  */
 …
  * @since BuddyPress (2.3.0)
+ *
+ * @param bool $default Optional. Fallback value if not found in the database.
+ *                      Defaults to the value of `bp_disable_avatar_uploads()`.
+ * @param bool|null $default Optional. Fallback value if not found in the database.
+ *                           Defaults to the value of `bp_disable_avatar_uploads()`.
+ *
  * @return bool True if group avatar uploads are disabled, otherwise false.
  */
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if users are able to delete their own accounts, otherwise
  *         false.
+ *              false.
  */
 function bp_disable_account_deletion( $default = false ) {
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: false.
+ *                      Default: false.
+ *
  * @return bool True if activity comments are disabled for blog and forum
  *         items, otherwise false.
+ *              items, otherwise false.
  */
 function bp_disable_blogforum_comments( $default = false ) {
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if group creation is restricted, otherwise false.
  */
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if the BuddyBar should be forced on, otherwise false.
  */
 …
  * @since BuddyPress (1.6.0)
+ *
  * @param bool $default Optional. Default: '0'.
+ * @param bool|string $default Optional. Default: '0'.
  */
 function bp_group_forums_root_id( $default = '0' ) {
 …
      * @uses bp_get_option() To get the root forum ID from the database.
+     *
+     * @param bool $default Optional. Default: '0'.
+     * @param bool|string $default Optional. Default: '0'.
+     *
      * @return int The ID of the group forums root forum.
      */
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if group forums are active, otherwise false.
  */
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if Akismet is enabled, otherwise false.
  */
 …
+ *
  * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ *                      Default: true.
+ *
  * @return bool True if Heartbeat refresh is enabled, otherwise false.
  */
 …
  * @uses get_option() To get the theme package option.
+ *
+ * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: 'legacy'.
+ * @param string $default Optional. Fallback value if not found in the database.
+ *                        Default: 'legacy'.
+ *
  * @return string ID of the theme package.
  */

trunk/src/bp-core/bp-core-taxonomy.php

-                      r9819
+                      r10012
  * @param string       $taxonomy  Taxonomy name.
  * @param bool         $append    Optional. True to append terms to existing terms. Default: false.
+ *
  * @return array Array of term taxonomy IDs.
  */
 …
  * @param string|array $taxonomies Name or names of taxonomies to match.
  * @param array        $args       See {@see wp_get_object_terms()}.
+ *
  * @return array
  */
 …
  * @param string|array $terms     Term or terms to remove.
  * @param string       $taxonomy  Taxonomy name.
+ *
  * @return bool|WP_Error True on success, false or WP_Error on failure.
  */

trunk/src/bp-core/bp-core-template-loader.php

-                      r9819
+                      r10012
  * @uses get_template_part()
+ *
  * @param string $slug Template part slug. Used to generate filenames, eg
  *        'friends' for 'friends.php'.
+ * @param string $slug Template part slug. Used to generate filenames,
+ *                     eg 'friends' for 'friends.php'.
  * @param string $name Optional. Template part name. Used to generate
+ *        secondary filenames, eg 'personal' for 'activity-personal.php'.
+ *                     secondary filenames, eg 'personal' for 'activity-personal.php'.
+ *
  * @return string Path to located template. See {@link bp_locate_template()}.
  */
 function bp_get_template_part( $slug, $name = null ) {
-    // Execute code for this part
     /**
      * Fires at the start of bp_get_template_part().
 …
     $templates[] = $slug . '.php';
-    // Allow template parts to be filtered
     /**
      * Filters the template parts to be loaded.
 …
+ *
  * @param string|array $template_names Template file(s) to search for, in order.
+ * @param bool $load Optional. If true, the template file will be loaded when
+ *        found. If false, the path will be returned. Default: false.
+ * @param bool $require_once Optional. Whether to require_once or require. Has
+ *        no effect if $load is false. Default: true.
+ * @param bool         $load           Optional. If true, the template file will be loaded when
+ *                                     found. If false, the path will be returned. Default: false.
+ * @param bool         $require_once   Optional. Whether to require_once or require. Has
+ *                                     no effect if $load is false. Default: true.
+ *
  * @return string The template filename if one is located.
  */
 …
+ *
  * @param string $location_callback Callback function that returns the stack location.
+ * @param int $priority Optional. The priority parameter as passed to
+ *        add_filter(). Default: 10.
+ * @param int    $priority          Optional. The priority parameter as passed to
+ *                                  add_filter(). Default: 10.
+ *
  * @return bool See {@link add_filter()}.
  */
 …
+ *
  * @param string $location_callback Callback function that returns the stack location.
+ * @param int $priority Optional. The priority parameter passed to
+ *        {@link bp_register_template_stack()}. Default: 10.
+ * @param int    $priority          Optional. The priority parameter passed to
+ *                                  {@link bp_register_template_stack()}. Default: 10.
+ *
  * @return bool See {@link remove_filter()}.
  */
 …
  * @since BuddyPress (1.7.0)
+ *
+ * @global array $wp_filter Stores all of the filters.
+ * @global array $merged_filters Merges the filter hooks using this function..
+ * @global array $wp_current_filter stores the list of current filters with
+ *         the current one last.
+ * @global array $wp_filter         Stores all of the filters.
+ * @global array $merged_filters    Merges the filter hooks using this function.
+ * @global array $wp_current_filter Stores the list of current filters with
+ *                                  the current one last.
+ *
  * @return array The filtered value after all hooked functions are applied to it.
  */
 …
  * @param string $slug See {@link bp_get_template_part()}.
  * @param string $name See {@link bp_get_template_part()}.
+ * @param bool $echo If true, template content will be echoed. If false,
+ *        returned. Default: true.
+ * @param bool   $echo If true, template content will be echoed. If false,
+ *                     returned. Default: true.
+ *
  * @return string|null If $echo, returns the template content.
  */
 …
  * @uses bp_set_theme_compat_template()
+ *
+ * @param string $type Filename without extension.
+ * @param array $templates An optional list of template candidates.
+ * @param string $type      Filename without extension.
+ * @param array  $templates An optional list of template candidates.
+ *
  * @return string Full path to file.
  */
 …
 /**
+ * Get the possible subdirectories to check for templates in
+ *
+ * @since BuddyPress (1.7.0)
+ * @param array $templates Templates we are looking for
+ * @return array Possible subfolders to look in
+ * Get the possible subdirectories to check for templates in.
+ *
+ * @since BuddyPress (1.7.0)
+ *
+ * @param array $templates Templates we are looking for.
+ *
+ * @return array Possible subfolders to look in.
  */
 function bp_get_template_locations( $templates = array() ) {
 …
+ *
  * @param array $stacks Array of template locations.
+ *
  * @return array() Array of all template locations registered so far.
  */
 …
  * Listens to the 'template_include' filter and waits for any BuddyPress specific
  * template condition to be met. If one is met and the template file exists,
  * it will be used; otherwise
+ * it will be used; otherwise.
+ *
  * Note that the _edit() checks are ahead of their counterparts, to prevent them
 …
+ *
  * @param string $template
+ *
  * @return string The path to the template file that is being used.
  */
 …
+ *
  * @param mixed $template Default: false.
+ *
  * @return mixed False if empty. Template name if template included.
  */
 …
+ *
  * @since BuddyPress (1.8.0)
+ *
  * @return bool True if yes, false if no.
  */

trunk/src/bp-core/bp-core-template.php

-                      r9989
+                      r10012
  * @uses bp_get_user_nav() Renders the navigation for a profile of a currently
  *       viewed user.
+ *
+ * @param string $parent_slug
+ *
+ * @return string
  */
 function bp_get_options_nav( $parent_slug = '' ) {
 …
  * @since BuddyPress (2.0.0)
+ *
+ * @param string $component
+ *
  * @return string
  */
 …
  * @since BuddyPress (1.1.0)
+ *
  * @param int  $time         The UNIX timestamp to be formatted.
+ * @param int|string  $time         The UNIX timestamp to be formatted.
  * @param bool $exclude_time Optional. True to return only the month + day, false
  *                           to return month, day, and time. Default: false.
 …
  * @see bp_get_button()
+ *
  * @param array $args See {@link BP_Button}.
+ * @param array|string $args See {@link BP_Button}.
  */
 function bp_button( $args = '' ) {
 …
      * @see BP_Button for a description of arguments and return value.
+     *
      * @param array $args See {@link BP_Button}.
+     * @param array|string $args See {@link BP_Button}.
      * @return string HTML markup for the button.
      */
 …
  * WordPress theme without coping the functions from functions.php.
+ *
  * @param string $object
+ * @param string|bool $object
  * @return string The AJAX querystring.
  */
 …
  * Return the name of the current item.
+ *
  * @return unknown
+ * @return string|bool
  */
 function bp_current_item() {
 …
          * @since BuddyPress (1.5.0)
+         *
          * @param string BP_SEARCH_SLUG The search slug. Default "search".
+         * @const string BP_SEARCH_SLUG The search slug. Default "search".
          */
         return apply_filters( 'bp_get_search_slug', BP_SEARCH_SLUG );
 …
+ *
  * @param string $action_variable The action_variable being tested against.
  * @param int $position Optional. The array key you're testing against. If you
+ * @param int|bool $position Optional. The array key you're testing against. If you
  *        don't provide a $position, the function will return true if the
  *        $action_variable is found *anywhere* in the action variables array.
 …
  * already deprecated functions.
+ *
+ * @param string $component_name
+ *
  * @return bool True if root component, else false.
  */
 …
  * @since BuddyPress (1.5.0)
+ *
  * @global $current_blog WordPress global for the current blog.
+ * @global int $current_blog WordPress global for the current blog.
+ *
  * @param string $component Optional. Name of the component to check for.
 …
  * Not currently used by BuddyPress.
+ *
+ * @param string $component Current component to check for.
+ * @param string $callback  Callback to invoke.
+ *
  * @return bool
  */
 …
 /**
  * Customize the body class, according to the currently displayed BP content.
+ *
- * Uses the above is_() functions to output a body class for each scenario.
+ *
- * @param array $wp_classes The body classes coming from WP.
- * @param array $custom_classes Classes that were passed to get_body_class().
- * @return array $classes The BP-adjusted body classes.
  */
 function bp_the_body_class() {
     echo bp_get_the_body_class();
+}
+    /**
+     * Customize the body class, according to the currently displayed BP content.
+     *
+     * Uses the above is_() functions to output a body class for each scenario.
+     *
+     * @param array $wp_classes The body classes coming from WP.
+     * @param array|bool $custom_classes Classes that were passed to get_body_class().
+     * @return array $classes The BP-adjusted body classes.
+     */
     function bp_get_the_body_class( $wp_classes = array(), $custom_classes = false ) {

trunk/src/bp-core/bp-core-theme-compatibility.php

-                      r9819
+                      r10012
  * @param array $properties {
  *     An array of properties describing the theme compat package.
  *     @type string $id ID of the package. Must be unique.
  *     @type string $name Name of the theme. This should match the name given
  *           in style.css.
+ *     @type string $id      ID of the package. Must be unique.
+ *     @type string $name    Name of the theme. This should match the name given
+ *                           in style.css.
  *     @type string $version Theme version. Used for busting script and style
  *           browser caches.
  *     @type string $dir Filesystem path of the theme.
  *     @type string $url Base URL of the theme.
+ *                           browser caches.
+ *     @type string $dir     Filesystem path of the theme.
+ *     @type string $url     Base URL of the theme.
  * }
  */
 …
+     *
      * @since BuddyPress (1.7.0)
+     *
+     * @param array $properties Array of properties for BP_Theme_Compat.
      */
         public function __construct( Array $properties = array() ) {
 …
+     *
      * @param string $property Property name.
+     * @param mixed $value Property value.
+     * @param mixed  $value    Property value.
+     *
      * @return bool True on success, false on failure.
      */
 …
+     *
      * @param string $property Property name.
+     *
      * @return mixed The value of the property if it exists, otherwise an
      *         empty string.
+     *               empty string.
      */
     public function __get( $property ) {
 …
+ *
  * @param bool $set True to set the flag to true, false to set it to false.
+ *
  * @return bool Returns the value of $set.
  */
 …
+ *
  * @param array $templates The template stack.
+ *
  * @return array The template stack (value of $templates).
  */
 …
+ *
  * @param string $template The template currently in use.
+ *
  * @return string The template currently in use (value of $template).
  */
 …
+ *
  * @param string $template The template originally selected by WP.
+ *
  * @return string The template originally selected by WP (value of $template).
  */
 …
+ *
  * @param string $template The template name to check.
+ *
  * @return bool True if the value of $template is the same as the
  *         "original_template" originally selected by WP. Otherwise false.
+ *              "original_template" originally selected by WP. Otherwise false.
  */
 function bp_is_theme_compat_original_template( $template = '' ) {
 …
  * @see BP_Theme_Compat for a description of the $theme parameter arguments.
+ *
  * @param array $theme See {@link BP_Theme_Compat}.
  * @param bool $override If true, overrides whatever package is currently set.
  *        Default: true.
+ * @param array $theme    See {@link BP_Theme_Compat}.
+ * @param bool  $override If true, overrides whatever package is currently set.
+ *                        Default: true.
  */
 function bp_register_theme_package( $theme = array(), $override = true ) {
 …
  * @global object $post Current post object.
+ *
  * @param array $args Array of optional arguments. Arguments parallel the
  *        properties of {@link WP_Post}; see that class for more details.
+ * @param array $args Array of optional arguments. Arguments parallel the properties
+ *                    of {@link WP_Post}; see that class for more details.
  */
 function bp_theme_compat_reset_post( $args = array() ) {
 …
+ *
  * @param string $template Template name.
+ *
  * @return string $template Template name.
  */
 …
+ *
  * @param string $content Original post content.
+ *
  * @return string $content Post content, potentially modified.
  */
 …
+ *
  * @return bool True if the_content is currently in the process of being
  *         filtered and replaced.
+ *              filtered and replaced.
  */
 function bp_do_theme_compat() {
 …
  * @global array $merged_filters
+ *
+ * @param string $tag The filter tag to remove filters from.
+ * @param int $priority Optional. If present, only those callbacks attached
+ *        at a given priority will be removed. Otherwise, all callbacks
+ *        attached to the tag will be removed, regardless of priority.
+ * @param string   $tag      The filter tag to remove filters from.
+ * @param int|bool $priority Optional. If present, only those callbacks attached
+ *                           at a given priority will be removed. Otherwise, all callbacks
+ *                           attached to the tag will be removed, regardless of priority.
+ *
  * @return bool True on success.
  */
 …
  * @global array $merged_filters
+ *
  * @param string $tag The tag to which filters should be restored.
  * @param int $priority Optional. If present, only those filters that were
  *        originally attached to the tag with $priority will be restored.
  *        Otherwise, all available filters will be restored, regardless of
  *        priority.
+ * @param string   $tag      The tag to which filters should be restored.
+ * @param int|bool $priority Optional. If present, only those filters that were originally
+ *                           attached to the tag with $priority will be restored. Otherwise,
+ *                           all available filters will be restored, regardless of priority.
+ *
  * @return bool True on success.
  */
 …
  * @since BuddyPress (1.7.0)
+ *
+ * @param bool $open True if open, false if closed.
+ * @param int $post_id ID of the post to check.
+ * @param bool $open    True if open, false if closed.
+ * @param int  $post_id ID of the post to check.
+ *
  * @return bool True if open, false if closed.
  */
 …
+ *
  * @param string $retval The current post content.
+ *
+ * @return string $retval
  */
 function bp_theme_compat_toggle_is_page( $retval = '' ) {

trunk/src/bp-core/bp-core-update.php

r9849	r10012
60	60	*
61	61	* @uses buddypress()
	62	*
	63	* @param string $basename BuddyPress basename.
62	64	*
63	65	* @return bool True if activating BuddyPress, false if not.
…	…
105	107	*
106	108	* @uses buddypress()
	109	*
	110	* @param string $basename BuddyPress basename.
107	111	*
108	112	* @return bool True if deactivating BuddyPress, false if not.
…	…
397	401	*
398	402	* - Ensure that the activity tables are installed, for last_activity storage.
399		* - Migrate last_activity data from usermeta to activity table
400		* - Add values for all BuddyPress options to the options table
	403	* - Migrate last_activity data from usermeta to activity table.
	404	* - Add values for all BuddyPress options to the options table.
401	405	*
402	406	* @since BuddyPress (2.0.0)
…	…
429	433
430	434	/**
431		* 2.0.1 database upgrade routine
	435	* 2.0.1 database upgrade routine.
432	436	*
433	437	* @since BuddyPress (2.0.1)
…	…
445	449	* 2.2.0 update routine.
446	450	*
447		* - Add messages meta table
448		* - Update the component field of the 'new members' activity type
449		* - Clean up hidden friendship activities
	451	* - Add messages meta table.
	452	* - Update the component field of the 'new members' activity type.
	453	* - Clean up hidden friendship activities.
450	454	*
451	455	* @since BuddyPress (2.2.0)
…	…
470	474	* 2.3.0 update routine.
471	475	*
472		* - Add notifications meta table
	476	* - Add notifications meta table.
473	477	*
474	478	* @since BuddyPress (2.3.0)
…	…
519	523
520	524	/**
521		* Remove all hidden friendship activities
	525	* Remove all hidden friendship activities.
522	526	*
523	527	* @since BuddyPress (2.2.0)
524	528	*
525		* @uses bp_activity_delete() to delete the corresponding friendship activities
	529	* @uses bp_activity_delete() to delete the corresponding friendship activities.
526	530	*/
527	531	function bp_cleanup_friendship_activities() {
…	…
568	572	* @global WPDB $wpdb
569	573	*
570		* @return bool ~~If signups table exists~~
	574	* @return bool\|null If signups table exists.
571	575	*/
572	576	function bp_core_maybe_install_signups() {

trunk/src/bp-core/bp-core-widgets.php

-                      r9819
+                      r10012
      * @see WP_Widget::widget() for description of parameters.
+     *
      * @param array $args Widget arguments.
+     * @param array $args     Widget arguments.
      * @param array $instance Widget settings, as saved by the user.
      */
 …
      * @param array $new_instance The new instance options.
      * @param array $old_instance The old instance options.
+     *
      * @return array $instance The parsed options to be saved.
      */
 …
      * Output the login widget options form.
+     *
+     * @param $instance Settings for this widget.
+     * @param array $instance Settings for this widget.
+     *
+     * @return string
      */
     public function form( $instance = array() ) {

trunk/src/bp-core/bp-core-wpabstraction.php

-                      r9819
+                      r10012
+ *
  * @global string $wp_version
+ *
  * @return string $wp_version
  */
 …
  * @todo Why is this function defined in this file?
+ *
  * @param string $prefix Global table prefix.
+ * @param string|bool $prefix Global table prefix.
  * @return string SQL chunk.
  */
 …
      * @param string $needle String to search for.
      * @param int $offset Optional. Start position for the search. Default: 0.
      * @param string $enc Optional. Encoding type. Ignored.
+     * @param string $encoding Optional. Encoding type. Ignored.
      * @return int|bool Position of needle in haystack if found, else false.
      */
 …
      * @param string $needle String to search for.
      * @param int $offset Optional. Start position for the search. Default: 0.
      * @param string $enc Optional. Encoding type. Ignored.
+     * @param string $encoding Optional. Encoding type. Ignored.
      * @return int Position of last needle in haystack if found, else false.
      */

trunk/src/bp-core/classes/class-bp-attachment-avatar.php

-                      r9831
+                      r10012
 <?php
 /**
  * Core Avatars attachment class
+ * Core Avatars attachment class.
+ *
  * @package BuddyPress
 …
 /**
  * BP Attachment Avatar class
+ * BP Attachment Avatar class.
+ *
  * Extends BP Attachment to manage the avatar uploads
+ * Extends BP Attachment to manage the avatar uploads.
+ *
  * @since BuddyPress (2.3.0)
 …
     /**
      * Construct Upload parameters
+     * Construct Upload parameters.
+     *
      * @since BuddyPress (2.3.0)
 …
     /**
+     * Gets the available avatar types
+     *
+     * @since BuddyPress (2.3.0)
+     * @return string comma separated list of allowed avatar types
+     * Gets the available avatar types.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @param array $allowed_types Array of allowed avatar types.
+     *
+     * @return string comma separated list of allowed avatar types.
      */
     public static function get_avatar_types( $allowed_types = array() ) {
 …
     /**
      * Set Upload Dir data for avatars
+     * Set Upload Dir data for avatars.
+     *
      * @since BuddyPress (2.3.0)
 …
     /**
+     * Avatar specific rules
+     *
+     * Adds an error if the avatar size or type don't match BuddyPress needs
+     * The error code is the index of $upload_error_strings
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @param  array $file the temporary file attributes (before it has been moved)
+     * Avatar specific rules.
+     *
+     * Adds an error if the avatar size or type don't match BuddyPress needs.
+     * The error code is the index of $upload_error_strings.
+     *
+     * @since BuddyPress (2.3.0)
+     *
      * @uses   bp_core_check_avatar_size()
      * @uses   bp_core_check_avatar_type()
+     * @return array the file with extra errors if needed
+     *
+     * @param  array $file the temporary file attributes (before it has been moved).
+     *
+     * @return array the file with extra errors if needed.
      */
     public function validate_upload( $file = array() ) {
 …
     /**
+     * Maybe shrink the attachment to fit maximum allowed width
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $file the absolute path to the file
+     * Maybe shrink the attachment to fit maximum allowed width.
+     *
+     * @since BuddyPress (2.3.0)
+     *
      * @uses  bp_core_avatar_original_max_width()
      * @uses  wp_get_image_editor()
+     *
+     * @param string $file the absolute path to the file.
+     *
      * @return mixed
      */
 …
     /**
+     * Check if the image dimensions are smaller than full avatar dimensions
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $file the absolute path to the file
+     * Check if the image dimensions are smaller than full avatar dimensions.
+     *
+     * @since BuddyPress (2.3.0)
+     *
      * @uses  bp_core_avatar_full_width()
      * @uses  bp_core_avatar_full_height()
+     *
+     * @param string $file the absolute path to the file.
+     *
      * @return boolean
      */
 …
     /**
      * Crop the avatar
+     * Crop the avatar.
+     *
      * @since BuddyPress (2.3.0)
+     *
      * @see  BP_Attachment::crop for the list of parameters
-     * @param array $args
      * @uses bp_core_fetch_avatar()
      * @uses bp_core_delete_existing_avatar()
 …
      * @uses bp_core_avatar_dimension()
      * @uses BP_Attachment::crop
+     * @return array the cropped avatars (full and thumb)
+     *
+     * @param array $args
+     *
+     * @return array The cropped avatars (full and thumb).
      */
     public function crop( $args = array() ) {
 …
     /**
      * Get the user id to set its avatar
+     *
      * @since BuddyPress (2.3.0)
+     *
      * @return integer the user ID
+     * Get the user id to set its avatar.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @return integer The user ID.
      */
     private function get_user_id() {
 …
     /**
      * Get the group id to set its avatar
+     *
      * @since BuddyPress (2.3.0)
+     *
      * @return integer the group id
+     * Get the group id to set its avatar.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @return integer The group ID.
      */
     private function get_group_id() {
 …
     /**
      * Build script datas for the Uploader UI
+     *
      * @since BuddyPress (2.3.0)
+     *
      * @return array the javascript localization data
+     * Build script datas for the Uploader UI.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @return array The javascript localization data.
      */
     public function script_data() {
 …
             );
         } else {
             /**
              * Use this filter to include specific BuddyPress params for your object
              * e.g. Blavatar
+             * Use this filter to include specific BuddyPress params for your object.
+             * e.g. Blavatar.
+             *
              * @since BuddyPress (2.3.0)
+             *
              * @param array the avatar specific BuddyPress parameters
+             * @param array $value The avatar specific BuddyPress parameters.
              */
             $script_data['bp_params'] = apply_filters( 'bp_attachment_avatar_params', array() );
 …
         /**
          * Use this filter to override/extend the avatar script data
+         * Use this filter to override/extend the avatar script data.
+         *
          * @since BuddyPress (2.3.0)
+         *
          * @param array  $script_data the avatar script data
          * @param string $object      the object the avatar belongs to (eg: user or group)
+         * @param array  $script_data The avatar script data.
+         * @param string $object      The object the avatar belongs to (eg: user or group).
          */
         return apply_filters( 'bp_attachment_avatar_script_data', $script_data, $object );

trunk/src/bp-core/classes/class-bp-attachment.php

-                      r9874
+                      r10012
 /**
  * BP Attachment class
+ * BP Attachment class.
+ *
  * Extend it to manage your component's uploads.
 …
     /**
      * The file being uploaded
+     * The file being uploaded.
+     *
      * @var array
 …
     /**
      * The default args to be merged with the
      * ones passed by the child class
+     * ones passed by the child class.
+     *
      * @var array
 …
     /**
      * Construct Upload parameters
+     *
      * @since BuddyPress (2.3.0)
+     *
      * @param array $args {
+     * Construct Upload parameters.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @param array|string $args {
      *     @type int    $original_max_filesize Maximum file size in kilobytes. Defaults to php.ini settings.
      *     @type array  $allowed_mime_types    List of allowed file extensions (eg: array( 'jpg', 'gif', 'png' ) ).
      *                                         Defaults to WordPress allowed mime types
      *     @type string $base_dir              Component's upload base directory. Defaults to WordPress 'uploads'
+     *                                         Defaults to WordPress allowed mime types.
+     *     @type string $base_dir              Component's upload base directory. Defaults to WordPress 'uploads'.
      *     @type string $action                The upload action used when uploading a file, $_POST['action'] must be set
      *                                         and its value must equal $action {@link wp_handle_upload()} (required)
      *     @type string $file_input            The name attribute used in the file input. (required)
+     *                                         and its value must equal $action {@link wp_handle_upload()} (required).
+     *     @type string $file_input            The name attribute used in the file input. (required).
      *     @type array  $upload_error_strings  A list of specific error messages (optional).
      *     @type array  $required_wp_files     The list of required WordPress core files. Default: array( 'file' );
+     *     @type array  $required_wp_files     The list of required WordPress core files. Default: array( 'file' ).
      * }
      * @uses  sanitize_key()
 …
      * @since BuddyPress (2.3.0)
+     *
      * @uses  bp_upload_dir()
+     * @uses bp_upload_dir()
      */
     public function set_upload_dir() {
 …
     /**
      * Set Upload error messages
+     * Set Upload error messages.
+     *
      * Used into the $overrides argument of BP_Attachment->upload()
 …
      * @since BuddyPress (2.3.0)
+     *
+     * @param array $param a list of error messages to add to BuddyPress core ones
+     * @param array $param A list of error messages to add to BuddyPress core ones.
+     *
      * @return array the list of upload errors
      */
 …
     /**
      * Include the WordPress core needed files
+     * Include the WordPress core needed files.
+     *
      * @since BuddyPress (2.3.0)
 …
     /**
+     * Upload the attachment
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @param  array $file               The appropriate entry the from $_FILES superglobal.
+     * @param  string $upload_dir_filter A specific filter to be applied to 'upload_dir' (optional).
+     * @param  string $time              Optional. Time formatted in 'yyyy/mm'. Default null.
+     * Upload the attachment.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @param  array       $file              The appropriate entry the from $_FILES superglobal.
+     * @param  string      $upload_dir_filter A specific filter to be applied to 'upload_dir' (optional).
+     * @param  string|null $time              Optional. Time formatted in 'yyyy/mm'. Default null.
+     *
      * @uses   wp_handle_upload()        To upload the file
      * @uses   add_filter()              To temporarly overrides WordPress uploads data
 …
         /**
          * If you need to add some overrides we haven't thought of
+         * If you need to add some overrides we haven't thought of.
+         *
          * @var  array $overrides the wp_handle_upload overrides
+         * @param array $overrides The wp_handle_upload overrides
          */
         $overrides = apply_filters( 'bp_attachment_upload_overrides', $overrides );
 …
     /**
      * Validate the allowed mime types using WordPress allowed mime types
+     * Validate the allowed mime types using WordPress allowed mime types.
+     *
      * In case of a multisite, the mime types are already restricted by
 …
     /**
      * Specific upload rules
+     * Specific upload rules.
+     *
      * Override this function from your child class to build your specific rules
 …
      * @since BuddyPress (2.3.0)
+     *
+     * @param  array $file the temporary file attributes (before it has been moved)
+     * @return array the file
+     * @param  array $file The temporary file attributes (before it has been moved).
+     *
+     * @return array The file.
      */
     public function validate_upload( $file = array() ) {
 …
     /**
+     * Default filter to save the attachments
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @uses   apply_filters() call 'bp_attachment_upload_dir' to eventually override the upload location
+     *                         regarding to context
+     * @return array the upload directory data
+     * Default filter to save the attachments.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @uses apply_filters() call 'bp_attachment_upload_dir' to eventually override the upload location
+     *       regarding to context
+     *
+     * @return array The upload directory data.
      */
     public function upload_dir_filter() {
         /**
          * Filters the component's upload directory.
 …
     /**
      * Create the custom base directory for the component uploads
+     *
      * Override this function in your child class to run specific actions
+     * Create the custom base directory for the component uploads.
+     *
+     * Override this function in your child class to run specific actions.
      * (eg: add an .htaccess file)
+     *
      * @since BuddyPress (2.3.0)
+     *
      * @uses   wp_mkdir_p()
+     * @uses wp_mkdir_p()
      */
     public function create_dir() {
 …
     /**
      * Crop an image file
+     * Crop an image file.
+     *
      * @since BuddyPress (2.3.0)
 …
      * @param array $args {
      *     @type string $original_file The source file (absolute path) for the Attachment.
      *     @type int    $crop_x The start x position to crop from.
      *     @type int    $crop_y The start y position to crop from.
      *     @type int    $crop_w The width to crop.
      *     @type int    $crop_h The height to crop.
      *     @type int    $dst_w The destination width.
      *     @type int    $dst_h The destination height.
      *     @type int    $src_abs Optional. If the source crop points are absolute.
      *     @type string $dst_file Optional. The destination file to write to.
+     *     @type int    $crop_x        The start x position to crop from.
+     *     @type int    $crop_y        The start y position to crop from.
+     *     @type int    $crop_w        The width to crop.
+     *     @type int    $crop_h        The height to crop.
+     *     @type int    $dst_w         The destination width.
+     *     @type int    $dst_h         The destination height.
+     *     @type int    $src_abs       Optional. If the source crop points are absolute.
+     *     @type string $dst_file      Optional. The destination file to write to.
      * }
      * @uses wp_crop_image()
+     *
      * @return string|WP_Error New filepath on success, WP_Error on failure.
      */
 …
     /**
      * Build script datas for the Uploader UI
+     *
      * Override this method from your child class to build the script datas
+     *
      * @since BuddyPress (2.3.0)
+     *
      * @return array the javascript localization data
+     * Build script datas for the Uploader UI.
+     *
+     * Override this method from your child class to build the script datas.
+     *
+     * @since BuddyPress (2.3.0)
+     *
+     * @return array The javascript localization data.
      */
     public function script_data() {

trunk/src/bp-core/classes/class-bp-button.php

-                      r9819
+                      r10012
  * @param array $args {
  *     Array of arguments.
+ *     @type string $id String describing the button type.
+ *     @type string $component The name of the component the button belongs to.
+ *           Default: 'core'.
+ *     @type bool $must_be_logged_in Optional. Does the user need to be logged
+ *           in to see this button? Default: true.
+ *     @type bool $block_self Optional. True if the button should be hidden
+ *           when a user is viewing his own profile. Default: true.
+ *     @type string|bool $wrapper Optional. HTML element type that should wrap
+ *           the button: 'div', 'span', 'p', or 'li'. False for no wrapper at
+ *           all. Default: 'div'.
+ *     @type string $wrapper_id Optional. DOM ID of the button wrapper element.
+ *           Default: ''.
+ *     @type string $wrapper_class Optional. DOM class of the button wrapper
+ *           element. Default: ''.
+ *     @type string $link_href Optional. Destination link of the button.
+ *           Default: ''.
+ *     @type string $link_class Optional. DOM class of the button. Default: ''.
+ *     @type string $link_id Optional. DOM ID of the button. Default: ''.
+ *     @type string $link_rel Optional. DOM 'rel' attribute of the button.
+ *           Default: ''.
+ *     @type string $link_title Optional. Title attribute of the button.
+ *           Default: ''.
+ *     @type string $link_text Optional. Text to appear on the button.
+ *           Default: ''.
+ *
+ *     @type string      $id                String describing the button type.
+ *     @type string      $component         The name of the component the button belongs to.
+ *                                          Default: 'core'.
+ *     @type bool        $must_be_logged_in Optional. Does the user need to be logged
+ *                                          in to see this button? Default: true.
+ *     @type bool        $block_self        Optional. True if the button should be hidden
+ *                                          when a user is viewing his own profile.
+ *                                          Default: true.
+ *     @type string|bool $wrapper           Optional. HTML element type that should wrap
+ *                                          the button: 'div', 'span', 'p', or 'li'.
+ *                                          False for no wrapper at all. Default: 'div'.
+ *     @type string      $wrapper_id        Optional. DOM ID of the button wrapper element.
+ *                                          Default: ''.
+ *     @type string      $wrapper_class     Optional. DOM class of the button wrapper
+ *                                          element. Default: ''.
+ *     @type string      $link_href         Optional. Destination link of the button.
+ *                                          Default: ''.
+ *     @type string      $link_class        Optional. DOM class of the button. Default: ''.
+ *     @type string      $link_id           Optional. DOM ID of the button. Default: ''.
+ *     @type string      $link_rel          Optional. DOM 'rel' attribute of the button.
+ *                                          Default: ''.
+ *     @type string      $link_title        Optional. Title attribute of the button.
+ *                                          Default: ''.
+ *     @type string      $link_text         Optional. Text to appear on the button.
+ *                                          Default: ''.
  * }
  */
 …
      * @since BuddyPress (1.2.6)
+     *
+     * @param array $args See {@BP_Button}.
+     * @return bool|null Returns false when the button is not allowed for
+     *         the current context.
+     * @param array|string $args See {@BP_Button}.
      */
     public function __construct( $args = '' ) {

trunk/src/bp-core/classes/class-bp-core-notification.php

-                      r9819
+                      r10012
     /**
      * The notification id
+     *
      * @var integer
+     * The notification id.
+     *
+     * @var int
      */
     public $id;
 …
      * The ID to which the notification relates to within the component.
+     *
      * @var integer
+     * @var int
      */
     public $item_id;
 …
      * The secondary ID to which the notification relates to within the component.
+     *
      * @var integer
+     * @var int
      */
     public $secondary_item_id = null;
 …
      * The user ID for who the notification is for.
+     *
      * @var integer
+     * @var int
      */
     public $user_id;
 …
      * Constructor
+     *
      * @param integer $id
+     * @param int $id
      */
     public function __construct( $id = 0 ) {
 …
      * Update or insert notification details into the database.
+     *
+     * @global wpdb $wpdb WordPress database object
+     * @return bool Success or failure
+     * @global wpdb $wpdb WordPress database object.
+     *
+     * @return bool Success or failure.
      */
     public function save() {
 …
      * Fetches the notification data from the database.
+     *
      * @global wpdb $wpdb WordPress database object
+     * @global wpdb $wpdb WordPress database object.
      */
     public function populate() {
 …
     /** Static Methods ********************************************************/
+    /**
+     * Check the access for a user.
+     *
+     * @param int $user_id         ID to check access for.
+     * @param int $notification_id Notification ID to check for.
+     *
+     * @return string
+     */
     public static function check_access( $user_id, $notification_id ) {
         global $wpdb;
 …
+     *
      * @global wpdb $wpdb WordPress database object
+     * @param integer $user_id User ID
+     * @param string $status 'is_new' or 'all'
+     *
+     * @param int    $user_id User ID.
+     * @param string $status 'is_new' or 'all'.
+     *
      * @return array Associative array
      * @static
 …
      * Delete all the notifications for a user based on the component name and action.
+     *
+     * @global wpdb $wpdb WordPress database object
+     * @param integer $user_id
+     * @global wpdb $wpdb WordPress database object.
+     *
+     * @param int    $user_id
      * @param string $component_name
      * @param string $component_action
+     * @static
+     *
+     * @static
+     *
+     * @return mixed
      */
     public static function delete_for_user_by_type( $user_id, $component_name, $component_action ) {
 …
      * Delete all the notifications that have a specific item id, component name and action.
+     *
+     * @global wpdb $wpdb WordPress database object
+     * @param integer $user_id The ID of the user who the notifications are for.
+     * @param integer $item_id The item ID of the notifications we wish to delete.
+     * @param string $component_name The name of the component that the notifications we wish to delete.
+     * @param string $component_action The action of the component that the notifications we wish to delete.
+     * @param integer $secondary_item_id (optional) The secondary item id of the notifications that we wish to use to delete.
+     * @static
+     * @global wpdb $wpdb WordPress database object.
+     *
+     * @param int      $user_id           The ID of the user who the notifications are for.
+     * @param int      $item_id           The item ID of the notifications we wish to delete.
+     * @param string   $component_name    The name of the component that the notifications we wish to delete.
+     * @param string   $component_action  The action of the component that the notifications we wish to delete.
+     * @param int|bool $secondary_item_id (optional) The secondary item id of the notifications that we wish to
+     *                                    use to delete.
+     * @static
+     *
+     * @return mixed
      */
     public static function delete_for_user_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
 …
      * Deletes all the notifications sent by a specific user, by component and action.
+     *
+     * @global wpdb $wpdb WordPress database object
+     * @param integer $user_id The ID of the user whose sent notifications we wish to delete.
+     * @param string $component_name The name of the component the notification was sent from.
+     * @global wpdb $wpdb WordPress database object.
+     *
+     * @param int    $user_id          The ID of the user whose sent notifications we wish to delete.
+     * @param string $component_name   The name of the component the notification was sent from.
      * @param string $component_action The action of the component the notification was sent from.
      * @static
+     *
+     * @return mixed
      */
     public static function delete_from_user_by_type( $user_id, $component_name, $component_action ) {
 …
     /**
+     * Deletes all the notifications for all users by item id, and optional secondary item id, and component name and action.
+     *
+     * @global wpdb $wpdb WordPress database object
+     * @param string $item_id The item id that they notifications are to be for.
+     * @param string $component_name The component that the notifications are to be from.
+     * @param string $component_action The action that the notifications are to be from.
+     * Deletes all the notifications for all users by item id, and optional secondary item id,
+     * and component name and action.
+     *
+     * @global wpdb $wpdb WordPress database object.
+     *
+     * @param string $item_id           The item id that they notifications are to be for.
+     * @param string $component_name    The component that the notifications are to be from.
+     * @param string $component_action  The action that the notifications are to be from.
      * @param string $secondary_item_id Optional secondary item id that the notifications are to have.
      * @static
+     *
+     * @return mixed
      */
     public static function delete_all_by_type( $item_id, $component_name, $component_action, $secondary_item_id ) {

trunk/src/bp-core/classes/class-bp-core-user.php

-                      r9819
+                      r10012
     /**
      * The full name of the user
+     * The full name of the user.
+     *
      * @var string
 …
     /**
      * The total number of blog posts posted by the user
+     * The total number of blog posts posted by the user.
+     *
      * @var integer
 …
      * Class constructor.
+     *
      * @param integer $user_id The ID for the user being queried.
      * @param bool $populate_extras Whether to fetch extra information
      *        such as group/friendship counts or not. Default: false.
+     * @param integer $user_id         The ID for the user being queried.
+     * @param bool    $populate_extras Whether to fetch extra information such as
+     *                                 group/friendship counts or not. Default: false.
      */
     public function __construct( $user_id, $populate_extras = false ) {
 …
      *      are used there in the same way.
+     *
      * @param string $type See {@link BP_User_Query}.
      * @param int $limit See {@link BP_User_Query}. Default: 0.
      * @param int $page See {@link BP_User_Query}. Default: 1.
      * @param int $user_id See {@link BP_User_Query}. Default: 0.
      * @param mixed $include See {@link BP_User_Query}. Default: false.
      * @param string|bool $search_terms See {@link BP_User_Query}.
      *        Default: false.
      * @param bool $populate_extras See {@link BP_User_Query}.
      *        Default: true.
      * @param mixed $exclude See {@link BP_User_Query}. Default: false.
      * @param string|bool $meta_key See {@link BP_User_Query}.
      *        Default: false.
      * @param string|bool $meta_value See {@link BP_User_Query}.
      *        Default: false.
+     * @param string      $type            See {@link BP_User_Query}.
+     * @param int         $limit           See {@link BP_User_Query}. Default: 0.
+     * @param int         $page            See {@link BP_User_Query}. Default: 1.
+     * @param int         $user_id         See {@link BP_User_Query}. Default: 0.
+     * @param mixed       $include         See {@link BP_User_Query}. Default: false.
+     * @param string|bool $search_terms    See {@link BP_User_Query}.
+     *                                     Default: false.
+     * @param bool        $populate_extras See {@link BP_User_Query}.
+     *                                     Default: true.
+     * @param mixed       $exclude         See {@link BP_User_Query}. Default: false.
+     * @param string|bool $meta_key        See {@link BP_User_Query}.
+     *                                     Default: false.
+     * @param string|bool $meta_value      See {@link BP_User_Query}.
+     *                                     Default: false.
      * @return array {
      *     @type int $total_users Total number of users matched by query
      *           params.
+     *     @type int   $total_users Total number of users matched by query
+     *                              params.
      *     @type array $paged_users The current page of users matched by
      *           query params.
+     *                              query params.
      * }
      */
 …
      * @global wpdb $wpdb WordPress database object.
+     *
      * @param string $letter The letter the users names are to start with.
      * @param int $limit The number of users we wish to retrive.
      * @param int $page The page number we are currently on, used in
      *        conjunction with $limit to get the start position for the
      *        limit.
      * @param bool $populate_extras Populate extra user fields?
      * @param string $exclude Comma-separated IDs of users whose results
      *        aren't to be fetched.
+     * @param string $letter          The letter the users names are to start with.
+     * @param int    $limit           The number of users we wish to retrive.
+     * @param int    $page            The page number we are currently on, used in conjunction
+     *                                with $limit to get the start position for the limit.
+     * @param bool   $populate_extras Populate extra user fields?
+     * @param string $exclude         Comma-separated IDs of users whose results
+     *                                aren't to be fetched.
+     *
      * @return mixed False on error, otherwise associative array of results.
      */
 …
+     *
      * @global wpdb $wpdb WordPress database object.
+     * @param array $user_ids The user IDs of the users who we wish to
+     *        fetch information on.
+     * @param int $limit The limit of results we want.
+     * @param int $page The page we are on for pagination.
+     * @param bool $populate_extras Populate extra user fields?
+     *
+     * @param array $user_ids        The user IDs of the users who we wish to
+     *                               fetch information on.
+     * @param int   $limit           The limit of results we want.
+     * @param int   $page            The page we are on for pagination.
+     * @param bool  $populate_extras Populate extra user fields?
+     *
      * @return array Associative array.
      */
 …
      * @global wpdb $wpdb WordPress database object.
+     *
      * @param string $search_terms The terms to search the profile table
      *        value column for.
      * @param integer $limit The limit of results we want.
      * @param integer $page The page we are on for pagination.
+     * @param string  $search_terms    The terms to search the profile table
+     *                                 value column for.
+     * @param int     $limit           The limit of results we want.
+     * @param int     $page            The page we are on for pagination.
      * @param boolean $populate_extras Populate extra user fields?
+     *
      * @return array Associative array.
      */
 …
      * @global wpdb $wpdb WordPress database object.
+     *
+     * @param array $paged_users An array of stdClass containing the users.
+     * @param string $user_ids The user ids to select information about.
+     * @param string $type The type of fields we wish to get.
+     * @param array       $paged_users An array of stdClass containing the users.
+     * @param string      $user_ids    The user ids to select information about.
+     * @param string|bool $type        The type of fields we wish to get.
+     *
      * @return mixed False on error, otherwise associative array of results.
      */
 …
      * @global wpdb $wpdb WordPress database object.
+     *
+     * @param integer $user_id User ID.
+     * @param int $user_id User ID.
+     *
      * @return array Associative array.
      */
 …
+     *
      * @param int|array User IDs or multiple user IDs.
+     *
      * @return array
      */
 …
      * @since BuddyPress (2.0.0)
+     *
+     * @param int $user_id ID of the user whose last_activity you are updating.
+     * @param string $time MySQL-formatted time string.
+     * @param int    $user_id ID of the user whose last_activity you are updating.
+     * @param string $time    MySQL-formatted time string.
+     *
      * @return bool True on success, false on failure.
      */
 …
+     *
      * @param int $user_id
+     *
      * @return bool True on success, false on failure or if no last_activity
      *         is found for the user.
+     *              is found for the user.
      */
     public static function delete_last_activity( $user_id ) {

trunk/src/bp-core/classes/class-bp-date-query.php

-                      r9819
+                      r10012
      * Constructor.
+     *
+     * @param array  $date_query
+     * @param string $column
+     *
      * @see WP_Date_Query::__construct()
      */
 …
      * Registers our date column with WP Date Query to pass validation.
+     *
+     * @param array $retval Current DB columns
+     * @param array $retval Current DB columns.
+     *
      * @return array
      */

trunk/src/bp-core/classes/class-bp-embed.php

-                      r9819
+                      r10012
      * @uses WP_Embed::maybe_make_link()
+     *
+     * @param array $attr Shortcode attributes.
+     * @param string $url The URL attempting to be embeded.
+     * @param array  $attr Shortcode attributes.
+     * @param string $url  The URL attempting to be embeded.
+     *
      * @return string The embed HTML on success, otherwise the original URL.
      */
 …
      *       oEmbed failure.
+     *
+     * @param int $id ID to do the caching for.
+     * @param string $url The URL attempting to be embedded.
+     * @param array $attr Shortcode attributes from {@link WP_Embed::shortcode()}.
+     * @param array $rawattr Untouched shortcode attributes from
+     *        {@link WP_Embed::shortcode()}.
+     * @param int    $id      ID to do the caching for.
+     * @param string $url     The URL attempting to be embedded.
+     * @param array  $attr    Shortcode attributes from {@link WP_Embed::shortcode()}.
+     * @param array  $rawattr Untouched shortcode attributes from
+     *                        {@link WP_Embed::shortcode()}.
+     *
      * @return string The embed HTML on success, otherwise the original URL.
      */

trunk/src/bp-core/classes/class-bp-media-extractor.php

-                      r9819
+                      r10012
  * Extracts media from text. Use {@link extract()}.
+ *
+ * @since BuddyPress (2.3.0)
+ *
  * The supported types are links, mentions, images, shortcodes, embeds, audio, video, and "all".
  * This is what each type extracts:
 …
  * Links:      <a href="http://example.com">
  * Mentions:   @name
  *             If the Activity component is enabled, we use it to parse out any @names. A consequence
+ *             If the Activity component is enabled, we use it to parse out any at-names. A consequence
  *             to note is that the "name" mentioned must match a real user account. If it's a made-up
  *             @name, then it isn't extracted.
  *             If the Activity component is disabled, any @name is extracted (both those matching
+ *             at-name, then it isn't extracted.
+ *             If the Activity component is disabled, any at-name is extracted (both those matching
  *             real accounts, and those made-up).
  * Images:     <img src="image.gif">, [gallery], [gallery ids="2,3"], featured images (Post thumbnails).
 …
+ *
  * @see BP_Media_Extractor::extract() Use this to extract media.
- * @since BuddyPress (2.3.0)
  */
 class BP_Media_Extractor {
 …
      * Extract media from text.
+     *
+     * @param string|WP_Post $richtext Content to parse.
+     * @param int $what_to_extract Media type to extract (optional).
+     * @param array $extra_args Bespoke data for a particular extractor (optional).
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string|WP_Post $richtext        Content to parse.
+     * @param int            $what_to_extract Media type to extract (optional).
+     * @param array          $extra_args      Bespoke data for a particular extractor (optional).
+     *
      * @return array {
      *     @type array $has Extracted media counts. {
 …
+     *
      *         @type string $source Media source. Either "html" or "shortcodes".
      *         @type string $url Link to audio.
+     *         @type string $url    Link to audio.
      *     }
      *     @type array $embeds Extracted oEmbeds. {
 …
      *         Array of extracted media.
+     *
      *         @type int $gallery_id Gallery ID. Optional, not always set.
      *         @type int $height Width of image. If unknown, set to 0.
      *         @type string $source Media source. Either "html" or "galleries".
      *         @type string $url Link to image.
      *         @type int $width Width of image. If unknown, set to 0.
+     *         @type int    $gallery_id Gallery ID. Optional, not always set.
+     *         @type int    $height     Width of image. If unknown, set to 0.
+     *         @type string $source     Media source. Either "html" or "galleries".
+     *         @type string $url        Link to image.
+     *         @type int    $width      Width of image. If unknown, set to 0.
      *     }
      *     @type array $links Extracted URLs. {
 …
      *         Array of extracted media.
+     *
      *         @type string $name @mention.
+     *         @type string $name    @mention.
      *         @type string $user_id User ID. Optional, only set if Activity component enabled.
      *     }
 …
      *         Array of extracted media.
+     *
      *         @type array $attributes Key/value pairs of the shortcodes attributes (if any).
      *         @type string $content Text wrapped by the shortcode.
      *         @type string $type Shortcode type.
      *         @type string $original The entire shortcode.
+     *         @type array  $attributes Key/value pairs of the shortcodes attributes (if any).
+     *         @type string $content    Text wrapped by the shortcode.
+     *         @type string $type       Shortcode type.
+     *         @type string $original   The entire shortcode.
      *     }
      *     @type array $videos Extracted video. {
 …
+     *
      *         @type string $source Media source. Currently only "shortcodes".
      *         @type string $url Link to audio.
+     *         @type string $url    Link to audio.
      *     }
      * }
-     * @since BuddyPress (2.3.0)
      */
     public function extract( $richtext, $what_to_extract = self::ALL, $extra_args = array() ) {
 …
          * Filters media extracted from text.
+         *
+         * @param array $media Extracted media. See {@link BP_Media_Extractor::extract()} for format.
+         * @param string $richtext Content to parse.
+         * @param int $what_to_extract Media type to extract.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $media           Extracted media. See {@link BP_Media_Extractor::extract()} for format.
+         * @param string $richtext        Content to parse.
+         * @param int    $what_to_extract Media type to extract.
+         * @param array  $extra_args      Bespoke data for a particular extractor.
+         * @param string $plaintext       Copy of $richtext without any markup.
          */
         return apply_filters( 'bp_media_extractor_extract', $media, $richtext, $what_to_extract, $extra_args, $plaintext );
 …
      * Extract `<a href>` tags from text.
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Bespoke data for a particular extractor (optional).
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Bespoke data for a particular extractor (optional).
+     *
      * @return array {
      *     @type array $has Extracted media counts. {
 …
      *     }
      * }
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_links( $richtext, $plaintext, $extra_args = array() ) {
 …
          * Filters links extracted from text.
+         *
+         * @param array $data Extracted links. See {@link BP_Media_Extractor::extract_links()} for format.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $data       Extracted links. See {@link BP_Media_Extractor::extract_links()} for format.
+         * @param string $richtext   Content to parse.
+         * @param string $plaintext  Copy of $richtext without any markup.
+         * @param array  $extra_args Bespoke data for a particular extractor.
          */
         return apply_filters( 'bp_media_extractor_links', $data, $richtext, $plaintext, $extra_args );
 …
      * If the Activity component is disabled, any @mentions are extracted.
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Bespoke data for a particular extractor.
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Bespoke data for a particular extractor.
+     *
      * @return array {
      *     @type array $has Extracted media counts. {
 …
      *         Array of extracted media.
+     *
      *         @type string $name @mention.
+     *         @type string $name    @mention.
      *         @type string $user_id User ID. Optional, only set if Activity component enabled.
      *     }
      * }
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_mentions( $richtext, $plaintext, $extra_args = array() ) {
 …
          * Filters @mentions extracted from text.
+         *
+         * @param array $data Extracted @mentions. See {@link BP_Media_Extractor::extract_mentions()} for format.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor (optional).
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $data       Extracted @mentions. See {@link BP_Media_Extractor::extract_mentions()} for format.
+         * @param string $richtext   Content to parse.
+         * @param string $plaintext  Copy of $richtext without any markup.
+         * @param array  $extra_args Bespoke data for a particular extractor (optional).
          */
         return apply_filters( 'bp_media_extractor_mentions', $data, $richtext, $plaintext, $extra_args );
 …
      * If an image is in the Media Library, then its resolution is included in the results.
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Bespoke data for a particular extractor (optional).
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Bespoke data for a particular extractor (optional).
+     *
      * @return array {
      *     @type array $has Extracted media counts. {
 …
      *         Array of extracted media.
+     *
      *         @type int $gallery_id Gallery ID. Optional, not always set.
      *         @type int $height Width of image. If unknown, set to 0.
      *         @type string $source Media source. Either "html" or "galleries".
      *         @type string $url Link to image.
      *         @type int $width Width of image. If unknown, set to 0.
+     *         @type int    $gallery_id Gallery ID. Optional, not always set.
+     *         @type int    $height     Width of image. If unknown, set to 0.
+     *         @type string $source     Media source. Either "html" or "galleries".
+     *         @type string $url        Link to image.
+     *         @type int    $width      Width of image. If unknown, set to 0.
      *     }
      * }
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_images( $richtext, $plaintext, $extra_args = array() ) {
 …
          * Filters images extracted from text.
+         *
+         * @param array $media Extracted images. See {@link BP_Media_Extractor::extract_images()} for format.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $media      Extracted images. See {@link BP_Media_Extractor::extract_images()} for format.
+         * @param string $richtext   Content to parse.
+         * @param string $plaintext  Copy of $richtext without any markup.
+         * @param array  $extra_args Bespoke data for a particular extractor.
          */
         return apply_filters( 'bp_media_extractor_images', $media, $richtext, $plaintext, $extra_args );
 …
      * For example, [gallery] and [audio].
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Bespoke data for a particular extractor (optional).
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Bespoke data for a particular extractor (optional).
+     *
      * @return array {
      *     @type array $has Extracted media counts. {
 …
      *         Array of extracted media.
+     *
      *         @type array $attributes Key/value pairs of the shortcodes attributes (if any).
      *         @type string $content Text wrapped by the shortcode.
      *         @type string $type Shortcode type.
      *         @type string $original The entire shortcode.
+     *         @type array  $attributes Key/value pairs of the shortcodes attributes (if any).
+     *         @type string $content    Text wrapped by the shortcode.
+     *         @type string $type       Shortcode type.
+     *         @type string $original   The entire shortcode.
      *     }
      * }
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_shortcodes( $richtext, $plaintext, $extra_args = array() ) {
 …
          * Filters shortcodes extracted from text.
+         *
+         * @param array $data Extracted shortcodes. See {@link BP_Media_Extractor::extract_shortcodes()} for format.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $data       Extracted shortcodes.
+         *                           See {@link BP_Media_Extractor::extract_shortcodes()} for format.
+         * @param string $richtext   Content to parse.
+         * @param string $plaintext  Copy of $richtext without any markup.
+         * @param array  $extra_args Bespoke data for a particular extractor.
          */
         return apply_filters( 'bp_media_extractor_shortcodes', $data, $richtext, $plaintext, $extra_args );
 …
      * Extract any URL, matching a registered oEmbed endpoint, from text.
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Bespoke data for a particular extractor (optional).
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Bespoke data for a particular extractor (optional).
+     *
      * @return array {
      *     @type array $has Extracted media counts. {
 …
      *     }
      * }
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_embeds( $richtext, $plaintext, $extra_args = array() ) {
 …
          * Filters embeds extracted from text.
+         *
+         * @param array $data Extracted embeds. See {@link BP_Media_Extractor::extract_embeds()} for format.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $data       Extracted embeds. See {@link BP_Media_Extractor::extract_embeds()} for format.
+         * @param string $richtext   Content to parse.
+         * @param string $plaintext  Copy of $richtext without any markup.
+         * @param array  $extra_args Bespoke data for a particular extractor.
          */
         return apply_filters( 'bp_media_extractor_embeds', $data, $richtext, $plaintext, $extra_args );
 …
      * Extract [audio] shortcodes and `<a href="*.mp3">` tags, from text.
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Bespoke data for a particular extractor (optional).
+     * @since BuddyPress (2.3.0)
+     *
+     * @see wp_get_audio_extensions() for supported audio formats.
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Bespoke data for a particular extractor (optional).
+     *
      * @return array {
      *     @type array $has Extracted media counts. {
 …
+     *
      *         @type string $original The entire shortcode.
      *         @type string $source Media source. Either "html" or "shortcodes".
      *         @type string $url Link to audio.
+     *         @type string $source   Media source. Either "html" or "shortcodes".
+     *         @type string $url      Link to audio.
      *     }
      * }
-     * @see wp_get_audio_extensions() for supported audio formats.
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_audio( $richtext, $plaintext, $extra_args = array() ) {
 …
          * Filters audio extracted from text.
+         *
+         * @param array $data Extracted audio. See {@link BP_Media_Extractor::extract_audio()} for format.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $data       Extracted audio. See {@link BP_Media_Extractor::extract_audio()} for format.
+         * @param string $richtext   Content to parse.
+         * @param string $plaintext  Copy of $richtext without any markup.
+         * @param array  $extra_args Bespoke data for a particular extractor.
          */
         return apply_filters( 'bp_media_extractor_audio', $data, $richtext, $plaintext, $extra_args );
 …
      * Extract [video] shortcodes from text.
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Bespoke data for a particular extractor (optional).
+     * @since BuddyPress (2.3.0)
+     *
+     * @see wp_get_video_extensions() for supported video formats.
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Bespoke data for a particular extractor (optional).
+     *
      * @return array {
      *     @type array $has Extracted media counts. {
 …
+     *
      *         @type string $source Media source. Currently only "shortcodes".
      *         @type string $url Link to audio.
+     *         @type string $url    Link to audio.
      *     }
      * }
-     * @see wp_get_video_extensions() for supported video formats.
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_video( $richtext, $plaintext, $extra_args = array() ) {
 …
          * Filters videos extracted from text.
+         *
+         * @param array $data Extracted videos. See {@link BP_Media_Extractor::extract_videos()} for format.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $data       Extracted videos. See {@link BP_Media_Extractor::extract_videos()} for format.
+         * @param string $richtext   Content to parse.
+         * @param string $plaintext  Copy of $richtext without any markup.
+         * @param array  $extra_args Bespoke data for a particular extractor.
          */
         return apply_filters( 'bp_media_extractor_videos', $data, $richtext, $plaintext, $extra_args );
 …
      * Extract images in [galleries] shortcodes from text.
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Bespoke data for a particular extractor (optional).
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Bespoke data for a particular extractor (optional).
+     *
      * @return array
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_images_from_galleries( $richtext, $plaintext, $extra_args = array() ) {
 …
          * Filters image galleries extracted from text.
+         *
+         * @param array $galleries_data Galleries. See {@link BP_Media_Extractor::extract_images_from_galleries()}.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $galleries_data Galleries. See {@link BP_Media_Extractor::extract_images_from_galleries()}.
+         * @param string $richtext       Content to parse.
+         * @param string $plaintext      Copy of $richtext without any markup.
+         * @param array  $extra_args     Bespoke data for a particular extractor.
          */
         return apply_filters( 'bp_media_extractor_galleries', $galleries_data, $richtext, $plaintext, $extra_args );
 …
      * Extract the featured image from a Post.
+     *
+     * @param string $richtext Content to parse.
+     * @param string $plaintext Sanitized version of the content.
+     * @param array $extra_args Contains data that an implementation might need beyond the defaults.
+     * @since BuddyPress (2.3.0)
+     *
+     * @param string $richtext   Content to parse.
+     * @param string $plaintext  Sanitized version of the content.
+     * @param array  $extra_args Contains data that an implementation might need beyond the defaults.
+     *
      * @return array
-     * @since BuddyPress (2.3.0)
      */
     protected function extract_images_from_featured_images( $richtext, $plaintext, $extra_args ) {
 …
          * Filters featured images extracted from a WordPress Post.
+         *
+         * @param array $image Extracted images. See {@link BP_Media_Extractor_Post::extract_images()} for format.
+         * @param string $richtext Content to parse.
+         * @param string $plaintext Copy of $richtext without any markup.
+         * @param array $extra_args Bespoke data for a particular extractor.
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $image      Extracted images. See {@link BP_Media_Extractor_Post::extract_images()} for format.
+         * @param string $richtext   Content to parse.
+         * @param string $plaintext  Copy of $richtext without any markup.
+         * @param array  $extra_args Bespoke data for a particular extractor.
          */
         return apply_filters( 'bp_media_extractor_featured_images', $image, $richtext, $plaintext, $extra_args );
 …
      * HTML tags and shortcodes are removed, and HTML entities are decoded.
+     *
+     * @since BuddyPress (2.3.0)
+     *
      * @param string $richtext
+     *
      * @return string
-     * @since BuddyPress (2.3.0)
      */
     protected function strip_markup( $richtext ) {
 …
          * Filters the generated plain text version of the content passed to the extractor.
+         *
+         * @param array $plaintext Generated plain text.
+         * @param string $richtext Original content
+         * @since BuddyPress (2.3.0)
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array  $plaintext Generated plain text.
+         * @param string $richtext  Original content.
          */
         return apply_filters( 'bp_media_extractor_strip_markup', $plaintext, $richtext );

trunk/src/bp-core/classes/class-bp-members-suggestions.php

-                      r9819
+                      r10012
      * @since BuddyPress (2.1.0)
      * @var array $args {
      *     @type int $limit Maximum number of results to display. Default: 16.
      *     @type bool $only_friends If true, only match the current user's friends. Default: false.
      *     @type string $term The suggestion service will try to find results that contain this string.
      *           Mandatory.
+     *     @type int    $limit        Maximum number of results to display. Default: 16.
+     *     @type bool   $only_friends If true, only match the current user's friends. Default: false.
+     *     @type string $term         The suggestion service will try to find results that contain this string.
+     *                                Mandatory.
      * }
      */
 …
      * Validate and sanitise the parameters for the suggestion service query.
+     *
+     * @since BuddyPress (2.1.0)
+     *
      * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
-     * @since BuddyPress (2.1.0)
      */
     public function validate() {
 …
      * Find and return a list of username suggestions that match the query.
+     *
+     * @since BuddyPress (2.1.0)
+     *
      * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.
-     * @since BuddyPress (2.1.0)
      */
     public function get_suggestions() {

trunk/src/bp-core/classes/class-bp-recursive-query.php

-                      r9819
+                      r10012
      * @access protected
+     *
-     * @param  string $primary_table
-     * @param  string $primary_id_column
      * @return array
      */
 …
      * @access public
+     *
+     * @param  array $queries Array of query clauses.
+     * @param array $queries Array of query clauses.
+     *
      * @return array Sanitized array of query clauses.
      */
 …
      * @access protected
+     *
+     * @param  array $clause       Array of arguments belonging to the clause.
+     * @param  array $parent_query Parent query to which the clause belongs.
+     * @param array $clause       Array of arguments belonging to the clause.
+     * @param array $parent_query Parent query to which the clause belongs.
+     *
      * @return array {
      *     @type array $join  Array of subclauses for the JOIN statement.
 …
      * @access protected
+     *
+     * @param  array $q Clause to check.
+     * @param array $query Clause to check.
+     *
      * @return bool
      */

trunk/src/bp-core/classes/class-bp-suggestions.php

-                      r9819
+                      r10012
+     *
      * @param array $args {
      *     @type int $limit Maximum number of results to display. Optional, default: 16.
      *     @type string $type The name of the suggestion service to use for the request. Mandatory.
      *     @type string $term The suggestion service will try to find results that contain this string.
      *           Mandatory.
+     *     @type int    $limit Maximum number of results to display. Optional, default: 16.
+     *     @type string $type  The name of the suggestion service to use for the request. Mandatory.
+     *     @type string $term  The suggestion service will try to find results that contain this string.
+     *                         Mandatory.
      * }
      * @since BuddyPress (2.1.0)
 …
      * If validation fails, you must return a WP_Error object.
+     *
+     * @since BuddyPress (2.1.0)
+     *
      * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
-     * @since BuddyPress (2.1.0)
      */
     public function validate() {
 …
      * For example: { 'ID': 'admin', 'image': 'http://example.com/logo.png', 'name': 'Name Surname' }
+     *
+     * @since BuddyPress (2.1.0)
+     *
      * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.
-     * @since BuddyPress (2.1.0)
      */
     abstract public function get_suggestions();

trunk/src/bp-core/classes/class-bp-user-query.php

-                      r9977
+                      r10012
  *     @type array|string      $member_type__in     Array or comma-separated list of member types to limit results to.
  *     @type array|string      $member_type__not_in Array or comma-separated list of member types that will be
  *                                      excluded from results.
+ *                                                       excluded from results.
  *     @type string|bool       $meta_key            Limit results to users that have usermeta associated with this meta_key.
  *                                                  Usually used with $meta_value. Default: false.
 …
      * @since BuddyPress (1.8.0)
+     *
+     * @param array Sanitized array of user IDs, as passed to the 'include'
+     *        parameter of the class constructor.
+     * @param array $include Sanitized array of user IDs, as passed to the 'include'
+     *                       parameter of the class constructor.
+     *
      * @return array The list of users to which the main query should be
      *         limited.
+     *               limited.
      */
     public function get_include_ids( $include = array() ) {
 …
      * @param string|array $member_types Array or comma-separated list of member types.
      * @param string       $operator     'IN' or 'NOT IN'.
+     *
+     * @return string
      */
     protected function get_sql_clause_for_member_types( $member_types, $operator ) {

trunk/src/bp-core/classes/class-bp-walker-nav-menu-checklist.php

-                      r9819
+                      r10012
+ *
  * Borrowed heavily from {@link Walker_Nav_Menu_Checklist}, but modified so as not
  * to require an actual post type or taxonomy, and to force certain CSS classes
+ * to require an actual post type or taxonomy, and to force certain CSS classes.
+ *
  * @since BuddyPress (1.9.0)
 …
      * @see Walker_Nav_Menu::__construct() for a description of parameters.
+     *
      * @param array $fields See {@link Walker_Nav_Menu::__construct()}.
+     * @param array|bool $fields See {@link Walker_Nav_Menu::__construct()}.
      */
     public function __construct( $fields = false ) {
 …
+     *
      * @param string $output See {@Walker_Nav_Menu::start_lvl()}.
      * @param int $depth See {@Walker_Nav_Menu::start_lvl()}.
      * @param array $args See {@Walker_Nav_Menu::start_lvl()}.
+     * @param int    $depth  See {@Walker_Nav_Menu::start_lvl()}.
+     * @param array  $args   See {@Walker_Nav_Menu::start_lvl()}.
      */
     public function start_lvl( &$output, $depth = 0, $args = array() ) {
 …
+     *
      * @param string $output See {@Walker_Nav_Menu::end_lvl()}.
      * @param int $depth See {@Walker_Nav_Menu::end_lvl()}.
      * @param array $args See {@Walker_Nav_Menu::end_lvl()}.
+     * @param int    $depth  See {@Walker_Nav_Menu::end_lvl()}.
+     * @param array  $args   See {@Walker_Nav_Menu::end_lvl()}.
      */
     public function end_lvl( &$output, $depth = 0, $args = array() ) {
 …
      * @see Walker::start_el() for description of parameters.
+     *
      * @param string $output Passed by reference. Used to append additional
      *        content.
      * @param object $item Menu item data object.
      * @param int $depth Depth of menu item. Used for padding.
      * @param object $args See {@Walker::start_el()}.
      * @param int $id See {@Walker::start_el()}.
+     * @param string       $output Passed by reference. Used to append additional
+     *                             content.
+     * @param object       $item   Menu item data object.
+     * @param int          $depth  Depth of menu item. Used for padding.
+     * @param object|array $args   See {@Walker::start_el()}.
+     * @param int          $id     See {@Walker::start_el()}.
      */
     function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {

trunk/src/bp-core/classes/class-bp-walker-nav-menu.php

-                      r9819
+                      r10012
      * @see Walker::walk()
+     *
+     * @param array $elements See {@link Walker::walk()}.
+     * @param int $max_depth See {@link Walker::walk()}.
+     * @param array $elements  See {@link Walker::walk()}.
+     * @param int   $max_depth See {@link Walker::walk()}.
+     *
      * @return string See {@link Walker::walk()}.
      */
 …
         /*
          * need to display in hierarchical order
+         * Need to display in hierarchical order
          * separate elements into two buckets: top level and children elements
          * children_elements is two dimensional array, eg.
 …
         /*
          * when none of the elements is top level
          * assume the first one must be root of the sub elements
+         * When none of the elements is top level
+         * assume the first one must be root of the sub elements.
          */
         if ( empty( $top_level_elements ) ) {
 …
      * Display the current <li> that we are on.
+     *
      * @see Walker::start_el() for complete description of parameters .
+     * @see Walker::start_el() for complete description of parameters.
+     *
      * @since BuddyPress (1.7.0)
+     *
      * @param string $output Passed by reference. Used to append
      *        additional content.
      * @param object $item Menu item data object.
      * @param int $depth Depth of menu item. Used for padding. Optional,
      *        defaults to 0.
      * @param array $args Optional. See {@link Walker::start_el()}.
      * @param int $current_page Menu item ID. Optional.
+     *                       additional content.
+     * @param object $item   Menu item data object.
+     * @param int    $depth  Depth of menu item. Used for padding. Optional,
+     *                       defaults to 0.
+     * @param array  $args   Optional. See {@link Walker::start_el()}.
+     * @param int    $id     Menu item ID. Optional.
      */
     public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {

trunk/src/bp-core/deprecated/1.5.php

<

-                      r9819
+                      r10012
  * @deprecated BuddyPress (1.5)
  * @deprecated Use is_multisite()
+ *
+ * @return bool
  */
 function bp_core_is_multisite() {
 …
  * @deprecated Use is_main_site()
  * @package BuddyPress
  * @param int $blog_id optional blog id to test (default current blog)
+ * @param int|string $blog_id optional blog id to test (default current blog)
  * @return bool True if not multisite or $blog_id is main site
  * @since BuddyPress (1.2.6)
 …
+}
-/**
- * WPMU version of is_super_admin()
+ *
- * @deprecated BuddyPress (1.5)
- * @deprecated Use is_super_admin()
- * @param int $user_id Optional. Defaults to logged-in user
- * @return bool True if is super admin
- */
 if ( !function_exists( 'is_site_admin' ) ) {
+    /**
+     * WPMU version of is_super_admin()
+     *
+     * @deprecated BuddyPress (1.5)
+     * @deprecated Use is_super_admin()
+     * @param int|bool $user_id Optional. Defaults to logged-in user
+     * @return bool True if is super admin
+     */
     function is_site_admin( $user_id = false ) {
         _deprecated_function( __FUNCTION__, '1.5', 'is_super_admin()' );
 …
  * @deprecated Use add_menu_page().
  * @since BuddyPress (1.1)
+ *
+ * @return string
  */
 function bp_core_add_admin_menu_page( $args = '' ) {
 …

Context Navigation

Legend: