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/extend/buddypress/functions.php

    r6498 r6573  
    152152 *
    153153 * @since 2.1.0 bbPress (r3552)
    154  *
    155  * @uses add_action() To add the content hook
    156  * @uses bp_core_load_template() To load the plugins template
    157154 */
    158155function bbp_member_forums_screen_topics() {
    … …  
    165162 *
    166163 * @since 2.1.0 bbPress (r3552)
    167  *
    168  * @uses add_action() To add the content hook
    169  * @uses bp_core_load_template() To load the plugins template
    170164 */
    171165function bbp_member_forums_screen_replies() {
    … …  
    178172 *
    179173 * @since 2.6.0 bbPress (r6320)
    180  *
    181  * @uses add_action() To add the content hook
    182  * @uses bp_core_load_template() To load the plugins template
    183174 */
    184175function bbp_member_forums_screen_engagements() {
    … …  
    191182 *
    192183 * @since 2.1.0 bbPress (r3552)
    193  *
    194  * @uses add_action() To add the content hook
    195  * @uses bp_core_load_template() To load the plugins template
    196184 */
    197185function bbp_member_forums_screen_favorites() {
    … …  
    204192 *
    205193 * @since 2.1.0 bbPress (r3552)
    206  *
    207  * @uses add_action() To add the content hook
    208  * @uses bp_core_load_template() To load the plugins template
    209194 */
    210195function bbp_member_forums_screen_subscriptions() {
    … …  
    219204 *
    220205 * @since 2.1.0 bbPress (r3552)
    221  *
    222  * @uses bbp_get_template_part()s
    223206 */
    224207function bbp_member_forums_topics_content() {
    … …  
    238221 *
    239222 * @since 2.1.0 bbPress (r3552)
    240  *
    241  * @uses bbp_get_template_part()
    242223 */
    243224function bbp_member_forums_replies_content() {
    … …  
    257238 *
    258239 * @since 2.6.0 bbPress (r6320)
    259  *
    260  * @uses bbp_get_template_part()
    261240 */
    262241function bbp_member_forums_engagements_content() {
    … …  
    276255 *
    277256 * @since 2.1.0 bbPress (r3552)
    278  *
    279  * @uses bbp_get_template_part()
    280257 */
    281258function bbp_member_forums_favorites_content() {
    … …  
    295272 *
    296273 * @since 2.1.0 bbPress (r3552)
    297  *
    298  * @uses bbp_get_template_part()
    299274 */
    300275function bbp_member_forums_subscriptions_content() {
    … …  
    636611 *
    637612 * @param int $forum_id
    638  * @uses bbp_get_forum_id() To get the forum id
    639  * @uses bbp_get_forum_group_ids() To get the forum's group ids
    640  * @uses apply_filters() Calls 'bbp_forum_is_group_forum' with the forum id
    641613 * @return bool True if it is a group forum, false if not
    642614 */
    … …  
    663635 * @since 2.3.0 bbPress (r4632)
    664636 *
    665  * @uses is_user_logged_in()
    666  * @uses bp_is_group()
    667  * @uses bbpress()
    668  * @uses bp_loggedin_user_id()
    669  * @uses bp_get_current_group_id()
    670  * @uses groups_is_user_admin()
    671637 * @return bool If current user is an admin of the current group
    672638 */
    … …  
    694660 * @since 2.3.0 bbPress (r4632)
    695661 *
    696  * @uses is_user_logged_in()
    697  * @uses bp_is_group()
    698  * @uses bbpress()
    699  * @uses bp_loggedin_user_id()
    700  * @uses bp_get_current_group_id()
    701  * @uses groups_is_user_admin()
    702662 * @return bool If current user is a moderator of the current group
    703663 */
    … …  
    725685 * @since 2.3.0 bbPress (r4632)
    726686 *
    727  * @uses is_user_logged_in()
    728  * @uses bp_is_group()
    729  * @uses bbpress()
    730  * @uses bp_loggedin_user_id()
    731  * @uses bp_get_current_group_id()
    732  * @uses groups_is_user_admin()
    733687 * @return bool If current user is a member of the current group
    734688 */
    … …  
    756710 * @since 2.3.0 bbPress (r4632)
    757711 *
    758  * @uses is_user_logged_in()
    759  * @uses bp_is_group()
    760  * @uses bbpress()
    761  * @uses bp_loggedin_user_id()
    762  * @uses bp_get_current_group_id()
    763  * @uses groups_is_user_admin()
    764712 * @return bool If current user is banned from the current group
    765713 */
    … …  
    787735 * @since 2.3.0 bbPress (r4632)
    788736 *
    789  * @uses is_user_logged_in()
    790  * @uses bp_is_group()
    791  * @uses bbpress()
    792  * @uses bp_loggedin_user_id()
    793  * @uses bp_get_current_group_id()
    794  * @uses groups_is_user_admin()
    795737 * @return bool If current user the creator of the current group
    796738 */
Note: See TracChangeset for help on using the changeset viewer.