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

trunk/src/includes/admin/common.php

@@ -67 +67 @@
  *
  * @param array $menu_order Menu Order
- * @uses bbp_get_forum_post_type() To get the forum post type
  * @return array Modified menu order
  */
@@ -125 +124 @@
  * @param bool $sample Optional, defaults to false. Is it a sample permalink.
  *
- * @uses is_admin() To make sure we're on an admin page
- * @uses bbp_is_custom_post_type() To get the forum post type
- *
  * @return string The custom post type permalink
  */
@@ -198 +194 @@
  * @internal Used internally to redirect bbPress to the about page on activation
  *
- * @uses get_transient() To see if transient to redirect exists
- * @uses delete_transient() To delete the transient if it exists
- * @uses is_network_admin() To bail if being network activated
- * @uses bbp_redirect() To redirect
- * @uses add_query_arg() To help build the URL to redirect to
- * @uses admin_url() To get the admin URL to index.php
- *
  * @return If no transient, or in network admin, or is bulk activation
  */