Changeset 6573 for trunk/src/includes/core/template-functions.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/template-functions.php (modified) (3 diffs)

trunk/src/includes/core/template-functions.php

@@ -22 +22 @@
  * @param string $slug
  * @param string $name Optional. Default null
- * @uses bbp_locate_template()
- * @uses load_template()
- * @uses get_template_part()
  */
 function bbp_get_template_part( $slug, $name = null ) {
@@ -398 +395 @@
  * @param string $type Filename without extension.
  * @param array $templates An optional list of template candidates
- * @uses bbp_set_theme_compat_templates()
- * @uses bbp_locate_template()
- * @uses bbp_set_theme_compat_template()
  * @return string Full path to file.
  */
@@ -496 +490 @@
  *
  * @param WP_Query $posts_query
- *
- * @uses get_query_var() To get {@link WP_Query} query var
- * @uses get_user_by() To try to get the user by nicename or id
- * @uses get_userdata() to get the user data
- * @uses current_user_can() To check if the current user can edit the user
- * @uses is_user_member_of_blog() To check if user profile page exists
- * @uses WP_Query::set_404() To set a 404 status
- * @uses apply_filters() Calls 'enable_edit_any_user_configuration' with true
- * @uses bbp_get_view_query_args() To get the view query args
- * @uses bbp_get_forum_post_type() To get the forum post type
- * @uses bbp_get_topic_post_type() To get the topic post type
- * @uses bbp_get_reply_post_type() To get the reply post type
- * @uses remove_action() To remove the auto save post revision action
  */
 function bbp_parse_query( $posts_query ) {