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

    r6559 r6573  
    3434     *
    3535     * @since 2.0.0 bbPress (r2515)
    36      *
    37      * @uses BBP_Forums_Admin::setup_globals() Setup the globals needed
    38      * @uses BBP_Forums_Admin::setup_actions() Setup the hooks and actions
    39      * @uses BBP_Forums_Admin::setup_help() Setup the help text
    4036     */
    4137    public function __construct() {
     
    5046     *
    5147     * @access private
    52      *
    53      * @uses add_action() To add various actions
    54      * @uses add_filter() To add various filters
    55      * @uses bbp_get_forum_post_type() To get the forum post type
    56      * @uses bbp_get_topic_post_type() To get the topic post type
    57      * @uses bbp_get_reply_post_type() To get the reply post type
    5848     */
    5949    private function setup_actions() {
     
    10393     *
    10494     * @since 2.0.0 bbPress (r3119)
    105      *
    106      * @uses get_current_screen()
    10795     */
    10896    public function edit_help() {
     
    163151     *
    164152     * @since 2.0.0 bbPress (r3119)
    165      *
    166      * @uses get_current_screen()
    167153     */
    168154    public function new_help() {
     
    221207     *
    222208     * @since 2.0.0 bbPress (r2746)
    223      *
    224      * @uses bbp_get_forum_post_type() To get the forum post type
    225      * @uses add_meta_box() To add the meta-box
    226      * @uses do_action() Calls 'bbp_forum_attributes_metabox'
    227209     */
    228210    public function attributes_metabox() {
     
    241223     *
    242224     * @since 2.6.0 bbPress
    243      *
    244      * @uses bbp_get_forum_post_type() To get the forum post type
    245      * @uses add_meta_box() To add the meta-box
    246      * @uses do_action() Calls 'bbp_forum_attributes_metabox'
    247225     */
    248226    public function moderators_metabox() {
     
    270248     *
    271249     * @since 2.6.0 bbPress (r6197)
    272      *
    273      * @uses add_meta_box() To add the meta-box
    274250     */
    275251    public function subscriptions_metabox() {
     
    314290     *
    315291     * @param int $forum_id Forum id
    316      * @uses current_user_can() To check if the current user is capable of
    317      *                           editing the forum
    318      * @uses bbp_get_forum() To get the forum
    319      * @uses bbp_is_forum_closed() To check if the forum is closed
    320      * @uses bbp_is_forum_category() To check if the forum is a category
    321      * @uses bbp_is_forum_private() To check if the forum is private
    322      * @uses bbp_close_forum() To close the forum
    323      * @uses bbp_open_forum() To open the forum
    324      * @uses bbp_categorize_forum() To make the forum a category
    325      * @uses bbp_normalize_forum() To make the forum normal (not category)
    326      * @uses bbp_privatize_forum() To mark the forum as private
    327      * @uses bbp_publicize_forum() To mark the forum as public
    328      * @uses do_action() Calls 'bbp_forum_attributes_metabox_save' with the
    329      *                    forum id
    330292     * @return int Forum id
    331293     */
     
    379341     *
    380342     * @since 2.6.0 bbPress (r5254)
    381      *
    382      * @uses bbp_get_forum() To get the forum
    383      * @uses current_user_can() To check if the user is capable of editing
    384      *                           the forum
    385      * @uses wp_die() To die if the user isn't capable or the post wasn't
    386      *                 found
    387      * @uses check_admin_referer() To verify the nonce and check referer
    388      * @uses bbp_is_forum_open() To check if the forum is open
    389      * @uses bbp_close_forum() To close the forum
    390      * @uses bbp_open_forum() To open the forum
    391      * @uses do_action() Calls 'bbp_toggle_forum_admin' with success, post
    392      *                    data, action and message
    393      * @uses add_query_arg() To add custom args to the url
    394      * @uses bbp_redirect() Redirect the page to custom url
    395343     */
    396344    public function toggle_forum() {
     
    467415     *
    468416     * @since 2.6.0 bbPress (r5254)
    469      *
    470      * @uses bbp_get_forum() To get the forum
    471      * @uses bbp_get_forum_title() To get the forum title of the forum
    472      * @uses esc_html() To sanitize the forum title
    473      * @uses apply_filters() Calls 'bbp_toggle_forum_notice_admin' with
    474      *                        message, forum id, notice and is it a failure
    475417     */
    476418    public function toggle_forum_notice() {
     
    569511     *
    570512     * @param array $columns The columns
    571      * @uses apply_filters() Calls 'bbp_admin_forums_column_headers' with
    572      *                        the columns
     513     *
    573514     * @return array $columns bbPress forum columns
    574515     */
     
    603544     * @param string $column Column
    604545     * @param int $forum_id Forum id
    605      * @uses bbp_forum_topic_count() To output the forum topic count
    606      * @uses bbp_forum_reply_count() To output the forum reply count
    607      * @uses get_the_date() Get the forum creation date
    608      * @uses get_the_time() Get the forum creation time
    609      * @uses esc_attr() To sanitize the forum creation time
    610      * @uses bbp_get_forum_last_active_time() To get the time when the forum was
    611      *                                    last active
    612      * @uses do_action() Calls 'bbp_admin_forums_column_data' with the
    613      *                    column and forum id
    614546     */
    615547    public function column_data( $column, $forum_id ) {
     
    666598     * @param array $actions Actions
    667599     * @param array $forum Forum object
    668      * @uses bbp_get_public_status_id() To get the published forum id's
    669      * @uses bbp_get_private_status_id() To get the private forum id's
    670      * @uses bbp_get_hidden_status_id() To get the hidden forum id's
    671      * @uses bbp_get_closed_status_id() To get the closed forum id's
    672      * @uses wp_nonce_url() To nonce the url
    673      * @uses bbp_is_forum_open() To check if a forum is open
    674      * @uses bbp_forum_content() To output forum description
    675600     * @return array $actions Actions
    676601     */
     
    705630     *
    706631     * @global int $post_ID
    707      * @uses bbp_get_forum_permalink()
    708      * @uses wp_post_revision_title()
    709      * @uses esc_url()
    710      * @uses add_query_arg()
    711632     *
    712633     * @param array $messages
     
    804725 *
    805726 * @param WP_Screen $current_screen Current screen object
    806  * @uses BBP_Forums_Admin
    807727 */
    808728function bbp_admin_forums( $current_screen ) {
Note: See TracChangeset for help on using the changeset viewer.