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/admin/settings.php

    r6563 r6573  
    645645 *
    646646 * @since 2.0.0 bbPress (r2737)
    647  *
    648  * @uses bbp_form_option() To output the option value
    649647 */
    650648function bbp_admin_setting_callback_editlock() {
    … …  
    672670 *
    673671 * @since 2.0.0 bbPress (r2737)
    674  *
    675  * @uses bbp_form_option() To output the option value
    676672 */
    677673function bbp_admin_setting_callback_throttle() {
    … …  
    699695 *
    700696 * @since 2.0.0 bbPress (r2737)
    701  *
    702  * @uses checked() To display the checked attribute
    703697 */
    704698function bbp_admin_setting_callback_anonymous() {
    … …  
    716710 *
    717711 * @since 2.0.0 bbPress (r3378)
    718  *
    719  * @uses checked() To display the checked attribute
    720712 */
    721713function bbp_admin_setting_callback_global_access() {
    … …  
    768760 *
    769761 * @since 2.0.0 bbPress (r2786)
    770  *
    771  * @uses checked() To display the checked attribute
    772762 */
    773763function bbp_admin_setting_callback_favorites() {
    … …  
    784774 *
    785775 * @since 2.0.0 bbPress (r2737)
    786  *
    787  * @uses checked() To display the checked attribute
    788776 */
    789777function bbp_admin_setting_callback_subscriptions() {
    … …  
    800788 *
    801789 * @since 2.0.0 bbPress (r2737)
    802  *
    803  * @uses checked() To display the checked attribute
    804790 */
    805791function bbp_admin_setting_callback_engagements() {
    … …  
    816802 *
    817803 * @since 2.4.0 bbPress (r4944)
    818  *
    819  * @uses checked() To display the checked attribute
    820804 */
    821805function bbp_admin_setting_callback_topic_tags() {
    … …  
    832816 *
    833817 * @since 2.6.0 bbPress (r5834)
    834  *
    835  * @uses checked() To display the checked attribute
    836818 */
    837819function bbp_admin_setting_callback_forum_mods() {
    … …  
    848830 *
    849831 * @since 2.6.0 bbPress (r6562)
    850  *
    851  * @uses checked() To display the checked attribute
    852832 */
    853833function bbp_admin_setting_callback_super_mods() {
    … …  
    864844 *
    865845 * @since 2.4.0 bbPress (r4970)
    866  *
    867  * @uses checked() To display the checked attribute
    868846 */
    869847function bbp_admin_setting_callback_search() {
    … …  
    882860 *
    883861 * @since 2.4.0 bbPress (r4944)
    884  *
    885  * @uses apply_filters() Calls 'bbp_thread_replies_depth_max' to set a
    886  *                        maximum displayed level
    887  * @uses selected() To display the selected attribute
    888862 */
    889863function bbp_admin_setting_callback_thread_replies_depth() {
    … …  
    920894 *
    921895 * @since 2.0.0 bbPress (r3412)
    922  *
    923  * @uses checked() To display the checked attribute
    924896 */
    925897function bbp_admin_setting_callback_revisions() {
    … …  
    936908 *
    937909 * @since 2.1.0 bbPress (r3586)
    938  *
    939  * @uses checked() To display the checked attribute
    940910 */
    941911function bbp_admin_setting_callback_use_wp_editor() {
    … …  
    965935 *
    966936 * @since 2.1.0 bbPress (r3586)
    967  *
    968  * @uses checked() To display the checked attribute
    969937 */
    970938function bbp_admin_setting_callback_subtheme_id() {
    … …  
    999967 *
    1000968 * @since 2.1.0 bbPress (r3752)
    1001  *
    1002  * @uses checked() To display the checked attribute
    1003969 */
    1004970function bbp_admin_setting_callback_use_autoembed() {
    … …  
    1030996 *
    1031997 * @since 2.0.0 bbPress (r2786)
    1032  *
    1033  * @uses bbp_form_option() To output the option value
    1034998 */
    1035999function bbp_admin_setting_callback_topics_per_page() {
    … …  
    10461010 *
    10471011 * @since 2.0.0 bbPress (r2786)
    1048  *
    1049  * @uses bbp_form_option() To output the option value
    10501012 */
    10511013function bbp_admin_setting_callback_replies_per_page() {
    … …  
    10771039 *
    10781040 * @since 2.0.0 bbPress (r2786)
    1079  *
    1080  * @uses bbp_form_option() To output the option value
    10811041 */
    10821042function bbp_admin_setting_callback_topics_per_rss_page() {
    … …  
    10931053 *
    10941054 * @since 2.0.0 bbPress (r2786)
    1095  *
    1096  * @uses bbp_form_option() To output the option value
    10971055 */
    10981056function bbp_admin_setting_callback_replies_per_rss_page() {
    … …  
    11281086 *
    11291087 * @since 2.0.0 bbPress (r2786)
    1130  *
    1131  * @uses bbp_form_option() To output the option value
    11321088 */
    11331089function bbp_admin_setting_callback_root_slug() {
    … …  
    11451101 *
    11461102 * @since 2.0.0 bbPress (r2786)
    1147  *
    1148  * @uses checked() To display the checked attribute
    11491103 */
    11501104function bbp_admin_setting_callback_include_root() {
    … …  
    11611115 *
    11621116 * @since 2.0.0 bbPress (r2786)
    1163  *
    1164  * @uses checked() To display the checked attribute
    11651117 */
    11661118function bbp_admin_setting_callback_show_on_root() {
    … …  
    12211173 *
    12221174 * @since 2.0.0 bbPress (r2786)
    1223  *
    1224  * @uses bbp_form_option() To output the option value
    12251175 */
    12261176function bbp_admin_setting_callback_user_slug() {
    … …  
    12381188 *
    12391189 * @since 2.0.0 bbPress (r2786)
    1240  *
    1241  * @uses bbp_form_option() To output the option value
    12421190 */
    12431191function bbp_admin_setting_callback_topic_archive_slug() {
    … …  
    12551203 *
    12561204 * @since 2.4.0 bbPress (r4932)
    1257  *
    1258  * @uses bbp_form_option() To output the option value
    12591205 */
    12601206function bbp_admin_setting_callback_reply_archive_slug() {
    … …  
    12721218 *
    12731219 * @since 2.4.0 bbPress (r4932)
    1274  *
    1275  * @uses bbp_form_option() To output the option value
    12761220 */
    12771221function bbp_admin_setting_callback_user_favs_slug() {
    … …  
    12891233 *
    12901234 * @since 2.4.0 bbPress (r4932)
    1291  *
    1292  * @uses bbp_form_option() To output the option value
    12931235 */
    12941236function bbp_admin_setting_callback_user_subs_slug() {
    … …  
    13061248 *
    13071249 * @since 2.6.0 bbPress (r6320)
    1308  *
    1309  * @uses bbp_form_option() To output the option value
    13101250 */
    13111251function bbp_admin_setting_callback_user_engagements_slug() {
    … …  
    13381278 *
    13391279 * @since 2.0.0 bbPress (r2786)
    1340  *
    1341  * @uses bbp_form_option() To output the option value
    13421280 */
    13431281function bbp_admin_setting_callback_forum_slug() {
    … …  
    13551293 *
    13561294 * @since 2.0.0 bbPress (r2786)
    1357  *
    1358  * @uses bbp_form_option() To output the option value
    13591295 */
    13601296function bbp_admin_setting_callback_topic_slug() {
    … …  
    13721308 *
    13731309 * @since 2.0.0 bbPress (r2786)
    1374  *
    1375  * @uses bbp_form_option() To output the option value
    13761310 */
    13771311function bbp_admin_setting_callback_reply_slug() {
    … …  
    13891323 *
    13901324 * @since 2.0.0 bbPress (r2786)
    1391  *
    1392  * @uses bbp_form_option() To output the option value
    13931325 */
    13941326function bbp_admin_setting_callback_topic_tag_slug() {
    … …  
    14071339 *
    14081340 * @since 2.0.0 bbPress (r2789)
    1409  *
    1410  * @uses bbp_form_option() To output the option value
    14111341 */
    14121342function bbp_admin_setting_callback_view_slug() {
    … …  
    14241354 *
    14251355 * @since 2.3.0 bbPress (r4579)
    1426  *
    1427  * @uses bbp_form_option() To output the option value
    14281356 */
    14291357function bbp_admin_setting_callback_search_slug() {
    … …  
    14561384 *
    14571385 * @since 2.1.0 bbPress (r3575)
    1458  *
    1459  * @uses checked() To display the checked attribute
    14601386 */
    14611387function bbp_admin_setting_callback_group_forums() {
    … …  
    14721398 *
    14731399 * @since 2.1.0 bbPress (r3575)
    1474  *
    1475  * @uses bbp_form_option() To output the option value
    14761400 */
    14771401function bbp_admin_setting_callback_group_forums_root_id() {
    … …  
    15421466 *
    15431467 * @since 2.1.0 bbPress (r3575)
    1544  *
    1545  * @uses checked() To display the checked attribute
    15461468 */
    15471469function bbp_admin_setting_callback_akismet() {
    … …  
    15601482 *
    15611483 * @since 2.0.0 bbPress (r2643)
    1562  *
    1563  * @uses settings_fields() To output the hidden fields for the form
    1564  * @uses do_settings_sections() To output the settings sections
    15651484 */
    15661485function bbp_admin_settings() {
    … …  
    15861505}
    15871506
    1588 
    15891507/** Converter Section *********************************************************/
    15901508
    … …  
    18031721 *
    18041722 * @since 2.1.0 bbPress (r3186)
    1805  *
    1806  * @uses settings_fields() To output the hidden fields for the form
    1807  * @uses do_settings_sections() To output the settings sections
    18081723 */
    18091724function bbp_converter_settings_page() {
    … …  
    18771792 *
    18781793 * @since 2.0.0 bbPress (r3119)
    1879  *
    1880  * @uses get_current_screen()
    18811794 */
    18821795function bbp_admin_settings_help() {
    … …  
    19801893 * @since 2.0.0 bbPress (r3203)
    19811894 *
    1982  * @uses bbp_get_bbp_form_option()
    1983  *
    19841895 * @param string $option
    19851896 * @param string $default
    … …  
    19931904     *
    19941905     * @since 2.0.0 bbPress (r3203)
    1995      *
    1996      * @uses get_option()
    1997      * @uses esc_attr()
    1998      * @uses apply_filters()
    19991906     *
    20001907     * @param string $option
    … …  
    20321939 * @param string $slug
    20331940 * @param string $default
    2034  *
    2035  * @uses bbp_get_form_option() To get a sanitized slug string
    20361941 */
    20371942function bbp_form_slug_conflict_check( $slug, $default ) {
Note: See TracChangeset for help on using the changeset viewer.