Skip to:
Content

bbPress.org


Ignore:
Timestamp:
06/16/2017 09:20:52 PM (5 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/activity.php

    r6415 r6573  
    100100     *
    101101     * @access private
    102      * @uses apply_filters() Calls various filters
    103102     */
    104103    private function setup_globals() {
     
    127126     *
    128127     * @access private
    129      * @uses add_filter() To add various filters
    130      * @uses add_action() To add various actions
    131128     */
    132129    private function setup_actions() {
     
    163160     *
    164161     * @access private
    165      * @uses add_filter() To add various filters
    166      * @uses add_action() To add various actions
    167162     */
    168163    private function setup_filters() {
     
    191186     *
    192187     * @since 2.0.0 bbPress (r3395)
    193      *
    194      * @uses bp_activity_set_action()
    195188     */
    196189    public function register_activity_actions() {
     
    251244     *
    252245     * @param type $args Array of arguments for bp_activity_add()
    253      * @uses bbp_get_current_user_id()
    254      * @uses bp_core_current_time()
    255      * @uses bbp_parse_args()
    256      * @uses aplly_filters()
    257      * @uses bp_activity_add()
    258246     * @return type Activity ID if successful, false if not
    259247     */
     
    285273     *
    286274     * @param type $args Array of arguments for bp_activity_add()
    287      * @uses bbp_get_current_user_id()
    288      * @uses bp_core_current_time()
    289      * @uses bbp_parse_args()
    290      * @uses aplly_filters()
    291      * @uses bp_activity_add()
    292275     * @return type Activity ID if successful, false if not
    293276     */
     
    311294     *
    312295     * @param int $post_id ID of the topic or reply
    313      * @uses get_post_meta()
    314      * @uses bp_activity_get_specific()
    315296     * @return int if an activity id is verified, false if not
    316297     */
     
    342323     * @global BP_Activity_Template $activities_template
    343324     * @param boolean $can_comment
    344      * @uses bp_get_activity_action_name()
    345325     * @return boolean
    346326     */
     
    424404     * @param array $anonymous_data
    425405     * @param int $topic_author_id
    426      * @uses bbp_get_topic_id()
    427      * @uses bbp_get_forum_id()
    428      * @uses bbp_get_user_profile_link()
    429      * @uses bbp_get_topic_permalink()
    430      * @uses bbp_get_topic_title()
    431      * @uses bbp_get_topic_content()
    432      * @uses bbp_get_forum_permalink()
    433      * @uses bbp_get_forum_title()
    434      * @uses apply_filters()
    435406     * @return Bail early if topic is by anonymous user
    436407     */
     
    505476     *
    506477     * @param int $topic_id
    507      * @uses bp_activity_delete()
    508478     */
    509479    public function topic_delete( $topic_id = 0 ) {
     
    523493     * @param int $topic_id
    524494     * @param obj $post
    525      * @uses get_post_type()
    526      * @uses bbp_get_topic_post_type()
    527      * @uses bbp_get_topic_id()
    528      * @uses bbp_is_topic_anonymous()
    529      * @uses bbp_get_public_status_id()
    530      * @uses bbp_get_closed_status_id()
    531      * @uses bbp_get_topic_forum_id()
    532      * @uses bbp_get_topic_author_id()
    533495     * @return Bail early if not a topic, or topic is by anonymous user
    534496     */
     
    571533     * @param array $anonymous_data
    572534     * @param int $topic_author_id
    573      * @uses bbp_get_reply_id()
    574      * @uses bbp_get_topic_id()
    575      * @uses bbp_get_forum_id()
    576      * @uses bbp_get_user_profile_link()
    577      * @uses bbp_get_reply_url()
    578      * @uses bbp_get_reply_content()
    579      * @uses bbp_get_topic_permalink()
    580      * @uses bbp_get_topic_title()
    581      * @uses bbp_get_forum_permalink()
    582      * @uses bbp_get_forum_title()
    583      * @uses apply_filters()
    584535     * @return Bail early if topic is by anonymous user
    585536     */
     
    658609     *
    659610     * @param int $reply_id
    660      * @uses get_post_meta()
    661      * @uses bp_activity_delete()
    662611     */
    663612    public function reply_delete( $reply_id ) {
     
    677626     * @param int $reply_id
    678627     * @param obj $post
    679      * @uses get_post_type()
    680      * @uses bbp_get_reply_post_type()
    681      * @uses bbp_get_reply_id()
    682      * @uses bbp_is_reply_anonymous()
    683      * @uses bbp_get_public_status_id()
    684      * @uses bbp_get_closed_status_id()
    685      * @uses bbp_get_reply_topic_id()
    686      * @uses bbp_get_reply_forum_id()
    687      * @uses bbp_get_reply_author_id()
    688628     * @return Bail early if not a reply, or reply is by anonymous user
    689629     */
Note: See TracChangeset for help on using the changeset viewer.