Skip to:
Content

bbPress.org


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

    r6566 r6573  
    3434     *
    3535     * @since 2.0.0 bbPress (r2515)
    36      *
    37      * @uses BBP_Replies_Admin::setup_globals() Setup the globals needed
    38      * @uses BBP_Replies_Admin::setup_actions() Setup the hooks and actions
    39      * @uses BBP_Replies_Admin::setup_actions() Setup the help text
    4036     */
    4137    public function __construct() {
    … …  
    5147     *
    5248     * @access private
    53      *
    54      * @uses add_action() To add various actions
    55      * @uses add_filter() To add various filters
    56      * @uses bbp_get_forum_post_type() To get the forum post type
    57      * @uses bbp_get_topic_post_type() To get the topic post type
    58      * @uses bbp_get_reply_post_type() To get the reply post type
    5949     */
    6050    private function setup_actions() {
    … …  
    114104     *
    115105     * @since 2.0.0 bbPress (r3119)
    116      *
    117      * @uses get_current_screen()
    118106     */
    119107    public function edit_help() {
    … …  
    178166     *
    179167     * @since 2.0.0 bbPress (r3119)
    180      *
    181      * @uses get_current_screen()
    182168     */
    183169    public function new_help() {
    … …  
    333319     *
    334320     * @since 2.0.0 bbPress (r2746)
    335      *
    336      * @uses bbp_get_reply_post_type() To get the reply post type
    337      * @uses add_meta_box() To add the meta-box
    338      * @uses do_action() Calls 'bbp_reply_attributes_metabox'
    339321     */
    340322    public function attributes_metabox() {
    … …  
    355337     *
    356338     * @since 2.0.0 bbPress (r2828)
    357      *
    358      * @uses bbp_get_topic() To get the topic
    359      * @uses bbp_get_reply() To get the reply
    360      * @uses bbp_get_topic_post_type() To get the topic post type
    361      * @uses bbp_get_reply_post_type() To get the reply post type
    362      * @uses add_meta_box() To add the meta-box
    363339     */
    364340    public function author_metabox() {
    … …  
    398374     *
    399375     * @param int $reply_id Reply id
    400      * @uses current_user_can() To check if the current user is capable of
    401      *                           editing the reply
    402      * @uses do_action() Calls 'bbp_reply_attributes_metabox_save' with the
    403      *                    reply id and parent id
    404376     * @return int Parent id
    405377     */
    … …  
    457429     *
    458430     * @since 2.0.0 bbPress (r2740)
    459      *
    460      * @uses bbp_get_reply() To get the reply
    461      * @uses current_user_can() To check if the user is capable of editing
    462      *                           the reply
    463      * @uses wp_die() To die if the user isn't capable or the post wasn't
    464      *                 found
    465      * @uses check_admin_referer() To verify the nonce and check referer
    466      * @uses bbp_is_reply_spam() To check if the reply is marked as spam
    467      * @uses bbp_unspam_reply() To unmark the reply as spam
    468      * @uses bbp_spam_reply() To mark the reply as spam
    469      * @uses do_action() Calls 'bbp_toggle_reply_admin' with success, post
    470      *                    data, action and message
    471      * @uses add_query_arg() To add custom args to the url
    472      * @uses bbp_redirect() Redirect the page to custom url
    473431     */
    474432    public function toggle_reply() {
    … …  
    558516     *
    559517     * @since 2.0.0 bbPress (r2740)
    560      *
    561      * @uses bbp_get_reply() To get the reply
    562      * @uses bbp_get_reply_title() To get the reply title of the reply
    563      * @uses esc_html() To sanitize the reply title
    564      * @uses apply_filters() Calls 'bbp_toggle_reply_notice_admin' with
    565      *                        message, reply id, notice and is it a failure
    566518     */
    567519    public function toggle_reply_notice() {
    … …  
    675627     *
    676628     * @param array $columns The columns
    677      * @uses apply_filters() Calls 'bbp_admin_replies_column_headers' with
    678      *                        the columns
     629     *
    679630     * @return array $columns bbPress reply columns
    680631     */
    … …  
    700651     * @param string $column Column
    701652     * @param int $reply_id reply id
    702      * @uses bbp_get_reply_topic_id() To get the topic id of the reply
    703      * @uses bbp_topic_title() To output the reply's topic title
    704      * @uses apply_filters() Calls 'reply_topic_row_actions' with an array
    705      *                        of reply topic actions
    706      * @uses bbp_get_topic_permalink() To get the topic permalink
    707      * @uses bbp_get_topic_forum_id() To get the forum id of the topic of
    708      *                                 the reply
    709      * @uses bbp_get_forum_permalink() To get the forum permalink
    710      * @uses admin_url() To get the admin url of post.php
    711      * @uses apply_filters() Calls 'reply_topic_forum_row_actions' with an
    712      *                        array of reply topic forum actions
    713      * @uses bbp_reply_author_display_name() To output the reply author name
    714      * @uses get_the_date() Get the reply creation date
    715      * @uses get_the_time() Get the reply creation time
    716      * @uses esc_attr() To sanitize the reply creation time
    717      * @uses bbp_get_reply_last_active_time() To get the time when the reply was
    718      *                                    last active
    719      * @uses do_action() Calls 'bbp_admin_replies_column_data' with the
    720      *                    column and reply id
    721653     */
    722654    public function column_data( $column, $reply_id ) {
    … …  
    816748     * @param array $actions Actions
    817749     * @param array $reply Reply object
    818      * @uses bbp_get_reply_post_type() To get the reply post type
    819      * @uses bbp_reply_content() To output reply content
    820      * @uses bbp_get_reply_url() To get the reply link
    821      * @uses bbp_get_reply_title() To get the reply title
    822      * @uses current_user_can() To check if the current user can edit or
    823      *                           delete the reply
    824      * @uses bbp_is_reply_spam() To check if the reply is marked as spam
    825      * @uses get_post_type_object() To get the reply post type object
    826      * @uses add_query_arg() To add custom args to the url
    827      * @uses remove_query_arg() To remove custom args from the url
    828      * @uses wp_nonce_url() To nonce the url
    829      * @uses get_delete_post_link() To get the delete post link of the reply
     750     *
    830751     * @return array $actions Actions
    831752     */
    … …  
    898819     * @since 2.0.0 bbPress (r2991)
    899820     *
    900      * @uses bbp_get_reply_post_type() To get the reply post type
    901      * @uses bbp_get_topic_post_type() To get the topic post type
    902      * @uses bbp_dropdown() To generate a forum dropdown
    903821     * @return bool False. If post type is not topic or reply
    904822     */
    … …  
    934852     *
    935853     * @param array $query_vars Query variables from {@link WP_Query}
    936      * @uses is_admin() To check if it's the admin section
    937      * @uses bbp_get_topic_post_type() To get the topic post type
    938      * @uses bbp_get_reply_post_type() To get the reply post type
    939854     * @return array Processed Query Vars
    940855     */
    … …  
    958873     *
    959874     * @global int $post_ID
    960      * @uses bbp_get_topic_permalink()
    961      * @uses wp_post_revision_title()
    962      * @uses esc_url()
    963      * @uses add_query_arg()
    964875     *
    965876     * @param array $messages
    … …  
    1057968 *
    1058969 * @param WP_Screen $current_screen Current screen object
    1059  * @uses BBP_Replies_Admin
    1060970 */
    1061971function bbp_admin_replies( $current_screen ) {
Note: See TracChangeset for help on using the changeset viewer.