Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/29/2016 06:12:08 PM (6 years ago)
Author:
djpaul
Message:

Remove redundant @uses PHPDoc tag from inline documentation.

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

    r10497 r10825  
    127127 * @since 1.6.0
    128128 *
    129  * @uses bp_get_default_options() To get default options.
    130  * @uses add_option() Adds default options.
    131  * @uses do_action() Calls 'bp_add_options'.
    132129 */
    133130function bp_add_options() {
     
    161158 * @since 1.6.0
    162159 *
    163  * @uses bp_get_default_options() To get default options.
    164  * @uses delete_option() Removes default options.
    165  * @uses do_action() Calls 'bp_delete_options'.
    166160 */
    167161function bp_delete_options() {
     
    192186 * @since 1.6.0
    193187 *
    194  * @uses bp_get_default_options() To get default options.
    195  * @uses add_filter() To add filters to 'pre_option_{$key}'.
    196  * @uses do_action() Calls 'bp_add_option_filters'.
    197188 */
    198189function bp_setup_option_filters() {
     
    253244 *
    254245 * @since 1.2.0
    255  *
    256  * @uses bp_get_root_blog_id()
    257246 *
    258247 * @param string $option_name The option to be retrieved.
     
    299288 * @since 1.5.0
    300289 *
    301  * @uses bp_get_root_blog_id()
    302  *
    303290 * @param string $option_name The option key to be set.
    304291 * @param string $value       The value to be set.
     
    317304 *
    318305 * @since 1.5.0
    319  *
    320  * @uses bp_get_root_blog_id()
    321306 *
    322307 * @param string $option_name The option key to be deleted.
     
    530515 * @since 1.6.0
    531516 *
    532  * @uses bp_get_option() To get the profile sync option.
    533  *
    534517 * @param bool $default Optional. Fallback value if not found in the database.
    535518 *                      Default: true.
     
    552535 *
    553536 * @since 1.6.0
    554  *
    555  * @uses bp_get_option() To get the logged out Toolbar option.
    556537 *
    557538 * @param bool $default Optional. Fallback value if not found in the database.
     
    577558 * @since 1.6.0
    578559 *
    579  * @uses bp_get_option() To get the avatar uploads option.
    580  *
    581560 * @param bool $default Optional. Fallback value if not found in the database.
    582561 *                      Default: true.
     
    599578 *
    600579 * @since 2.4.0
    601  *
    602  * @uses bp_get_option() To get the cover image uploads option.
    603580 *
    604581 * @param bool $default Optional. Fallback value if not found in the database.
     
    657634 * @since 2.4.0
    658635 *
    659  * @uses bp_get_option() To get the group cover image uploads option.
    660  *
    661636 * @param bool $default Optional. Fallback value if not found in the database.
    662637 *                      Default: false.
     
    679654 *
    680655 * @since 1.6.0
    681  *
    682  * @uses bp_get_option() To get the account deletion option.
    683656 *
    684657 * @param bool $default Optional. Fallback value if not found in the database.
     
    705678 *
    706679 * @todo split and move into blog and forum components.
    707  * @uses bp_get_option() To get the blog/forum comments option.
    708680 *
    709681 * @param bool $default Optional. Fallback value if not found in the database.
     
    730702 *
    731703 * @todo Move into groups component.
    732  * @uses bp_get_option() To get the group creation.
    733704 *
    734705 * @param bool $default Optional. Fallback value if not found in the database.
     
    753724 * @since 1.6.0
    754725 *
    755  * @uses bp_get_option() To get the BuddyBar option.
    756  *
    757726 * @param bool $default Optional. Fallback value if not found in the database.
    758727 *                      Default: true.
     
    786755     * @since 1.6.0
    787756     *
    788      * @uses bp_get_option() To get the root forum ID from the database.
    789757     *
    790758     * @param bool|string $default Optional. Default: '0'.
     
    808776 * @since 1.6.0
    809777 *
    810  * @uses bp_get_option() To get the group forums option.
    811  *
    812778 * @param bool $default Optional. Fallback value if not found in the database.
    813779 *                      Default: true.
     
    831797 * @since 1.6.0
    832798 *
    833  * @uses bp_get_option() To get the Akismet option.
    834  *
    835799 * @param bool $default Optional. Fallback value if not found in the database.
    836800 *                      Default: true.
     
    854818 * @since 2.0.0
    855819 *
    856  * @uses bp_get_option() To get the Heartbeat option.
    857  *
    858820 * @param bool $default Optional. Fallback value if not found in the database.
    859821 *                      Default: true.
     
    876838 *
    877839 * @since 1.7.0
    878  *
    879  * @uses get_option() To get the theme package option.
    880840 *
    881841 * @param string $default Optional. Fallback value if not found in the database.
Note: See TracChangeset for help on using the changeset viewer.