Index: /trunk/src/bp-members/bp-members-actions.php =================================================================== --- /trunk/src/bp-members/bp-members-actions.php (revision 10710) +++ /trunk/src/bp-members/bp-members-actions.php (revision 10711) @@ -23,4 +23,6 @@ * * Note: no longer used in the current state. See the Settings component. + * + * @since 1.1.0 * * @param int $user_id Optional. User ID to mark as spam. Defaults to displayed user. @@ -74,4 +76,6 @@ * * Note: No longer called here. See the Settings component. + * + * @since 1.1.0 */ function bp_core_action_delete_user() { Index: /trunk/src/bp-members/bp-members-activity.php =================================================================== --- /trunk/src/bp-members/bp-members-activity.php (revision 10710) +++ /trunk/src/bp-members/bp-members-activity.php (revision 10711) @@ -71,4 +71,6 @@ * Create a "became a registered user" activity item when a user activates his account. * + * @since 1.2.2 + * * @param array $user Array of userdata passed to bp_core_activated_user hook. * @return bool Index: /trunk/src/bp-members/bp-members-adminbar.php =================================================================== --- /trunk/src/bp-members/bp-members-adminbar.php (revision 10710) +++ /trunk/src/bp-members/bp-members-adminbar.php (revision 10711) @@ -45,5 +45,5 @@ ) ) ); - // Show login and sign-up links. + // Show login and sign-up links. } elseif ( !empty( $wp_admin_bar ) ) { Index: /trunk/src/bp-members/bp-members-cache.php =================================================================== --- /trunk/src/bp-members/bp-members-cache.php (revision 10710) +++ /trunk/src/bp-members/bp-members-cache.php (revision 10711) @@ -53,5 +53,5 @@ * Called when the user is deleted or marked as spam. * - * @since BuddyPres (2.2.0) + * @since 2.2.0 * * @param int $user_id ID of the deleted user. Index: /trunk/src/bp-members/bp-members-filters.php =================================================================== --- /trunk/src/bp-members/bp-members-filters.php (revision 10710) +++ /trunk/src/bp-members/bp-members-filters.php (revision 10711) @@ -111,6 +111,6 @@ $profile_link = trailingslashit( bp_core_get_user_domain( $user_id ) . bp_get_profile_slug() . '/edit' ); - // Default to $url. } else { + // Default to $url. $profile_link = $url; } Index: /trunk/src/bp-members/bp-members-functions.php =================================================================== --- /trunk/src/bp-members/bp-members-functions.php (revision 10710) +++ /trunk/src/bp-members/bp-members-functions.php (revision 10711) @@ -36,4 +36,6 @@ * In general, fallback values are only used during initial BP page creation, * when no slugs have been explicitly defined. + * + * @since 1.5.0 */ function bp_core_define_slugs() { @@ -75,4 +77,6 @@ * need backward compatibility with BP_Core_User::get_users(), filter the * bp_use_legacy_user_query value, returning true. + * + * @since 1.2.0 * * @param array|string $args { @@ -159,4 +163,6 @@ * Return the domain for the passed user: e.g. http://example.com/members/andy/. * + * @since 1.0.0 + * * @param int $user_id The ID of the user. * @param string|bool $user_nicename Optional. user_nicename of the user. @@ -199,4 +205,6 @@ * Fetch everything in the wp_users table for a user, without any usermeta. * + * @since 1.2.0 + * * @param int $user_id The ID of the user. * @return array @@ -293,4 +301,6 @@ * This function is sensitive to the BP_ENABLE_USERNAME_COMPATIBILITY_MODE, * so it will return the user_login or user_nicename as appropriate. + * + * @since 1.0.0 * * @param int $user_id User ID to check. @@ -436,4 +446,6 @@ * Return the email address for the user based on user ID. * + * @since 1.0.0 + * * @param int $uid User ID to check. * @return string The email for the matched user. Empty string if no user @@ -473,4 +485,6 @@ * * Optional parameters will return just the name or just the URL. + * + * @since 1.0.0 * * @param int $user_id User ID to check. @@ -599,4 +613,6 @@ * Fetch the display name for a user. * + * @since 1.0.1 + * * @param int|string|bool $user_id_or_username User ID or username. * @return string|bool The display name for the user in question, or false if @@ -644,4 +660,6 @@ * Return the user link for the user based on user email address. * + * @since 1.0.0 + * * @param string $email The email address for the user. * @return string The link to the users home base. False on no match. @@ -662,4 +680,6 @@ /** * Return the user link for the user based on the supplied identifier. + * + * @since 1.0.0 * * @param string $username If BP_ENABLE_USERNAME_COMPATIBILITY_MODE is set, @@ -692,4 +712,6 @@ * {@link bp_core_get_active_member_count()}. * + * @since 1.2.0 + * * @return int The total number of members. */ @@ -717,4 +739,6 @@ /** * Return the total number of members, limited to those members with last_activity. + * + * @since 1.6.0 * * @return int The number of active members. @@ -920,4 +944,6 @@ * Check whether a user has been marked as a spammer. * + * @since 1.6.0 + * * @param int $user_id The ID for the user. * @return bool True if spammer, otherwise false. @@ -983,4 +1009,6 @@ /** * Check whether a user has been marked as deleted. + * + * @since 1.6.0 * * @param int $user_id The ID for the user. @@ -1215,4 +1243,6 @@ * Get the last activity for a given user. * + * @since 1.9.0 + * * @param int $user_id The ID of the user. * @return string Time of last activity, in 'Y-m-d H:i:s' format, or an empty @@ -1294,4 +1324,6 @@ * Primarily used for self-deletions, as requested through Settings. * + * @since 1.0.0 + * * @param int $user_id Optional. ID of the user to be deleted. Default: the * logged-in user. @@ -1379,4 +1411,6 @@ * * Uses multibyte functions when available on the PHP build. + * + * @since 1.0.0 * * @param string $str String to be upper-cased. @@ -1426,4 +1460,6 @@ * Delete last_activity data for the user when the user is deleted. * + * @since 1.0.0 + * * @param int $user_id The user ID for the user to delete usermeta for. */ @@ -1443,4 +1479,6 @@ * Check whether the logged-in user can edit settings for the displayed user. * + * @since 1.5.0 + * * @return bool True if editing is allowed, otherwise false. */ @@ -1465,4 +1503,6 @@ /** * Flush illegal names by getting and setting 'illegal_names' site option. + * + * @since 1.2.5 */ function bp_core_flush_illegal_names() { @@ -1473,4 +1513,6 @@ /** * Add BuddyPress-specific items to the illegal_names array. + * + * @since 1.2.7 * * @param array|string $value Illegal names as being saved defined in @@ -1642,4 +1684,6 @@ * Validate a user name and email address when creating a new user. * + * @since 1.2.2 + * * @param string $user_name Username to validate. * @param string $user_email Email address to validate. @@ -1745,4 +1789,6 @@ * Validate blog URL and title provided at signup. * + * @since 1.2.2 + * * @todo Why do we have this wrapper? * @@ -1768,4 +1814,6 @@ /** * Process data submitted at user registration and convert to a signup object. + * + * @since 1.2.0 * * @todo There appears to be a bug in the return value on success. @@ -1866,4 +1914,6 @@ * Create a blog and user based on data supplied at user registration. * + * @since 1.2.2 + * * @param string $blog_domain Domain requested by user. * @param string $blog_path Path requested by user. @@ -1894,4 +1944,6 @@ /** * Activate a signup, as identified by an activation key. + * + * @since 1.2.2 * * @param string $key Activation key. @@ -2136,4 +2188,6 @@ * during normal registration, XProfile data is provided directly by the user. * + * @since 1.2.0 + * * @param int $user_id ID of the user. * @return bool @@ -2163,4 +2217,6 @@ /** * Get the avatar storage directory for use during registration. + * + * @since 1.1.0 * * @return string|bool Directory path on success, false on failure. @@ -2200,5 +2256,6 @@ * Send activation email to a newly registered user. * - * @since 2.5.0 Add the $user_login parameter. + * @since 1.2.2 + * @since 2.5.0 Add the $user_login parameter. * * @param int|bool $user_id ID of the new user, false if BP_SIGNUPS_SKIP_USER_CREATION is true. @@ -2322,4 +2379,6 @@ /** * Redirect away from wp-signup.php if BP registration templates are present. + * + * @since 1.1.0 */ function bp_core_wpsignup_redirect() { @@ -2742,4 +2801,12 @@ */ function bp_get_current_member_type() { + + /** + * Filters the "current" member type, if one is provided, in member directories. + * + * @since 2.3.0 + * + * @param string $value "Current" member type. + */ return apply_filters( 'bp_get_current_member_type', buddypress()->current_member_type ); } Index: /trunk/src/bp-members/bp-members-loader.php =================================================================== --- /trunk/src/bp-members/bp-members-loader.php (revision 10710) +++ /trunk/src/bp-members/bp-members-loader.php (revision 10711) @@ -17,4 +17,6 @@ /** * Set up the bp-members component. + * + * @since 1.6.0 */ function bp_setup_members() { Index: /trunk/src/bp-members/bp-members-screens.php =================================================================== --- /trunk/src/bp-members/bp-members-screens.php (revision 10710) +++ /trunk/src/bp-members/bp-members-screens.php (revision 10711) @@ -20,4 +20,6 @@ /** * Handle the display of the profile page by loading the correct template file. + * + * @since 1.5.0 */ function bp_members_screen_display_profile() { @@ -42,4 +44,6 @@ /** * Handle the display of the members directory index. + * + * @since 1.5.0 */ function bp_members_screen_index() { @@ -68,4 +72,6 @@ /** * Handle the loading of the signup screen. + * + * @since 1.1.0 */ function bp_core_screen_signup() { @@ -102,5 +108,5 @@ $bp->signup->step = 'registration-disabled'; - // If the signup page is submitted, validate and save. + // If the signup page is submitted, validate and save. } elseif ( isset( $_POST['signup_submit'] ) && bp_verify_nonce_request( 'bp_new_signup' ) ) { @@ -154,5 +160,5 @@ } - // This situation doesn't naturally occur so bounce to website root. + // This situation doesn't naturally occur so bounce to website root. } else { bp_core_redirect( bp_get_root_domain() ); @@ -298,4 +304,6 @@ * Handle the loading of the Activate screen. * + * @since 1.1.0 + * * @todo Move the actual activation process into an action in bp-members-actions.php */ Index: /trunk/src/bp-members/bp-members-template.php =================================================================== --- /trunk/src/bp-members/bp-members-template.php (revision 10710) +++ /trunk/src/bp-members/bp-members-template.php (revision 10711) @@ -293,4 +293,6 @@ * global, enabling the use of BuddyPress templates and template functions to * display a list of members. + * + * @since 1.2.0 * * @global object $members_template {@link BP_Members_Template} @@ -439,4 +441,6 @@ * Set up the current member inside the loop. * + * @since 1.2.0 + * * @return object */ @@ -449,4 +453,6 @@ * Check whether there are more members to iterate over. * + * @since 1.2.0 + * * @return bool */ @@ -458,4 +464,6 @@ /** * Output the members pagination count. + * + * @since 1.2.0 */ function bp_members_pagination_count() { @@ -464,4 +472,6 @@ /** * Generate the members pagination count. + * + * @since 1.5.0 * * @return string @@ -516,4 +526,6 @@ /** * Output the members pagination links. + * + * @since 1.2.0 */ function bp_members_pagination_links() { @@ -523,4 +535,6 @@ * Fetch the members pagination links. * + * @since 1.2.0 + * * @return string */ @@ -541,4 +555,6 @@ * Output the ID of the current member in the loop. * + * @since 1.2.0 + * * @uses bp_get_member_user_id() */ @@ -548,4 +564,6 @@ /** * Get the ID of the current member in the loop. + * + * @since 1.2.0 * * @return string Member ID. @@ -581,5 +599,4 @@ * * @param array $classes Array of custom classes. - * * @return string Row class of the member */ @@ -592,5 +609,5 @@ $classes[] = ( $pos_in_loop % 2 ) ? 'even' : 'odd'; - // If we've only one member in the loop, don't bother with odd and even. + // If we've only one member in the loop, don't bother with odd and even. } else { $classes[] = 'bp-single-member'; @@ -639,4 +656,6 @@ /** * Output nicename of current member in the loop. + * + * @since 1.2.5 */ function bp_member_user_nicename() { @@ -646,4 +665,6 @@ * Get the nicename of the current member in the loop. * + * @since 1.2.5 + * * @return string Members nicename. */ @@ -663,4 +684,6 @@ /** * Output login for current member in the loop. + * + * @since 1.2.5 */ function bp_member_user_login() { @@ -670,4 +693,6 @@ * Get the login of the current member in the loop. * + * @since 1.2.5 + * * @return string Member's login. */ @@ -687,4 +712,6 @@ /** * Output the email address for the current member in the loop. + * + * @since 1.2.5 */ function bp_member_user_email() { @@ -694,4 +721,6 @@ * Get the email address of the current member in the loop. * + * @since 1.2.5 + * * @return string Member's email address. */ @@ -712,4 +741,6 @@ * Check whether the current member in the loop is the logged-in user. * + * @since 1.2.5 + * * @return bool */ @@ -730,4 +761,6 @@ * Output a member's avatar. * + * @since 1.2.0 + * * @see bp_get_member_avatar() for description of arguments. * @@ -747,4 +780,6 @@ /** * Get a member's avatar. + * + * @since 1.2.0 * * @see bp_core_fetch_avatar() For a description of arguments and @@ -794,4 +829,6 @@ /** * Output the permalink for the current member in the loop. + * + * @since 1.2.0 */ function bp_member_permalink() { @@ -801,4 +838,6 @@ * Get the permalink for the current member in the loop. * + * @since 1.2.0 + * * @return string */ @@ -818,4 +857,6 @@ /** * Alias of {@link bp_member_permalink()}. + * + * @since 1.2.0 */ function bp_member_link() { echo bp_get_member_permalink(); } @@ -823,4 +864,6 @@ /** * Alias of {@link bp_get_member_permalink()}. + * + * @since 1.2.0 */ function bp_get_member_link() { return bp_get_member_permalink(); } @@ -828,4 +871,6 @@ /** * Output display name of current member in the loop. + * + * @since 1.2.0 */ function bp_member_name() { @@ -847,4 +892,6 @@ * WP users table, in the following order of preference: display_name, * user_nicename, user_login. + * + * @since 1.2.0 * * @return string The user's fullname for display. @@ -888,4 +935,6 @@ * Output the current member's last active time. * + * @since 1.2.0 + * * @param array $args See {@link bp_get_member_last_active()}. */ @@ -895,4 +944,6 @@ /** * Return the current member's last active time. + * + * @since 1.2.0 * * @param array $args { @@ -926,5 +977,5 @@ : bp_core_time_since( $members_template->member->last_activity ); - // Member has never logged in or been active. + // Member has never logged in or been active. } else { $last_activity = __( 'Never active', 'buddypress' ); @@ -945,4 +996,6 @@ * Output the latest update of the current member in the loop. * + * @since 1.2.0 + * * @param array|string $args Array of arguments for latest update. */ @@ -952,4 +1005,6 @@ /** * Get the latest update from the current member in the loop. + * + * @since 1.2.0 * * @param array|string $args { @@ -1007,4 +1062,6 @@ * Output a piece of user profile data. * + * @since 1.2.0 + * * @see bp_get_member_profile_data() for a description of params. * @@ -1020,4 +1077,6 @@ * to fetch profile data cached in the template global. It is also safe * to use outside of the loop. + * + * @since 1.2.0 * * @param array|string $args { @@ -1088,4 +1147,6 @@ /** * Output the 'registered [x days ago]' string for the current member. + * + * @since 1.2.0 */ function bp_member_registered() { @@ -1095,4 +1156,6 @@ * Get the 'registered [x days ago]' string for the current member. * + * @since 1.2.0 + * * @return string */ @@ -1114,4 +1177,6 @@ /** * Output a random piece of profile data for the current member in the loop. + * + * @since 1.2.0 */ function bp_member_random_profile_data() { @@ -1127,4 +1192,6 @@ /** * Output hidden input for preserving member search params on form submit. + * + * @since 1.2.0 */ function bp_member_hidden_fields() { @@ -1146,4 +1213,6 @@ /** * Output the Members directory search form. + * + * @since 1.0.0 */ function bp_directory_members_search_form() { @@ -1174,4 +1243,6 @@ /** * Output the total member count. + * + * @since 1.2.0 */ function bp_total_site_member_count() { @@ -1181,4 +1252,6 @@ * Get the total site member count. * + * @since 1.2.0 + * * @return int */ @@ -1208,4 +1281,6 @@ * The function will also analyze the current component the user is in, to * determine whether or not to highlight a particular nav item. + * + * @since 1.1.0 * * @todo Move to a back-compat file? @@ -1253,4 +1328,6 @@ /** * Render the navigation markup for the displayed user. + * + * @since 1.1.0 */ function bp_get_displayed_user_nav() { @@ -1306,4 +1383,6 @@ * Output the logged-in user's avatar. * + * @since 1.1.0 + * * @see bp_get_loggedin_user_avatar() for a description of params. * @@ -1315,4 +1394,6 @@ /** * Get the logged-in user's avatar. + * + * @since 1.1.0 * * @see bp_core_fetch_avatar() For a description of arguments and @@ -1355,4 +1436,6 @@ * Output the displayed user's avatar. * + * @since 1.1.0 + * * @see bp_get_displayed_user_avatar() for a description of params. * @@ -1364,4 +1447,6 @@ /** * Get the displayed user's avatar. + * + * @since 1.1.0 * * @see bp_core_fetch_avatar() For a description of arguments and @@ -1403,4 +1488,6 @@ /** * Output the email address of the displayed user. + * + * @since 1.5.0 */ function bp_displayed_user_email() { @@ -1409,4 +1496,6 @@ /** * Get the email address of the displayed user. + * + * @since 1.5.0 * * @return string @@ -1434,4 +1523,6 @@ * Output the "active [x days ago]" string for a user. * + * @since 1.0.0 + * * @see bp_get_last_activity() for a description of parameters. * @@ -1451,4 +1542,6 @@ /** * Get the "active [x days ago]" string for a user. + * + * @since 1.5.0 * * @param int $user_id ID of the user. Default: displayed user ID. @@ -1474,4 +1567,6 @@ /** * Output the calculated first name of the displayed or logged-in user. + * + * @since 1.2.0 */ function bp_user_firstname() { @@ -1482,4 +1577,6 @@ * * Simply takes all the characters before the first space in a name. + * + * @since 1.2.0 * * @param string|bool $name Full name to use when generating first name. @@ -1513,4 +1610,6 @@ /** * Output the link for the logged-in user's profile. + * + * @since 1.2.4 */ function bp_loggedin_user_link() { @@ -1520,4 +1619,6 @@ * Get the link for the logged-in user's profile. * + * @since 1.0.0 + * * @return string */ @@ -1536,4 +1637,6 @@ /** * Output the link for the displayed user's profile. + * + * @since 1.2.4 */ function bp_displayed_user_link() { @@ -1543,4 +1646,6 @@ * Get the link for the displayed user's profile. * + * @since 1.0.0 + * * @return string */ @@ -1566,4 +1671,6 @@ /** * Alias of {@link bp_displayed_user_id()}. + * + * @since 1.0.0 */ function bp_current_user_id() { return bp_displayed_user_id(); } @@ -1571,4 +1678,6 @@ /** * Generate the link for the displayed user's profile. + * + * @since 1.0.0 * * @return string @@ -1590,4 +1699,6 @@ * Generate the link for the logged-in user's profile. * + * @since 1.0.0 + * * @return string */ @@ -1607,4 +1718,6 @@ /** * Output the displayed user's display name. + * + * @since 1.0.0 */ function bp_displayed_user_fullname() { @@ -1614,4 +1727,6 @@ * Get the displayed user's display name. * + * @since 1.2.0 + * * @return string */ @@ -1631,4 +1746,6 @@ /** * Alias of {@link bp_get_displayed_user_fullname()}. + * + * @since 1.0.0 */ function bp_user_fullname() { echo bp_get_displayed_user_fullname(); } @@ -1637,4 +1754,6 @@ /** * Output the logged-in user's display name. + * + * @since 1.0.0 */ function bp_loggedin_user_fullname() { @@ -1644,4 +1763,6 @@ * Get the logged-in user's display name. * + * @since 1.0.0 + * * @return string */ @@ -1661,4 +1782,6 @@ /** * Output the username of the displayed user. + * + * @since 1.2.0 */ function bp_displayed_user_username() { @@ -1667,4 +1790,6 @@ /** * Get the username of the displayed user. + * + * @since 1.2.0 * * @return string @@ -1691,4 +1816,6 @@ /** * Output the username of the logged-in user. + * + * @since 1.2.0 */ function bp_loggedin_user_username() { @@ -1697,4 +1824,6 @@ /** * Get the username of the logged-in user. + * + * @since 1.2.0 * * @return string @@ -1738,4 +1867,11 @@ $message = sprintf( __( 'Viewing members of the type: %s', 'buddypress' ), '' . $type_object->labels['singular_name'] . '' ); + /** + * Filters the current member type message. + * + * @since 2.3.0 + * + * @param string $message Message to filter. + */ return apply_filters( 'bp_get_current_member_type_message', $message ); } @@ -1764,4 +1900,6 @@ /** * Output the URL to the signup page. + * + * @since 1.0.0 */ function bp_signup_page() { @@ -1770,4 +1908,6 @@ /** * Get the URL to the signup page. + * + * @since 1.1.0 * * @return string @@ -1797,4 +1937,5 @@ * @uses bp_get_activate_slug() To make sure there is a slug assigned to the page. * @uses bp_locate_template() To make sure a template exists to provide output. + * * @return boolean True if page and template exist, false if not. */ @@ -1810,4 +1951,6 @@ /** * Output the URL of the activation page. + * + * @since 1.0.0 */ function bp_activation_page() { @@ -1816,4 +1959,6 @@ /** * Get the URL of the activation page. + * + * @since 1.2.0 * * @return string @@ -1838,4 +1983,6 @@ /** * Output the username submitted during signup. + * + * @since 1.1.0 */ function bp_signup_username_value() { @@ -1844,4 +1991,6 @@ /** * Get the username submitted during signup. + * + * @since 1.1.0 * * @todo This should be properly escaped. @@ -1866,4 +2015,6 @@ /** * Output the user email address submitted during signup. + * + * @since 1.1.0 */ function bp_signup_email_value() { @@ -1872,4 +2023,6 @@ /** * Get the email address submitted during signup. + * + * @since 1.1.0 * * @todo This should be properly escaped. @@ -1894,4 +2047,6 @@ /** * Output the 'signup_with_blog' value submitted during signup. + * + * @since 1.1.0 */ function bp_signup_with_blog_value() { @@ -1900,4 +2055,6 @@ /** * Get the 'signup_with_blog' value submitted during signup. + * + * @since 1.1.0 * * @return string @@ -1920,4 +2077,6 @@ /** * Output the 'signup_blog_url' value submitted at signup. + * + * @since 1.1.0 */ function bp_signup_blog_url_value() { @@ -1926,4 +2085,6 @@ /** * Get the 'signup_blog_url' value submitted at signup. + * + * @since 1.1.0 * * @todo Should be properly escaped. @@ -1982,4 +2143,6 @@ /** * Output the 'signup_blog_titl' value submitted at signup. + * + * @since 1.1.0 */ function bp_signup_blog_title_value() { @@ -1988,4 +2151,6 @@ /** * Get the 'signup_blog_title' value submitted at signup. + * + * @since 1.1.0 * * @todo Should be properly escaped. @@ -2010,4 +2175,6 @@ /** * Output the 'signup_blog_privacy' value submitted at signup. + * + * @since 1.1.0 */ function bp_signup_blog_privacy_value() { @@ -2016,4 +2183,6 @@ /** * Get the 'signup_blog_privacy' value submitted at signup. + * + * @since 1.1.0 * * @todo Should be properly escaped. @@ -2038,4 +2207,6 @@ /** * Output the avatar dir used during signup. + * + * @since 1.1.0 */ function bp_signup_avatar_dir_value() { @@ -2044,4 +2215,6 @@ /** * Get the avatar dir used during signup. + * + * @since 1.1.0 * * @return string @@ -2074,4 +2247,6 @@ /** * Output the current signup step. + * + * @since 1.1.0 */ function bp_current_signup_step() { @@ -2081,4 +2256,6 @@ * Get the current signup step. * + * @since 1.1.0 + * * @return string */ @@ -2090,4 +2267,6 @@ * Output the user avatar during signup. * + * @since 1.1.0 + * * @see bp_get_signup_avatar() for description of arguments. * @@ -2099,4 +2278,6 @@ /** * Get the user avatar during signup. + * + * @since 1.1.0 * * @see bp_core_fetch_avatar() for description of arguments. @@ -2136,5 +2317,5 @@ ) ); - // No avatar DIR was found. + // No avatar DIR was found. } else { @@ -2173,4 +2354,6 @@ * Output whether signup is allowed. * + * @since 1.1.0 + * * @todo Remove this function. Echoing a bool is pointless. */ @@ -2180,4 +2363,6 @@ /** * Is user signup allowed? + * + * @since 1.1.0 * * @return bool @@ -2229,4 +2414,6 @@ * Output a link to a members component subpage. * + * @since 1.5.0 + * * @see bp_get_members_component_link() for description of parameters. * @@ -2241,4 +2428,6 @@ /** * Generate a link to a members component subpage. + * + * @since 1.5.0 * * @param string $component ID of the component (eg 'friends'). Index: /trunk/src/bp-members/classes/class-bp-core-members-template.php =================================================================== --- /trunk/src/bp-members/classes/class-bp-core-members-template.php (revision 10710) +++ /trunk/src/bp-members/classes/class-bp-core-members-template.php (revision 10711) @@ -14,4 +14,6 @@ * * Responsible for loading a group of members into a loop for display. + * + * @since 1.0.0 */ class BP_Core_Members_Template { @@ -20,4 +22,5 @@ * The loop iterator. * + * @since 1.0.0 * @var int */ @@ -27,4 +30,5 @@ * The number of members returned by the paged query. * + * @since 1.0.0 * @var int */ @@ -34,4 +38,5 @@ * Array of members located by the query. * + * @since 1.0.0 * @var array */ @@ -41,4 +46,5 @@ * The member object currently being iterated on. * + * @since 1.0.0 * @var object */ @@ -48,4 +54,5 @@ * A flag for whether the loop is currently being iterated. * + * @since 1.0.0 * @var bool */ @@ -55,4 +62,5 @@ * The type of member being requested. Used for ordering results. * + * @since 2.3.0 * @var string */ @@ -62,4 +70,5 @@ * The unique string used for pagination queries. * + * @since 2.2.0 * @var string */ @@ -69,4 +78,5 @@ * The page number being requested. * + * @since 1.0.0 * @var string */ @@ -76,4 +86,5 @@ * The number of items being requested per page. * + * @since 1.0.0 * @var string */ @@ -83,4 +94,5 @@ * An HTML string containing pagination links. * + * @since 1.0.0 * @var string */ @@ -90,4 +102,5 @@ * The total number of members matching the query parameters. * + * @since 1.0.0 * @var int */ @@ -96,4 +109,6 @@ /** * Constructor method. + * + * @since 1.5.0 * * @see BP_User_Query for an in-depth description of parameters. @@ -185,4 +200,6 @@ * Whether there are members available in the loop. * + * @since 1.0.0 + * * @see bp_has_members() * @@ -199,4 +216,6 @@ * Set up the next member and iterate index. * + * @since 1.0.0 + * * @return object The next member to iterate over. */ @@ -210,4 +229,6 @@ /** * Rewind the members and reset member index. + * + * @since 1.0.0 */ function rewind_members() { @@ -224,4 +245,6 @@ * that controls iteration inside the members loop, eg: * while ( bp_members() ) { ... + * + * @since 1.2.0 * * @see bp_members() @@ -255,4 +278,6 @@ * reference to the current member. * + * @since 1.0.0 + * * @see bp_the_member() */ Index: /trunk/src/bp-members/classes/class-bp-core-members-widget.php =================================================================== --- /trunk/src/bp-members/classes/class-bp-core-members-widget.php (revision 10710) +++ /trunk/src/bp-members/classes/class-bp-core-members-widget.php (revision 10711) @@ -20,4 +20,6 @@ /** * Constructor method. + * + * @since 1.5.0 */ public function __construct() { @@ -41,4 +43,6 @@ /** * Display the Members widget. + * + * @since 1.0.3 * * @see WP_Widget::widget() for description of parameters. @@ -160,4 +164,6 @@ * Update the Members widget options. * + * @since 1.0.3 + * * @param array $new_instance The new instance options. * @param array $old_instance The old instance options. @@ -178,6 +184,7 @@ * Output the Members widget options form. * + * @since 1.0.3 + * * @param array $instance Widget instance settings. - * * @return void */ Index: /trunk/src/bp-members/classes/class-bp-core-recently-active-widget.php =================================================================== --- /trunk/src/bp-members/classes/class-bp-core-recently-active-widget.php (revision 10710) +++ /trunk/src/bp-members/classes/class-bp-core-recently-active-widget.php (revision 10711) @@ -20,4 +20,6 @@ /** * Constructor method. + * + * @since 1.5.0 */ public function __construct() { @@ -32,4 +34,6 @@ /** * Display the Recently Active widget. + * + * @since 1.0.3 * * @see WP_Widget::widget() for description of parameters. @@ -107,4 +111,6 @@ * Update the Recently Active widget options. * + * @since 1.0.3 + * * @param array $new_instance The new instance options. * @param array $old_instance The old instance options. @@ -121,4 +127,6 @@ /** * Output the Recently Active widget options form. + * + * @since 1.0.3 * * @param array $instance Widget instance settings. Index: /trunk/src/bp-members/classes/class-bp-core-whos-online-widget.php =================================================================== --- /trunk/src/bp-members/classes/class-bp-core-whos-online-widget.php (revision 10710) +++ /trunk/src/bp-members/classes/class-bp-core-whos-online-widget.php (revision 10711) @@ -20,4 +20,6 @@ /** * Constructor method. + * + * @since 1.5.0 */ public function __construct() { @@ -32,4 +34,6 @@ /** * Display the Who's Online widget. + * + * @since 1.0.3 * * @see WP_Widget::widget() for description of parameters. @@ -107,4 +111,6 @@ * Update the Who's Online widget options. * + * @since 1.0.3 + * * @param array $new_instance The new instance options. * @param array $old_instance The old instance options. @@ -121,4 +127,6 @@ /** * Output the Who's Online widget options form. + * + * @since 1.0.3 * * @param array $instance Widget instance settings. Index: /trunk/src/bp-members/classes/class-bp-members-component.php =================================================================== --- /trunk/src/bp-members/classes/class-bp-members-component.php (revision 10710) +++ /trunk/src/bp-members/classes/class-bp-members-component.php (revision 10711) @@ -13,4 +13,6 @@ /** * Defines the BuddyPress Members Component. + * + * @since 1.5.0 */ class BP_Members_Component extends BP_Component { @@ -45,4 +47,6 @@ /** * Include bp-members files. + * + * @since 1.5.0 * * @see BP_Component::includes() for description of parameters. @@ -114,5 +118,5 @@ 'global_tables' => array( 'table_name_last_activity' => bp_core_get_table_prefix() . 'bp_activity', - 'table_name_signups' => $wpdb->base_prefix . 'signups', // signups is a global WordPress table + 'table_name_signups' => $wpdb->base_prefix . 'signups', // Signups is a global WordPress table. ) ); @@ -283,4 +287,6 @@ /** * Set up the title for pages and