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/template-loader.php

    r6498 r6573  
    2424 *
    2525 * @param string $template
    26  *
    27  * @uses bbp_is_single_user() To check if page is single user
    28  * @uses bbp_get_single_user_template() To get user template
    29  * @uses bbp_is_single_user_edit() To check if page is single user edit
    30  * @uses bbp_get_single_user_edit_template() To get user edit template
    31  * @uses bbp_is_single_view() To check if page is single view
    32  * @uses bbp_get_single_view_template() To get view template
    33  * @uses bbp_is_search() To check if page is search
    34  * @uses bbp_get_search_template() To get search template
    35  * @uses bbp_is_forum_edit() To check if page is forum edit
    36  * @uses bbp_get_forum_edit_template() To get forum edit template
    37  * @uses bbp_is_topic_merge() To check if page is topic merge
    38  * @uses bbp_get_topic_merge_template() To get topic merge template
    39  * @uses bbp_is_topic_split() To check if page is topic split
    40  * @uses bbp_get_topic_split_template() To get topic split template
    41  * @uses bbp_is_topic_edit() To check if page is topic edit
    42  * @uses bbp_get_topic_edit_template() To get topic edit template
    43  * @uses bbp_is_reply_move() To check if page is reply move
    44  * @uses bbp_get_reply_move_template() To get reply move template
    45  * @uses bbp_is_reply_edit() To check if page is reply edit
    46  * @uses bbp_get_reply_edit_template() To get reply edit template
    47  * @uses bbp_set_theme_compat_template() To set the global theme compat template
    4826 *
    4927 * @return string The path to the template file that is being used
    … …  
    153131 *
    154132 * @global string $pagenow
    155  * @uses bbp_locate_template()
    156133 */
    157134function bbp_load_theme_functions() {
    … …  
    175152 * @since 2.0.0 bbPress (r3311)
    176153 *
    177  * @uses bbp_get_displayed_user_id()
    178  * @uses bbp_get_query_template()
    179154 * @return string Path to template file
    180155 */
    … …  
    196171 * @since 2.0.0 bbPress (r3311)
    197172 *
    198  * @uses bbp_get_displayed_user_id()
    199  * @uses bbp_get_query_template()
    200173 * @return string Path to template file
    201174 */
    … …  
    218191 * @since 2.2.0 bbPress (r4225)
    219192 *
    220  * @uses bbp_get_displayed_user_id()
    221  * @uses bbp_get_query_template()
    222193 * @return string Path to template file
    223194 */
    … …  
    241212 * @since 2.2.0 bbPress (r4225)
    242213 *
    243  * @uses bbp_get_displayed_user_id()
    244  * @uses bbp_get_query_template()
    245214 * @return string Path to template file
    246215 */
    … …  
    264233 * @since 2.0.0 bbPress (r3311)
    265234 *
    266  * @uses bbp_get_view_id()
    267  * @uses bbp_get_query_template()
    268235 * @return string Path to template file
    269236 */
    … …  
    284251 * @since 2.3.0 bbPress (r4579)
    285252 *
    286  * @uses bbp_get_query_template()
    287253 * @return string Path to template file
    288254 */
    … …  
    300266 * @since 2.1.0 bbPress (r3922)
    301267 *
    302  * @uses bbp_get_forum_post_type()
    303  * @uses bbp_get_query_template()
    304268 * @return string Path to template file
    305269 */
    … …  
    316280 * @since 2.1.0 bbPress (r3922)
    317281 *
    318  * @uses bbp_get_forum_post_type()
    319  * @uses bbp_get_query_template()
    320282 * @return string Path to template file
    321283 */
    … …  
    332294 * @since 2.1.0 bbPress (r3566)
    333295 *
    334  * @uses bbp_get_topic_post_type()
    335  * @uses bbp_get_query_template()
    336296 * @return string Path to template file
    337297 */
    … …  
    348308 * @since 2.1.0 bbPress (r3922)
    349309 *
    350  * @uses bbp_get_topic_post_type()
    351  * @uses bbp_get_query_template()
    352310 * @return string Path to template file
    353311 */
    … …  
    364322 * @since 2.1.0 bbPress (r3922)
    365323 *
    366  * @uses bbp_get_topic_post_type()
    367  * @uses bbp_get_query_template()
    368324 * @return string Path to template file
    369325 */
    … …  
    380336 * @since 2.0.0 bbPress (r3311)
    381337 *
    382  * @uses bbp_get_topic_post_type()
    383  * @uses bbp_get_query_template()
    384338 * @return string Path to template file
    385339 */
    … …  
    396350 * @since 2.0.0 bbPress (r3311)
    397351 *
    398  * @uses bbp_get_topic_post_type()
    399  * @uses bbp_get_query_template()
    400352 * @return string Path to template file
    401353 */
    … …  
    412364 * @since 2.0.0 bbPress (r3311)
    413365 *
    414  * @uses bbp_get_topic_post_type()
    415  * @uses bbp_get_query_template()
    416366 * @return string Path to template file
    417367 */
    … …  
    428378 * @since 2.1.0 bbPress (r3922)
    429379 *
    430  * @uses bbp_get_reply_post_type()
    431  * @uses bbp_get_query_template()
    432380 * @return string Path to template file
    433381 */
    … …  
    444392 * @since 2.0.0 bbPress (r3311)
    445393 *
    446  * @uses bbp_get_reply_post_type()
    447  * @uses bbp_get_query_template()
    448394* @return string Path to template file
    449395 */
    … …  
    460406 * @since 2.3.0 bbPress (r4521)
    461407 *
    462  * @uses bbp_get_reply_post_type()
    463  * @uses bbp_get_query_template()
    464408 * @return string Path to template file
    465409 */
    … …  
    476420 * @since 2.0.0 bbPress (r3311)
    477421 *
    478  * @uses bbp_get_topic_tag_tax_id()
    479  * @uses bbp_get_query_template()
    480422 * @return string Path to template file
    481423 */
    … …  
    495437 * @since 2.0.0 bbPress (r3311)
    496438 *
    497  * @uses bbp_get_topic_tag_tax_id()
    498  * @uses bbp_get_query_template()
    499439 * @return string Path to template file
    500440 */
    … …  
    515455 * @since 2.6.0 bbPress (r5950) Added `singular.php` to template stack
    516456 *
    517  * @uses apply_filters()
    518  * @uses bbp_set_theme_compat_templates()
    519  * @uses bbp_get_query_template()
    520457 * @return string Path to template file
    521458 */
Note: See TracChangeset for help on using the changeset viewer.