Changeset 6573 for trunk/src/includes/core/theme-compat.php

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:

• trunk/src/includes/core/theme-compat.php (modified) (7 diffs)

trunk/src/includes/core/theme-compat.php

@@ -158 +158 @@
  * @since 2.0.0 bbPress (r3506)
  *
- * @uses apply_filters()
  * @return string
  */
@@ -175 +174 @@
  * @since 2.0.0 bbPress (r3506)
  *
- * @uses apply_filters()
  * @return string
  */
@@ -192 +190 @@
  * @since 2.0.0 bbPress (r3506)
  *
- * @uses apply_filters()
  * @return string
  */
@@ -209 +206 @@
  * @since 2.0.0 bbPress (r3032)
  *
- * @uses apply_filters()
  * @return string
  */
@@ -226 +222 @@
  * @since 2.0.0 bbPress (r3032)
  *
- * @uses apply_filters()
  * @return string
  */
@@ -484 +479 @@
  *
  * @param string $template
- * @uses bbp_is_single_user() To check if page is single user
- * @uses bbp_get_single_user_template() To get user template
- * @uses bbp_is_single_user_edit() To check if page is single user edit
- * @uses bbp_get_single_user_edit_template() To get user edit template
- * @uses bbp_is_single_view() To check if page is single view
- * @uses bbp_get_single_view_template() To get view template
- * @uses bbp_is_search() To check if page is search
- * @uses bbp_get_search_template() To get search template
- * @uses bbp_is_forum_edit() To check if page is forum edit
- * @uses bbp_get_forum_edit_template() To get forum edit template
- * @uses bbp_is_topic_merge() To check if page is topic merge
- * @uses bbp_get_topic_merge_template() To get topic merge template
- * @uses bbp_is_topic_split() To check if page is topic split
- * @uses bbp_get_topic_split_template() To get topic split template
- * @uses bbp_is_topic_edit() To check if page is topic edit
- * @uses bbp_get_topic_edit_template() To get topic edit template
- * @uses bbp_is_reply_move() To check if page is reply move
- * @uses bbp_get_reply_move_template() To get reply move template
- * @uses bbp_is_reply_edit() To check if page is reply edit
- * @uses bbp_get_reply_edit_template() To get reply edit template
- * @uses bbp_set_theme_compat_template() To set the global theme compat template
  */
 function bbp_template_include_theme_compat( $template = '' ) {
@@ -884 +858 @@
  *
  * @param string $redirect_url Redirect url
- * @uses bbp_use_pretty_urls() To check if the blog is using permalinks
- * @uses bbp_get_paged() To get the current page number
- * @uses bbp_is_single_topic() To check if it's a topic page
- * @uses bbp_is_single_forum() To check if it's a forum page
  *
  * @return bool|string False if it's a topic/forum and their first page,