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/akismet.php

    r6415 r6573  
    2626     *
    2727     * @since 2.0.0 bbPress (r3277)
    28      *
    29      * @uses add_filter()
    3028     */
    3129    public function __construct() {
    … …  
    3937     *
    4038     * @access private
    41      *
    42      * @uses add_filter() To add various filters
    43      * @uses add_action() To add various actions
    4439     */
    4540    private function setup_actions() {
    … …  
    8681     *
    8782     * @param string $post_data
    88      *
    89      * @uses get_userdata() To get the user data
    90      * @uses bbp_filter_anonymous_user_data() To get anonymous user data
    91      * @uses bbp_get_topic_permalink() To get the permalink of the topic
    92      * @uses bbp_get_reply_url() To get the permalink of the reply
    93      * @uses bbp_current_author_ip() To get the IP address of the current user
    94      * @uses BBP_Akismet::maybe_spam() To check if post is spam
    95      * @uses BBP_Akismet::get_user_roles() To get the role(s) of the current user
    96      * @uses do_action() To call the 'bbp_akismet_spam_caught' hook
    97      * @uses add_filter() To call the 'bbp_new_reply_pre_set_terms' hook
    9883     *
    9984     * @return array Array of post data
    … …  
    230215     * @global object $current_user
    231216     * @global object $current_site
    232      *
    233      * @uses current_filter() To get the reply_id
    234      * @uses get_post() To get the post object
    235      * @uses get_the_author_meta() To get the author meta
    236      * @uses get_post_meta() To get the post meta
    237      * @uses bbp_get_user_profile_url() To get a user's profile url
    238      * @uses get_permalink() To get the permalink of the post_parent
    239      * @uses BBP_Akismet::get_user_roles() To get the role(s) of the post_author
    240      * @uses bbp_current_author_ip() To get the IP address of the current user
    241      * @uses BBP_Akismet::maybe_spam() To submit the post as ham or spam
    242      * @uses update_post_meta() To update the post meta with some Akismet data
    243      * @uses do_action() To call the 'bbp_akismet_submit_spam_post' and 'bbp_akismet_submit_ham_post' hooks
    244217     *
    245218     * @return array Array of existing topic terms
    … …  
    409382     * @global string $akismet_api_port
    410383     *
    411      * @uses akismet_test_mode() To determine if Akismet is in test mode
    412      * @uses akismet_http_post() To send data to the mothership for processing
    413      *
    414384     * @return array Array of post data
    415385     */
    … …  
    485455     *
    486456     * @global object $this->last_post
    487      *
    488      * @uses get_post() To get the post object
    489      * @uses get_userdata() To get the user data
    490      * @uses bbp_filter_anonymous_user_data() To get anonymous user data
    491      * @uses update_post_meta() To update post meta with Akismet data
    492      * @uses BBP_Akismet::update_post_history() To update post Akismet history
    493457     */
    494458    public function update_post_meta( $post_id = 0, $_post = false ) {
    … …  
    567531
    568532    /**
    569      * Update a post's Akismet history
     533     * Update Akismet history of a Post
    570534     *
    571535     * @since 2.0.0 bbPress (r3308)
    … …  
    574538     * @param string $message
    575539     * @param string $event
    576      *
    577      * @uses wp_get_current_user() To get the current_user object
    578      * @uses add_post_meta() Add Akismet post history
    579540     */
    580541    private function update_post_history( $post_id = 0, $message = null, $event = null ) {
    … …  
    608569
    609570    /**
    610      * Get a post's Akismet history
     571     * Get the Akismet history of a Post
    611572     *
    612573     * @since 2.0.0 bbPress (r3308)
    … …  
    614575     * @param int $post_id
    615576     *
    616      * @uses wp_get_current_user() To get the current_user object
    617      * @uses get_post_meta() Get a post's Akismet history
    618      *
    619      * @return array Array of a post's Akismet history
     577     * @return array Array of Akismet history
    620578     */
    621579    public function get_post_history( $post_id = 0 ) {
    … …  
    638596     * @param int $topic_id
    639597     * @param int $reply_id
    640      *
    641      * @uses bbp_get_reply_id() To get the reply_id
    642      * @uses bbp_get_topic_id() To get the topic_id
    643      * @uses bbp_get_topic_tag_names() To a post's current terms
    644      * @uses update_post_meta() To add spam terms to post meta
    645598     *
    646599     * @return array Array of existing topic terms
    … …  
    677630     * @param string $port The port to use
    678631     * @param string $ip Optional Override $host with an IP address
    679      * @uses bbp_get_version() To get the current bbPress version
    680632     * @return mixed WP_Error on error, array on success, empty on failure
    681633     */
    … …  
    790742     *
    791743     * @since 2.4.0 bbPress (r5049)
    792      *
    793      * @uses get_post_history() To get the Akismet history for the post
    794      * @uses get_the_ID() To get the post ID
    795      * @uses bbp_time_since() To get the human readable time
    796744     */
    797745    public function history_metabox() {
Note: See TracChangeset for help on using the changeset viewer.