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/admin/tools/repair.php

    r6544 r6573  
    1919 * @todo Use a real list table
    2020 *
    21  * @uses bbp_admin_repair_list() To get the recount list
    22  * @uses check_admin_referer() To verify the nonce and the referer
    23  * @uses wp_cache_flush() To flush the cache
    24  * @uses do_action() Calls 'admin_notices' to display the notices
    25  * @uses wp_nonce_field() To add a hidden nonce field
    2621 */
    2722function bbp_admin_repair_page() {
    … …  
    169164 * @since 2.0.0 bbPress (r2613)
    170165 *
    171  * @uses wpdb::query() To run our recount database queries
    172  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    173  * @uses bbp_get_topic_post_type() To get the topic post type
    174  * @uses bbp_get_reply_post_type() To get the reply post type
    175  * @uses bbp_get_public_status_id() To get the public status id
    176  * @uses bbp_get_closed_status_id() To get the closed status id
    177166 * @return array An array of the status code and the message
    178167 */
    … …  
    224213 * @since 2.0.0 bbPress (r2613)
    225214 *
    226  * @uses wpdb::query() To run our recount database queries
    227  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    228  * @uses bbp_get_topic_post_type() To get the topic post type
    229  * @uses bbp_get_reply_post_type() To get the reply post type
    230  * @uses bbp_get_public_status_id() To get the public status id
    231  * @uses bbp_get_closed_status_id() To get the closed status id
    232215 * @return array An array of the status code and the message
    233216 */
    … …  
    282265 * @since 2.0.0 bbPress (r2747)
    283266 *
    284  * @uses wpdb::query() To run our recount database queries
    285  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    286  * @uses bbp_get_reply_post_type() To get the reply post type
    287  * @uses bbp_get_trash_status_id() To get the trash status id
    288  * @uses bbp_get_spam_status_id() To get the spam status id
    289  * @uses bbp_get_pending_status_id() To get the pending status id
    290267 * @return array An array of the status code and the message
    291268 */
    … …  
    321298 * @since 2.0.0 bbPress (r2613)
    322299 *
    323  * @uses wpdb::query() To run our recount database queries
    324  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    325  * @uses bbp_get_forum_post_type() To get the forum post type
    326  * @uses get_posts() To get the forums
    327  * @uses bbp_update_forum_topic_count() To update the forum topic count
    328300 * @return array An array of the status code and the message
    329301 */
    … …  
    358330 * @since 2.6.0 bbPress (r6256)
    359331 *
    360  * @uses bbp_get_topic_tag_tax_id() To get the topic-tag taxonomy
    361  * @uses get_terms() To get the terms
    362  * @uses wp_list_pluck() To get term taxonomy IDs
    363  * @uses get_taxonomy() To get term taxonomy object
    364  * @uses _update_post_term_count() To update generic counts
    365  * @uses bbp_update_topic_tag_count() To update topic-tag counts
    366  * @uses clean_term_cache() To bust the terms cache
    367332 * @return array An array of the status code and the message
    368333 */
    … …  
    409374 * @since 2.0.0 bbPress (r2613)
    410375 *
    411  * @uses wpdb::query() To run our recount database queries
    412  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    413  * @uses bbp_get_forum_post_type() To get the forum post type
    414  * @uses get_posts() To get the forums
    415  * @uses bbp_update_forum_reply_count() To update the forum reply count
    416376 * @return array An array of the status code and the message
    417377 */
    … …  
    455415 * @since 2.1.0 bbPress (r3889)
    456416 *
    457  * @uses bbp_get_topic_post_type() To get the topic post type
    458  * @uses bbp_get_public_status_id() To get the public status id
    459  * @uses wpdb::query() To run our recount database queries
    460  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    461417 * @return array An array of the status code and the message
    462418 */
    … …  
    507463 * @since 2.0.0 bbPress (r2613)
    508464 *
    509  * @uses bbp_get_reply_post_type() To get the reply post type
    510  * @uses bbp_get_public_status_id() To get the public status id
    511  * @uses wpdb::query() To run our recount database queries
    512  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    513465 * @return array An array of the status code and the message
    514466 */
    … …  
    559511 * @since 2.0.0 bbPress (r2613)
    560512 *
    561  * @uses wpdb::query() To run our recount database queries
    562  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    563  * @uses bbp_get_topic_post_type() To get the topic post type
    564  * @uses bbp_get_public_status_id() To get the public status id
    565513 * @return array An array of the status code and the message
    566514 */
    … …  
    630578 * @since 2.0.0 bbPress (r2668)
    631579 *
    632  * @uses wpdb::query() To run our recount database queries
    633  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    634  * @uses bbp_get_topic_post_type() To get the topic post type
    635  * @uses bbp_get_public_status_id() To get the public status id
    636580 * @return array An array of the status code and the message
    637581 */
    … …  
    699643 * @since 2.5.0 bbPress (r5155)
    700644 *
    701  * @uses wpdb::query() To run our recount database queries
    702  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    703  * @uses bbp_get_forum_post_type() To get the forum post type
    704  * @uses bbp_get_public_status_id() To get the public status id
    705645 * @return array An array of the status code and the message
    706646 */
    … …  
    769709 *
    770710 * @since 2.2.0 bbPress (r4340)
    771  *
    772  * @uses bbp_get_user_role_map() To get the map of user roles
    773  * @uses bbp_get_default_role() To get the default bbPress user role
    774  * @uses bbp_get_blog_roles() To get the current WordPress roles
    775  * @uses get_users() To get the users of each role (limited to ID field)
    776  * @uses bbp_set_user_role() To set each user's forums role
    777711 */
    778712function bbp_admin_repair_user_roles() {
    … …  
    827761 * @since 2.0.0 bbPress (r3040)
    828762 *
    829  * @uses wpdb::query() To run our recount database queries
    830  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    831  * @uses bbp_get_forum_post_type() To get the forum post type
    832  * @uses bbp_get_topic_post_type() To get the topic post type
    833  * @uses bbp_get_reply_post_type() To get the reply post type
    834  * @uses bbp_get_public_status_id() To get the public status id
    835  * @uses bbp_is_forum_category() To check if the forum is a category
    836  * @uses bbp_update_forum() To update the forums forum id
    837763 * @return array An array of the status code and the message
    838764 */
    … …  
    956882 * @since 2.3.0 bbPress (r4695)
    957883 *
    958  * @uses wpdb::get_col() To run our recount database queries
    959  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    960  * @uses bbp_get_forum_post_type() To get the forum post type
    961  * @uses get_post_meta() To get the sticky topics
    962  * @uses bbp_is_topic_super_sticky() To check if the topic is super sticky
    963  * @uses bbp_get_topic_forum_id() To get the topics forum id
    964  * @uses update_post_meta To update the topics sticky post meta
    965884 * @return array An array of the status code and the message
    966885 */
    … …  
    1028947 * @since 2.6.0 bbPress (r5668)
    1029948 *
    1030  * @uses wpdb::get_col() To run our recount database queries
    1031  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    1032  * @uses bbp_get_topic_post_type() To get the topic post type
    1033  * @uses get_post_meta() To get the closed topic status meta
    1034  * @uses update_post_meta To update the topics closed status post meta
    1035949 * @return array An array of the status code and the message
    1036950 */
    … …  
    1080994 * @since 2.2.0 bbPress (r4104)
    1081995 *
    1082  * @uses bbp_repair_forum_visibility() To update private and hidden forum ids
    1083996 * @return array An array of the status code and the message
    1084997 */
    … …  
    11011014 * @since 2.1.0 bbPress (r3876)
    11021015 *
    1103  * @uses wpdb::query() To run our recount database queries
    1104  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    1105  * @uses bbp_get_topic_post_type() To get the topic post type
    1106  * @uses bbp_get_reply_post_type() To get the reply post type
    11071016 * @return array An array of the status code and the message
    11081017 */
    … …  
    11561065 * @since 2.1.0 bbPress (r3876)
    11571066 *
    1158  * @uses wpdb::query() To run our recount database queries
    1159  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    1160  * @uses bbp_get_topic_post_type() To get the topic post type
    1161  * @uses bbp_get_reply_post_type() To get the reply post type
    11621067 * @return array An array of the status code and the message
    11631068 */
    … …  
    12111116 * @since 2.5.4 bbPress (r5367)
    12121117 *
    1213  * @uses wpdb::query() To run our recount database queries
    1214  * @uses is_wp_error() To check if the executed query returned {@link WP_Error}
    1215  * @uses bbp_get_reply_post_type() To get the reply post type
    1216  * @uses bbp_update_reply_position() To update the reply position
    12171118 * @return array An array of the status code and the message
    12181119 */
Note: See TracChangeset for help on using the changeset viewer.