Skip to:
Content

bbPress.org


Ignore:
Timestamp:
06/16/2017 09:20:52 PM (7 years ago)
Author:
johnjamesjacoby
Message:

Documentation: Remove all @uses usages.

Per the WordPress inline documentation standards:

the @uses tag is not recommended to be used to indicate a used-by relationship, as this information can be derived through other means. These tags also are very likely to become out-of-date as our functions change over time.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/includes/users/capabilities.php

    r6572 r6573  
    1919 * @param int    $user_id User id.
    2020 * @param array  $args Arguments.
    21  * @uses bbp_is_user_inactive() To check if user is spammer or deleted
    22  * @uses get_post() To get the post
    23  * @uses bbp_get_forum_post_type() To get the forum post type
    24  * @uses bbp_get_topic_post_type() To get the topic post type
    25  * @uses bbp_get_topic_forum_id() To get the topic forum id
    26  * @uses bbp_get_reply_post_type() To get the reply post type
    27  * @uses bbp_get_reply_forum_id() To get the reply forum id
    28  * @uses bbp_is_user_forum_moderator() To check if the user is a forum moderator
    29  * @uses apply_filters() Filter mapped results
    3021 *
    3122 * @return array Actual capabilities for meta capability
    … …  
    148139 *
    149140 * @param int $user_id
    150  * @uses bbp_get_user_id() To get the user id
    151  * @uses get_userdata() To get the user data
    152  * @uses apply_filters() Calls 'bbp_set_user_role' with the role and user id
     141 *
    153142 * @return string
    154143 */
    … …  
    198187 *
    199188 * @param int $user_id
    200  * @uses bbp_get_user_id() To get the user id
    201  * @uses get_userdata() To get the user data
    202  * @uses apply_filters() Calls 'bbp_get_user_role' with the role and user id
     189 *
    203190 * @return string
    204191 */
    … …  
    237224 *
    238225 * @param int $user_id
    239  * @uses bbp_get_user_id() To get the user id
    240  * @uses get_userdata() To get the user data
    241  * @uses apply_filters() Calls 'bbp_get_user_blog_role' with the role and user id
     226 *
    242227 * @return string
    243228 */
    … …  
    277262 *
    278263 * @param int $user_id
    279  * @uses bbp_reset_user_caps() to reset caps
    280  * @usse bbp_save_user_caps() to save caps
    281264 */
    282265function bbp_profile_update_role( $user_id = 0 ) {
    … …  
    322305 *
    323306 * @since 2.0.0 bbPress (r3380)
    324  *
    325  * @uses is_user_logged_in() To bail if user is not logged in
    326  * @uses bbp_get_user_role() To bail if user already has a role
    327  * @uses bbp_is_user_inactive() To bail if user is inactive
    328  * @uses bbp_allow_global_access() To know whether to save role to database
    329  * @uses bbp_get_user_role_map() To get the WP to BBP role map array
    330  * @uses bbp_get_default_role() To get the site's default forums role
    331  * @uses get_option()
    332307 *
    333308 * @return If not multisite, not global, or user is deleted/spammed
    … …  
    475450 * @param int $user_id Optional. User ID to spam. Defaults to displayed user.
    476451 *
    477  * @uses bbp_is_single_user()
    478  * @uses bbp_is_user_home()
    479  * @uses bbp_get_displayed_user_id()
    480  * @uses bbp_is_user_keymaster()
    481  * @uses get_blogs_of_user()
    482  * @uses get_current_blog_id()
    483  * @uses bbp_get_topic_post_type()
    484  * @uses bbp_get_reply_post_type()
    485  * @uses switch_to_blog()
    486  * @uses get_post_type()
    487  * @uses bbp_spam_topic()
    488  * @uses bbp_spam_reply()
    489  * @uses restore_current_blog()
    490  *
    491452 * @return bool If no user ID passed.
    492453 */
    … …  
    567528 * @param int $user_id Optional. User ID to unspam. Defaults to displayed user.
    568529 *
    569  * @uses bbp_is_single_user()
    570  * @uses bbp_is_user_home()
    571  * @uses bbp_get_displayed_user_id()
    572  * @uses bbp_is_user_keymaster()
    573  * @uses get_blogs_of_user()
    574  * @uses bbp_get_topic_post_type()
    575  * @uses bbp_get_reply_post_type()
    576  * @uses switch_to_blog()
    577  * @uses get_post_type()
    578  * @uses bbp_unspam_topic()
    579  * @uses bbp_unspam_reply()
    580  * @uses restore_current_blog()
    581  *
    582530 * @return bool If no user ID passed.
    583531 */
    … …  
    695643 * @since 2.0.0 bbPress (r3502)
    696644 *
    697  * @uses is_user_logged_in() To check if user is logged in
    698  * @uses bbp_get_displayed_user_id() To get current user ID
    699  * @uses bbp_is_user_spammer() To check if user is spammer
    700  * @uses bbp_is_user_deleted() To check if user is deleted
    701  *
    702645 * @param int $user_id The user ID to check
    703646 * @return bool True if public, false if not
    … …  
    730673 * @since 2.0.0 bbPress (r3502)
    731674 *
    732  * @uses bbp_is_user_active() To check if user is active
    733  *
    734675 * @param int $user_id The user ID to check. Defaults to current user ID
    735676 * @return bool True if inactive, false if active
    … …  
    761702 *
    762703 * @param int $user_id User ID to check
    763  *
    764  * @uses bbp_get_user_id() To verify the user ID
    765  * @uses get_userdata() To get the user's data
    766  * @uses bbp_is_user_keymaster() To determine if user can see inactive users
    767  * @uses bbp_is_user_inactive() To check if user is spammer or deleted
    768  * @uses apply_filters() To allow override of this functions result
    769704 *
    770705 * @return bool Whether or not the user has a profile on this blog_id.
Note: See TracChangeset for help on using the changeset viewer.