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/users/options.php

    r5908 r5951  
    1414 * Get the default user options and their values
    1515 *
    16  * @since bbPress (r3910)
     16 * @since 2.1.0 bbPress (r3910)
     17 *
    1718 * @return array Filtered user option names and values
    1819 */
    … …  
    3435 * This is destructive, so existing bbPress user options will be overridden.
    3536 *
    36  * @since bbPress (r3910)
     37 * @since 2.1.0 bbPress (r3910)
     38 *
    3739 * @uses bbp_get_default_user_options() To get default options
    3840 * @uses update_user_option() Adds default options
    … …  
    6264 * This is destructive, so existing bbPress user options will be destroyed.
    6365 *
    64  * @since bbPress (r3910)
     66 * @since 2.1.0 bbPress (r3910)
     67 *
    6568 * @uses bbp_get_default_user_options() To get default options
    6669 * @uses delete_user_option() Removes default options
    … …  
    8891 * inside the $bbp->options array.
    8992 *
    90  * @since bbPress (r3910)
     93 * @since 2.1.0 bbPress (r3910)
     94 *
    9195 * @uses bbp_get_default_user_options() To get default options
    9296 * @uses add_filter() To add filters to 'pre_option_{$key}'
    … …  
    108112 * $bbp->user_options array.
    109113 *
    110  * @since bbPress (r3910)
     114 * @since 2.1.0 bbPress (r3910)
     115 *
    111116 * @param bool $value Optional. Default value false
    112117 * @return mixed false if not overloaded, mixed if set
    … …  
    129134 * Update the topic count for a user
    130135 *
    131  * @since bbPress (r5309)
     136 * @since 2.6.0 bbPress (r5309)
    132137 *
    133138 * @param int $user_id
    … …  
    158163 * Update the reply count for a user
    159164 *
    160  * @since bbPress (r5309)
     165 * @since 2.6.0 bbPress (r5309)
    161166 *
    162167 * @param int $user_id
    … …  
    187192 * Output a users topic count
    188193 *
    189  * @since bbPress (r3632)
     194 * @since 2.1.0 bbPress (r3632)
    190195 *
    191196 * @param int $user_id
    … …  
    200205     * Return a users reply count
    201206     *
    202      * @since bbPress (r3632)
     207     * @since 2.1.0 bbPress (r3632)
    203208     *
    204209     * @param int $user_id
    … …  
    226231 * Output a users reply count
    227232 *
    228  * @since bbPress (r3632)
     233 * @since 2.1.0 bbPress (r3632)
    229234 *
    230235 * @param int $user_id
    … …  
    239244     * Return a users reply count
    240245     *
    241      * @since bbPress (r3632)
     246     * @since 2.1.0 bbPress (r3632)
    242247     *
    243248     * @param int $user_id
    … …  
    265270 * Output a users total post count
    266271 *
    267  * @since bbPress (r3632)
     272 * @since 2.1.0 bbPress (r3632)
    268273 *
    269274 * @param int $user_id
    … …  
    278283     * Return a users total post count
    279284     *
    280      * @since bbPress (r3632)
     285     * @since 2.1.0 bbPress (r3632)
    281286     *
    282287     * @param int $user_id
    … …  
    308313 * Update a users last posted time, for use with post throttling
    309314 *
    310  * @since bbPress (r3910)
     315 * @since 2.1.0 bbPress (r3910)
     316 *
    311317 * @param int $user_id User ID to update
    312318 * @param int $time Time in time() format
    … …  
    332338 * Output the raw value of the last posted time.
    333339 *
    334  * @since bbPress (r3910)
     340 * @since 2.1.0 bbPress (r3910)
     341 *
    335342 * @param int $user_id User ID to retrieve value for
    336343 * @uses bbp_get_user_last_posted() To output the last posted time
    … …  
    343350     * Return the raw value of teh last posted time.
    344351     *
    345      * @since bbPress (r3910)
     352     * @since 2.1.0 bbPress (r3910)
     353     *
    346354     * @param int $user_id User ID to retrieve value for
    347355     * @return mixed False if no user, time() format if exists
Note: See TracChangeset for help on using the changeset viewer.