Changeset 6573 for trunk/src/includes/extend/buddypress/activity.php

Timestamp:

06/16/2017 09:20:52 PM (9 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/extend/buddypress/activity.php (modified) (14 diffs)

trunk/src/includes/extend/buddypress/activity.php

@@ -100 +100 @@
          *
          * @access private
-         * @uses apply_filters() Calls various filters
          */
         private function setup_globals() {
@@ -127 +126 @@
          *
          * @access private
-         * @uses add_filter() To add various filters
-         * @uses add_action() To add various actions
          */
         private function setup_actions() {
@@ -163 +160 @@
          *
          * @access private
-         * @uses add_filter() To add various filters
-         * @uses add_action() To add various actions
          */
         private function setup_filters() {
@@ -191 +186 @@
          *
          * @since 2.0.0 bbPress (r3395)
-         *
-         * @uses bp_activity_set_action()
          */
         public function register_activity_actions() {
@@ -251 +244 @@
          *
          * @param type $args Array of arguments for bp_activity_add()
-         * @uses bbp_get_current_user_id()
-         * @uses bp_core_current_time()
-         * @uses bbp_parse_args()
-         * @uses aplly_filters()
-         * @uses bp_activity_add()
          * @return type Activity ID if successful, false if not
          */
@@ -285 +273 @@
          *
          * @param type $args Array of arguments for bp_activity_add()
-         * @uses bbp_get_current_user_id()
-         * @uses bp_core_current_time()
-         * @uses bbp_parse_args()
-         * @uses aplly_filters()
-         * @uses bp_activity_add()
          * @return type Activity ID if successful, false if not
          */
@@ -311 +294 @@
          *
          * @param int $post_id ID of the topic or reply
-         * @uses get_post_meta()
-         * @uses bp_activity_get_specific()
          * @return int if an activity id is verified, false if not
          */
@@ -342 +323 @@
          * @global BP_Activity_Template $activities_template
          * @param boolean $can_comment
-         * @uses bp_get_activity_action_name()
          * @return boolean
          */
@@ -424 +404 @@
          * @param array $anonymous_data
          * @param int $topic_author_id
-         * @uses bbp_get_topic_id()
-         * @uses bbp_get_forum_id()
-         * @uses bbp_get_user_profile_link()
-         * @uses bbp_get_topic_permalink()
-         * @uses bbp_get_topic_title()
-         * @uses bbp_get_topic_content()
-         * @uses bbp_get_forum_permalink()
-         * @uses bbp_get_forum_title()
-         * @uses apply_filters()
          * @return Bail early if topic is by anonymous user
          */
@@ -505 +476 @@
          *
          * @param int $topic_id
-         * @uses bp_activity_delete()
          */
         public function topic_delete( $topic_id = 0 ) {
@@ -523 +493 @@
          * @param int $topic_id
          * @param obj $post
-         * @uses get_post_type()
-         * @uses bbp_get_topic_post_type()
-         * @uses bbp_get_topic_id()
-         * @uses bbp_is_topic_anonymous()
-         * @uses bbp_get_public_status_id()
-         * @uses bbp_get_closed_status_id()
-         * @uses bbp_get_topic_forum_id()
-         * @uses bbp_get_topic_author_id()
          * @return Bail early if not a topic, or topic is by anonymous user
          */
@@ -571 +533 @@
          * @param array $anonymous_data
          * @param int $topic_author_id
-         * @uses bbp_get_reply_id()
-         * @uses bbp_get_topic_id()
-         * @uses bbp_get_forum_id()
-         * @uses bbp_get_user_profile_link()
-         * @uses bbp_get_reply_url()
-         * @uses bbp_get_reply_content()
-         * @uses bbp_get_topic_permalink()
-         * @uses bbp_get_topic_title()
-         * @uses bbp_get_forum_permalink()
-         * @uses bbp_get_forum_title()
-         * @uses apply_filters()
          * @return Bail early if topic is by anonymous user
          */
@@ -658 +609 @@
          *
          * @param int $reply_id
-         * @uses get_post_meta()
-         * @uses bp_activity_delete()
          */
         public function reply_delete( $reply_id ) {
@@ -677 +626 @@
          * @param int $reply_id
          * @param obj $post
-         * @uses get_post_type()
-         * @uses bbp_get_reply_post_type()
-         * @uses bbp_get_reply_id()
-         * @uses bbp_is_reply_anonymous()
-         * @uses bbp_get_public_status_id()
-         * @uses bbp_get_closed_status_id()
-         * @uses bbp_get_reply_topic_id()
-         * @uses bbp_get_reply_forum_id()
-         * @uses bbp_get_reply_author_id()
          * @return Bail early if not a reply, or reply is by anonymous user
          */