Skip to:
Content

bbPress.org


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/includes/admin/topics.php

    r6566 r6573  
    3434         *
    3535         * @since 2.0.0 bbPress (r2515)
    36          *
    37          * @uses BBP_Topics_Admin::setup_globals() Setup the globals needed
    38          * @uses BBP_Topics_Admin::setup_actions() Setup the hooks and actions
    39          * @uses BBP_Topics_Admin::setup_help() 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() {
    … …  
    118108         *
    119109         * @since 2.0.0 bbPress (r3119)
    120          *
    121          * @uses get_current_screen()
    122110         */
    123111        public function edit_help() {
    … …  
    184172         *
    185173         * @since 2.0.0 bbPress (r3119)
    186          *
    187          * @uses get_current_screen()
    188174         */
    189175        public function new_help() {
    … …  
    338324         *
    339325         * @since 2.0.0 bbPress (r2744)
    340          *
    341          * @uses bbp_get_topic_post_type() To get the topic post type
    342          * @uses add_meta_box() To add the meta-box
    343          * @uses do_action() Calls 'bbp_topic_attributes_metabox'
    344326         */
    345327        public function attributes_metabox() {
    … …  
    358340         *
    359341         * @since 2.0.0 bbPress (r2828)
    360          *
    361          * @uses add_meta_box() To add the meta-box
    362342         */
    363343        public function author_metabox() {
    … …  
    386366         *
    387367         * @since 2.6.0 bbPress (r5886)
    388          *
    389          * @uses bbp_get_topic() To get the topic
    390          * @uses bbp_get_reply() To get the reply
    391          * @uses bbp_get_topic_post_type() To get the topic post type
    392          * @uses bbp_get_reply_post_type() To get the reply post type
    393          * @uses add_meta_box() To add the meta-box
    394          * @uses do_action() Calls 'bbp_author_metabox' with the topic/reply
    395          *                    id
    396368         */
    397369        public function replies_metabox() {
    … …  
    419391         *
    420392         * @since 2.6.0 bbPress (r6333)
    421          *
    422          * @uses add_meta_box() To add the meta-box
    423393         */
    424394        public function engagements_metabox() {
    … …  
    451421         *
    452422         * @since 2.6.0 bbPress (r6197)
    453          *
    454          * @uses add_meta_box() To add the meta-box
    455423         */
    456424        public function favorites_metabox() {
    … …  
    483451         *
    484452         * @since 2.6.0 bbPress (r6197)
    485          *
    486          * @uses add_meta_box() To add the meta-box
    487453         */
    488454        public function subscriptions_metabox() {
    … …  
    527493         *
    528494         * @param int $topic_id Topic id
    529          * @uses current_user_can() To check if the current user is capable of
    530          *                           editing the topic
    531          * @uses do_action() Calls 'bbp_topic_attributes_metabox_save' with the
    532          *                    topic id and parent id
    533495         * @return int Parent id
    534496         */
    … …  
    585547         *
    586548         * @since 2.0.0 bbPress (r2727)
    587          *
    588          * @uses bbp_get_topic() To get the topic
    589          * @uses current_user_can() To check if the user is capable of editing
    590          *                           the topic
    591          * @uses wp_die() To die if the user isn't capable or the post wasn't
    592          *                 found
    593          * @uses check_admin_referer() To verify the nonce and check referer
    594          * @uses bbp_is_topic_open() To check if the topic is open
    595          * @uses bbp_close_topic() To close the topic
    596          * @uses bbp_open_topic() To open the topic
    597          * @uses bbp_is_topic_sticky() To check if the topic is a sticky or
    598          *                              super sticky
    599          * @uses bbp_unstick_topic() To unstick the topic
    600          * @uses bbp_stick_topic() To stick the topic
    601          * @uses bbp_is_topic_spam() To check if the topic is marked as spam
    602          * @uses bbp_unspam_topic() To unmark the topic as spam
    603          * @uses bbp_spam_topic() To mark the topic as spam
    604          * @uses do_action() Calls 'bbp_toggle_topic_admin' with success, post
    605          *                    data, action and message
    606          * @uses add_query_arg() To add custom args to the url
    607          * @uses bbp_redirect() Redirect the page to custom url
    608549         */
    609550        public function toggle_topic() {
    … …  
    725666         *
    726667         * @since 2.0.0 bbPress (r2727)
    727          *
    728          * @uses bbp_get_topic() To get the topic
    729          * @uses bbp_get_topic_title() To get the topic title of the topic
    730          * @uses esc_html() To sanitize the topic title
    731          * @uses apply_filters() Calls 'bbp_toggle_topic_notice_admin' with
    732          *                        message, topic id, notice and is it a failure
    733668         */
    734669        public function toggle_topic_notice() {
    … …  
    880815         *
    881816         * @param array $columns The columns
    882          * @uses apply_filters() Calls 'bbp_admin_topics_column_headers' with
    883          *                        the columns
     817         *
    884818         * @return array $columns bbPress topic columns
    885819         */
    … …  
    907841         * @param string $column Column
    908842         * @param int $topic_id Topic id
    909          * @uses bbp_get_topic_forum_id() To get the forum id of the topic
    910          * @uses bbp_forum_title() To output the topic's forum title
    911          * @uses apply_filters() Calls 'topic_forum_row_actions' with an array
    912          *                        of topic forum actions
    913          * @uses bbp_get_forum_permalink() To get the forum permalink
    914          * @uses admin_url() To get the admin url of post.php
    915          * @uses bbp_topic_reply_count() To output the topic reply count
    916          * @uses bbp_topic_voice_count() To output the topic voice count
    917          * @uses bbp_topic_author_display_name() To output the topic author name
    918          * @uses get_the_date() Get the topic creation date
    919          * @uses get_the_time() Get the topic creation time
    920          * @uses esc_attr() To sanitize the topic creation time
    921          * @uses bbp_get_topic_last_active_time() To get the time when the topic was
    922          *                                    last active
    923          * @uses do_action() Calls 'bbp_admin_topics_column_data' with the
    924          *                    column and topic id
    925843         */
    926844        public function column_data( $column, $topic_id ) {
    … …  
    1006924         * @param array $actions Actions
    1007925         * @param array $topic Topic object
    1008          * @uses bbp_get_topic_post_type() To get the topic post type
    1009          * @uses bbp_topic_content() To output topic content
    1010          * @uses bbp_get_topic_permalink() To get the topic link
    1011          * @uses bbp_get_topic_title() To get the topic title
    1012          * @uses current_user_can() To check if the current user can edit or
    1013          *                           delete the topic
    1014          * @uses bbp_is_topic_open() To check if the topic is open
    1015          * @uses bbp_is_topic_spam() To check if the topic is marked as spam
    1016          * @uses bbp_is_topic_sticky() To check if the topic is a sticky or a
    1017          *                              super sticky
    1018          * @uses get_post_type_object() To get the topic post type object
    1019          * @uses add_query_arg() To add custom args to the url
    1020          * @uses remove_query_arg() To remove custom args from the url
    1021          * @uses wp_nonce_url() To nonce the url
    1022          * @uses get_delete_post_link() To get the delete post link of the topic
    1023926         * @return array $actions Actions
    1024927         */
    … …  
    11111014         * @since 2.0.0 bbPress (r2991)
    11121015         *
    1113          * @uses bbp_get_reply_post_type() To get the reply post type
    1114          * @uses bbp_get_topic_post_type() To get the topic post type
    1115          * @uses bbp_dropdown() To generate a forum dropdown
    11161016         * @return bool False. If post type is not topic or reply
    11171017         */
    … …  
    11471047         *
    11481048         * @param array $query_vars Query variables from {@link WP_Query}
    1149          * @uses is_admin() To check if it's the admin section
    1150          * @uses bbp_get_topic_post_type() To get the topic post type
    1151          * @uses bbp_get_reply_post_type() To get the reply post type
    11521049         * @return array Processed Query Vars
    11531050         */
    … …  
    11711068         *
    11721069         * @global int $post_ID
    1173          * @uses bbp_get_topic_permalink()
    1174          * @uses wp_post_revision_title()
    1175          * @uses esc_url()
    1176          * @uses add_query_arg()
    11771070         *
    11781071         * @param array $messages
    … …  
    12701163 *
    12711164 * @param WP_Screen $current_screen Current screen object
    1272  * @uses BBP_Forums_Admin
    12731165 */
    12741166function bbp_admin_topics( $current_screen ) {
Note: See TracChangeset for help on using the changeset viewer.