Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
02/13/2016 07:32:53 PM (10 years ago)
Author:
tw2113
Message:

Addes missing @since tags to many functions, methods, and properties in the BP Friends component.

See #6400.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-friends/bp-friends-template.php

    r10424 r10587  
    219219/**
    220220 * Output the friend count for the current member in the loop.
     221 *
     222 * @since 1.2.0
    221223 */
    222224function bp_member_total_friend_count() {
    … …  
    227229         *
    228230         * Return value is a string of the form "x friends".
     231         *
     232         * @since 1.2.0
    229233         *
    230234         * @return string A string of the form "x friends".
    … …  
    254258 * Output the ID of the current user in the friend request loop.
    255259 *
     260 * @since 1.2.6
     261 *
    256262 * @see bp_get_potential_friend_id() for a description of arguments.
    257263 *
    … …  
    263269        /**
    264270         * Return the ID of current user in the friend request loop.
     271         *
     272         * @since 1.2.6
    265273         *
    266274         * @global object $friends_template
    … …  
    293301 * Returns - 'is_friend', 'not_friends', 'pending'.
    294302 *
     303 * @since 1.2.6
     304 *
    295305 * @param int $user_id ID of the potential friend. Default: the value of
    296306 *                     {@link bp_get_potential_friend_id()}.
    … …  
    321331 * Output the Add Friend button.
    322332 *
     333 * @since 1.0.0
     334 *
    323335 * @see bp_get_add_friend_button() for information on arguments.
    324336 *
    … …  
    331343        /**
    332344         * Create the Add Friend button.
     345         *
     346         * @since 1.1.0
    333347         *
    334348         * @param int  $potential_friend_id ID of the user to whom the button
    … …  
    430444 * Get a comma-separated list of IDs of a user's friends.
    431445 *
     446 * @since 1.2.0
     447 *
    432448 * @param int $user_id Optional. Default: the displayed user's ID, or the
    433449 *                     logged-in user's ID.
    … …  
    454470 * because of the structure of the $include parameter in bp_has_members().
    455471 *
     472 * @since 1.2.0
     473 *
    456474 * @param int $user_id ID of the user whose requests are being retrieved.
    457475 *                     Defaults to displayed user.
    … …  
    487505/**
    488506 * Output the ID of the friendship between the logged-in user and the current user in the loop.
     507 *
     508 * @since 1.2.0
    489509 */
    490510function bp_friend_friendship_id() {
    … …  
    493513        /**
    494514         * Return the ID of the friendship between the logged-in user and the current user in the loop.
     515         *
     516         * @since 1.2.0
    495517         *
    496518         * @return int ID of the friendship.
    … …  
    516538/**
    517539 * Output the URL for accepting the current friendship request in the loop.
     540 *
     541 * @since 1.0.0
    518542 */
    519543function bp_friend_accept_request_link() {
    … …  
    522546        /**
    523547         * Return the URL for accepting the current friendship request in the loop.
     548         *
     549         * @since 1.0.0
    524550         *
    525551         * @return string accept-friendship URL.
    … …  
    545571/**
    546572 * Output the URL for rejecting the current friendship request in the loop.
     573 *
     574 * @since 1.0.0
    547575 */
    548576function bp_friend_reject_request_link() {
    … …  
    551579        /**
    552580         * Return the URL for rejecting the current friendship request in the loop.
     581         *
     582         * @since 1.0.0
    553583         *
    554584         * @return string reject-friendship URL.
    … …  
    575605 * Output the total friend count for a given user.
    576606 *
     607 * @since 1.2.0
     608 *
    577609 * @param int $user_id See {@link friends_get_total_friend_count()}.
    578610 */
    … …  
    583615         * Return the total friend count for a given user.
    584616         *
     617         * @since 1.2.0
     618         *
    585619         * @param int $user_id See {@link friends_get_total_friend_count()}.
    586620         * @return int Total friend count.
    … …  
    602636 * Output the total friendship request count for a given user.
    603637 *
     638 * @since 1.2.0
     639 *
    604640 * @see bp_friend_get_total_requests_count() for description of arguments.
    605641 *
    … …  
    611647        /**
    612648         * Return the total friendship request count for a given user.
     649         *
     650         * @since 1.2.0
    613651         *
    614652         * @param int $user_id ID of the user whose requests are being counted.
Note: See TracChangeset for help on using the changeset viewer.