Skip to:
Content

bbPress.org


Ignore:
Timestamp:
10/28/2015 04:07:50 AM (10 years ago)
Author:
netweb
Message:

Standardize @since PHPDoc tags style and format

This changeset updates the style and formatting of all of our @since instances for compatibility with phpDocumentor 2 and WP-Parser as we move toward implementing the bbPress developer code reference.

Props thebrandonallen
Fixes #2879

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/includes/admin/topics.php

    r5908 r5951  
    1717 * @package bbPress
    1818 * @subpackage Administration
    19  * @since bbPress (r2464)
     19 * @since 2.0.0 bbPress (r2464)
    2020 */
    2121class BBP_Topics_Admin {
     
    3333     * The main bbPress topics admin loader
    3434     *
    35      * @since bbPress (r2515)
     35     * @since 2.0.0 bbPress (r2515)
    3636     *
    3737     * @uses BBP_Topics_Admin::setup_globals() Setup the globals needed
     
    4747     * Setup the admin hooks, actions and filters
    4848     *
    49      * @since bbPress (r2646)
     49     * @since 2.0.0 bbPress (r2646)
     50     *
    5051     * @access private
    5152     *
     
    9697     * Should we bail out of this method?
    9798     *
    98      * @since bbPress (r4067)
     99     * @since 2.1.0 bbPress (r4067)
     100     *
    99101     * @return boolean
    100102     */
     
    110112     * Admin globals
    111113     *
    112      * @since bbPress (r2646)
     114     * @since 2.0.0 bbPress (r2646)
     115     *
    113116     * @access private
    114117     */
     
    122125     * Contextual help for bbPress topic edit page
    123126     *
    124      * @since bbPress (r3119)
     127     * @since 2.0.0 bbPress (r3119)
     128     *
    125129     * @uses get_current_screen()
    126130     */
     
    191195     * Contextual help for bbPress topic edit page
    192196     *
    193      * @since bbPress (r3119)
     197     * @since 2.0.0 bbPress (r3119)
     198     *
    194199     * @uses get_current_screen()
    195200     */
     
    249254     * Add the topic attributes metabox
    250255     *
    251      * @since bbPress (r2744)
     256     * @since 2.0.0 bbPress (r2744)
    252257     *
    253258     * @uses bbp_get_topic_post_type() To get the topic post type
     
    276281     * Pass the topic attributes for processing
    277282     *
    278      * @since bbPress (r2746)
     283     * @since 2.0.0 bbPress (r2746)
    279284     *
    280285     * @param int $topic_id Topic id
     
    356361     * Add the author info metabox
    357362     *
    358      * @since bbPress (r2828)
     363     * @since 2.0.0 bbPress (r2828)
    359364     *
    360365     * @uses bbp_get_topic() To get the topic
     
    396401     * comments are visible on a blog post.
    397402     *
    398      * @since bbPress (r5886)
     403     * @since 2.6.0 bbPress (r5886)
    399404     *
    400405     * @uses bbp_get_topic() To get the topic
     
    433438     * Add some general styling to the admin area
    434439     *
    435      * @since bbPress (r2464)
     440     * @since 2.0.0 bbPress (r2464)
    436441     *
    437442     * @uses bbp_get_forum_post_type() To get the forum post type
     
    520525     * spamming/unspamming of topics
    521526     *
    522      * @since bbPress (r2727)
     527     * @since 2.0.0 bbPress (r2727)
    523528     *
    524529     * @uses bbp_get_topic() To get the topic
     
    648653     * {@link BBP_Admin::toggle_topic()}
    649654     *
    650      * @since bbPress (r2727)
     655     * @since 2.0.0 bbPress (r2727)
    651656     *
    652657     * @uses bbp_get_topic() To get the topic
     
    753758     * Manage the column headers for the topics page
    754759     *
    755      * @since bbPress (r2485)
     760     * @since 2.0.0 bbPress (r2485)
    756761     *
    757762     * @param array $columns The columns
     
    783788     * Print extra columns for the topics page
    784789     *
    785      * @since bbPress (r2485)
     790     * @since 2.0.0 bbPress (r2485)
    786791     *
    787792     * @param string $column Column
     
    885890     * content and close/stick/spam links
    886891     *
    887      * @since bbPress (r2485)
     892     * @since 2.0.0 bbPress (r2485)
    888893     *
    889894     * @param array $actions Actions
     
    986991     * Add forum dropdown to topic and reply list table filters
    987992     *
    988      * @since bbPress (r2991)
     993     * @since 2.0.0 bbPress (r2991)
    989994     *
    990995     * @uses bbp_get_reply_post_type() To get the reply post type
     
    10191024     * Adjust the request query and include the forum id
    10201025     *
    1021      * @since bbPress (r2991)
     1026     * @since 2.0.0 bbPress (r2991)
    10221027     *
    10231028     * @param array $query_vars Query variables from {@link WP_Query}
     
    10471052     * Custom user feedback messages for topic post type
    10481053     *
    1049      * @since bbPress (r3080)
     1054     * @since 2.0.0 bbPress (r3080)
    10501055     *
    10511056     * @global int $post_ID
     
    11251130 * It could use dependency injection in the future, but for now this is easier.
    11261131 *
    1127  * @since bbPress (r2596)
     1132 * @since 2.0.0 bbPress (r2596)
    11281133 *
    11291134 * @uses BBP_Forums_Admin
Note: See TracChangeset for help on using the changeset viewer.