Changeset 6573 for trunk/src/includes/forums/capabilities.php

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:

• trunk/src/includes/forums/capabilities.php (modified) (3 diffs)

trunk/src/includes/forums/capabilities.php

@@ -15 +15 @@
  * @since 2.0.0 bbPress (r2593)
  *
- * @uses apply_filters() Calls 'bbp_get_forum_caps' with the capabilities
  * @return array Forum capabilities
  */
@@ -41 +40 @@
  * @param int $user_id User id
  * @param array $args Arguments
- * @uses get_post() To get the post
- * @uses get_post_type_object() To get the post type object
- * @uses apply_filters() Filter capability map results
  * @return array Actual capabilities for meta capability
  */
@@ -256 +252 @@
  * @param int $user_id User id.
  * @param int $forum_id Forum id.
- * @uses bbp_get_user_id()
- * @uses bbp_get_forum_id()
- * @uses bbp_is_object_of_user()
- * @uses apply_filters() Calls 'bbp_is_user_forum_moderator' with the forums
  *
  * @return bool Return true if user is moderator of forum