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

    r6563 r6573  
    142142 *
    143143 * @since 2.0.0 bbPress (r3421)
    144  *
    145  * @uses bbp_get_default_options() To get default options
    146  * @uses add_option() Adds default options
    147  * @uses do_action() Calls 'bbp_add_options'
    148144 */
    149145function bbp_add_options() {
    … …  
    165161 *
    166162 * @since 2.0.0 bbPress (r3421)
    167  *
    168  * @uses bbp_get_default_options() To get default options
    169  * @uses delete_option() Removes default options
    170  * @uses do_action() Calls 'bbp_delete_options'
    171163 */
    172164function bbp_delete_options() {
    … …  
    186178 *
    187179 * @since 2.0.0 bbPress (r3451)
    188  *
    189  * @uses bbp_get_default_options() To get default options
    190  * @uses add_filter() To add filters to 'pre_option_{$key}'
    191  * @uses do_action() Calls 'bbp_add_option_filters'
    192180 */
    193181function bbp_setup_option_filters() {
    … …  
    320308 *
    321309 * @param bool $default Optional.Default value true
    322  * @uses get_option() To get the favorites option
    323310 * @return bool Is favorites enabled or not
    324311 */
    … …  
    335322 *
    336323 * @param bool $default Optional.Default value true
    337  * @uses get_option() To get the subscriptions option
    338324 * @return bool Is subscription enabled or not
    339325 */
    … …  
    350336 *
    351337 * @param bool $default Optional.Default value true
    352  * @uses get_option() To get the engagements option
    353338 * @return bool Is engagements enabled or not
    354339 */
    … …  
    365350 *
    366351 * @param bool $default Optional. Default value false
    367  * @uses get_option() To get the global content edit option
    368352 * @return bool Is content editing allowed?
    369353 */
    … …  
    380364 *
    381365 * @param bool $default Optional. Default value false
    382  * @uses get_option() To get the content throttle  option
    383366 * @return bool Is content throttling allowed?
    384367 */
    … …  
    395378 *
    396379 * @param bool $default Optional. Default value true
    397  * @uses get_option() To get the allow tags
    398380 * @return bool Are tags allowed?
    399381 */
    … …  
    410392 *
    411393 * @param bool $default Optional. Default value true.
    412  * @uses get_option() To get the allow per-forum moderators setting
    413394 *
    414395 * @return bool Are per-forum moderators allowed?
    … …  
    426407 *
    427408 * @param bool $default Optional. Default value true.
    428  * @uses get_option() To get the allow super moderators setting
    429409 *
    430410 * @return bool Are moderators allowed to edit users?
    … …  
    442422 *
    443423 * @param bool $default Optional. Default value true
    444  * @uses get_option() To get the forum-wide search setting
    445424 * @return bool Is forum-wide searching allowed?
    446425 */
    … …  
    457436 *
    458437 * @param bool $default Optional. Default value false
    459  * @uses get_option() To get the threaded replies setting
    460438 * @return bool Are threaded replies allowed?
    461439 */
    … …  
    472450 *
    473451 * @param int $default Thread replies depth
    474  * @uses apply_filters() Calls 'bbp_thread_replies_depth' with the option value and
    475  *                       the default depth
    476  * @uses get_option() To get the thread replies depth
    477452 * @return int Thread replies depth
    478453 */
    … …  
    489464 *
    490465 * @param bool $default Optional. Default value true
    491  * @uses get_option() To get the allow revisions
    492466 * @return bool Are revisions allowed?
    493467 */
    … …  
    504478 *
    505479 * @param bool $default Optional. Default value
    506  * @uses get_option() To get the allow anonymous option
    507480 * @return bool Is anonymous posting allowed?
    508481 */
    … …  
    519492 *
    520493 * @param bool $default Optional. Default value false
    521  * @uses get_option() To get the global access option
    522494 * @return bool Is global access allowed?
    523495 */
    … …  
    534506 *
    535507 * @param string $default Optional. Default value empty
    536  * @uses get_option() To get the default forums role option
    537508 * @return string The default forums user role
    538509 */
    … …  
    549520 *
    550521 * @param bool $default Optional. Default value true
    551  * @uses get_option() To get the WP editor option
    552522 * @return bool Use WP editor?
    553523 */
    … …  
    564534 *
    565535 * @param bool $default Optional. Default value true
    566  * @uses get_option() To get the oEmbed option
    567536 * @return bool Use oEmbed?
    568537 */
    … …  
    579548 *
    580549 * @param string $default Optional. Default value 'default'
    581  * @uses get_option() To get the theme-package option
    582550 * @return string ID of the theme-package
    583551 */
    … …  
    604572     *
    605573     * @param bool $default Optional. Default value 80
    606      * @uses get_option() To get the maximum title length
    607574     * @return int Is anonymous posting allowed?
    608575     */
    … …  
    629596     *
    630597     * @param bool $default Optional. Default value 0
    631      * @uses get_option() To get the root group forum ID
    632598     * @return int The post ID for the root forum
    633599     */
    … …  
    644610 *
    645611 * @param bool $default Optional. Default value true
    646  * @uses get_option() To get the group forums option
    647612 * @return bool Is group forums enabled or not
    648613 */
    … …  
    659624 *
    660625 * @param bool $default Optional. Default value true
    661  * @uses get_option() To get the Akismet option
    662626 * @return bool Is Akismet enabled or not
    663627 */
    … …  
    679643 *
    680644 * @param bool $default Optional. Default value false
    681  * @uses get_option() To get the admin integration setting
    682645 * @return bool To deeply integrate settings, or not
    683646 */
    … …  
    711674 *
    712675 * @param string $default Optional. Default value 'forums'
    713  * @uses get_option() To get the slug
    714676 * @return string
    715677 */
    … …  
    726688 *
    727689 * @param bool $default Optional. Default value true
    728  * @uses get_option() To get the setting
    729690 * @return bool
    730691 */
    … …  
    741702 *
    742703 * @param string $default Optional. Default value 'forums'
    743  * @uses get_option() To get the setting
    744704 * @return string
    745705 */
    … …  
    756716 *
    757717 * @param string $default Optional. Default value 'forums'
    758  * @uses get_option() To get the slug
    759718 * @return string
    760719 */
    … …  
    775734 *
    776735 * @param string $default Optional. Default value 'forum'
    777  * @uses get_option() To get the slug
    778736 * @return string
    779737 */
    … …  
    790748 *
    791749 * @param string $default Optional. Default value 'topics'
    792  * @uses get_option() To get the slug
    793750 * @return string
    794751 */
    … …  
    805762 *
    806763 * @param string $default Optional. Default value 'replies'
    807  * @uses get_option() To get the slug
    808764 * @return string
    809765 */
    … …  
    820776 *
    821777 * @param string $default Optional. Default value 'topic'
    822  * @uses get_option() To get the slug
    823778 * @return string
    824779 */
    … …  
    835790 *
    836791 * @param string $default Optional. Default value 'topic-tag'
    837  * @uses get_option() To get the slug
    838792 * @return string
    839793 */
    … …  
    850804 *
    851805 * @param string $default Optional. Default value 'reply'
    852  * @uses get_option() To get the slug
    853806 * @return string
    854807 */
    … …  
    865818 *
    866819 * @param string $default Optional. Default value 'users'
    867  * @uses get_option() To get the slug
    868820 * @return string
    869821 */
    … …  
    880832 *
    881833 * @param string $default Optional. Default value 'favorites'
    882  * @uses get_option() To get the slug
    883834 * @return string
    884835 */
    … …  
    895846 *
    896847 * @param string $default Optional. Default value 'subscriptions'
    897  * @uses get_option() To get the slug
    898848 * @return string
    899849 */
    … …  
    910860 *
    911861 * @param string $default Optional. Default value 'engagements'
    912  * @uses get_option() To get the slug
    913862 * @return string
    914863 */
    … …  
    925874 *
    926875 * @param string $default Optional. Default value 'view'
    927  * @uses get_option() To get the slug
    928876 * @return string
    929877 */
    … …  
    940888 *
    941889 * @param string $default Optional. Default value 'search'
    942  * @uses get_option() To get the slug
    943890 * @return string
    944891 */
    … …  
    957904 *
    958905 * @param string $default Optional. Default empty string
    959  * @uses get_option() To get the old bb-config.php location
    960906 * @return string The location of the bb-config.php file, if any
    961907 */
Note: See TracChangeset for help on using the changeset viewer.