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

    r6438 r6573  
    3434 *
    3535 * @since 2.1.0 bbPress (r3910)
    36  *
    37  * @uses bbp_get_default_user_options() To get default options
    38  * @uses update_user_option() Adds default options
    39  * @uses do_action() Calls 'bbp_add_user_options'
    4036 */
    4137function bbp_add_user_options( $user_id = 0 ) {
    … …  
    6359 *
    6460 * @since 2.1.0 bbPress (r3910)
    65  *
    66  * @uses bbp_get_default_user_options() To get default options
    67  * @uses delete_user_option() Removes default options
    68  * @uses do_action() Calls 'bbp_delete_options'
    6961 */
    7062function bbp_delete_user_options( $user_id = 0 ) {
    … …  
    9082 *
    9183 * @since 2.1.0 bbPress (r3910)
    92  *
    93  * @uses bbp_get_default_user_options() To get default options
    94  * @uses add_filter() To add filters to 'pre_option_{$key}'
    95  * @uses do_action() Calls 'bbp_add_option_filters'
    9684 */
    9785function bbp_setup_user_option_filters() {
    … …  
    194182 * @param int $user_id
    195183 * @param boolean $integer Optional. Whether or not to format the result
    196  * @uses bbp_get_user_topic_count()
     184 *
    197185 * @return string
    198186 */
    … …  
    207195     * @param int $user_id
    208196     * @param boolean $integer Optional. Whether or not to format the result
    209      * @uses bbp_get_user_id()
    210      * @uses get_user_option()
    211      * @uses apply_filters()
     197     *
    212198     * @return string
    213199     */
    … …  
    236222 * @param int $user_id
    237223 * @param boolean $integer Optional. Whether or not to format the result
    238  * @uses bbp_get_user_reply_count()
     224 *
    239225 * @return string
    240226 */
    … …  
    249235     * @param int $user_id
    250236     * @param boolean $integer Optional. Whether or not to format the result
    251      * @uses bbp_get_user_id()
    252      * @uses get_user_option()
    253      * @uses apply_filters()
     237     *
    254238     * @return string
    255239     */
    … …  
    277261 * @param int $user_id
    278262 * @param boolean $integer Optional. Whether or not to format the result
    279  * @uses bbp_get_user_post_count()
     263 *
    280264 * @return string
    281265 */
    … …  
    290274     * @param int $user_id
    291275     * @param boolean $integer Optional. Whether or not to format the result
    292      * @uses bbp_get_user_id()
    293      * @uses get_user_option()
    294      * @uses apply_filters()
     276     *
    295277     * @return string
    296278     */
    … …  
    346328 *
    347329 * @param int $user_id User ID to retrieve value for
    348  * @uses bbp_get_user_last_posted() To output the last posted time
    349330 */
    350331function bbp_user_last_posted( $user_id = 0 ) {
Note: See TracChangeset for help on using the changeset viewer.