Changeset 6573 for trunk/src/includes/core/sub-actions.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/sub-actions.php (modified) (39 diffs)

trunk/src/includes/core/sub-actions.php

@@ -8 +8 @@
  * own in a safe and reliable way.
  *
- * We do this in bbPress by mirroring existing WordPress hookss in many places
+ * We do this in bbPress by mirroring existing WordPress hooks in many places
  * allowing dependant plugins to hook into the bbPress specific ones, thus
  * guaranteeing proper code execution only when bbPress is active.
  *
- * The following functions are wrappers for hookss, allowing them to be
+ * The following functions are wrappers for hooks, allowing them to be
  * manually called and/or piggy-backed on top of other hooks if needed.
  *
@@ -18 +18 @@
  * @subpackage Core
  *
- * @todo use anonymous functions when PHP minimun requirement allows (5.3)
+ * @todo use anonymous functions when PHP minimum requirement allows (5.3)
  */
 
@@ -27 +27 @@
  *
  * @since 2.0.0 bbPress (r2509)
- *
- * @uses register_uninstall_hook() To register our own uninstall hook
- * @uses do_action() Calls 'bbp_activation' hook
  */
 function bbp_activation() {
@@ -39 +36 @@
  *
  * @since 2.0.0 bbPress (r2509)
- *
- * @uses do_action() Calls 'bbp_deactivation' hook
  */
 function bbp_deactivation() {
@@ -50 +45 @@
  *
  * @since 2.0.0 bbPress (r2509)
- *
- * @uses do_action() Calls 'bbp_uninstall' hook
  */
 function bbp_uninstall() {
@@ -63 +56 @@
  *
  * @since 2.0.0 bbPress (r2599)
- *
- * @uses do_action() Calls 'bbp_loaded'
  */
 function bbp_loaded() {
@@ -74 +65 @@
  *
  * @since 2.0.0 bbPress (r2599)
- *
- * @uses do_action() Calls 'bbp_constants'
  */
 function bbp_constants() {
@@ -85 +74 @@
  *
  * @since 2.0.0 bbPress (r2599)
- *
- * @uses do_action() Calls 'bbp_boot_strap_globals'
  */
 function bbp_boot_strap_globals() {
@@ -96 +83 @@
  *
  * @since 2.0.0 bbPress (r2599)
- *
- * @uses do_action() Calls 'bbp_includes'
  */
 function bbp_includes() {
@@ -107 +92 @@
  *
  * @since 2.0.0 bbPress (r2599)
- *
- * @uses do_action() Calls 'bbp_setup_globals'
  */
 function bbp_setup_globals() {
@@ -118 +101 @@
  *
  * @since 2.2.0 bbPress (r4180)
- *
- * @uses do_action() Calls 'bbp_register'
  */
 function bbp_register() {
@@ -129 +110 @@
  *
  * @since 2.0.0 bbPress (r2599)
- *
- * @uses do_action() Calls 'bbp_init'
  */
 function bbp_init() {
@@ -141 +120 @@
  * @since 2.6.0 bbPress (r6106)
  *
- * @uses do_action() Calls 'bbp_roles_init'
- *
  * @param WP_Roles $wp_roles The array of WP_Role objects that was initialized
  */
@@ -153 +130 @@
  *
  * @since 2.0.0 bbPress (r3389)
- *
- * @uses do_action() Calls 'bbp_widgets_init'
  */
 function bbp_widgets_init() {
@@ -167 +142 @@
  *
  * @since 2.0.0 bbPress (r2695)
- *
- * @uses do_action() Calls 'bbp_setup_current_user'
  */
 function bbp_setup_current_user() {
@@ -180 +153 @@
  *
  * @since 2.0.0 bbPress (r2599)
- *
- * @uses do_action() Calls 'bbp_load_textdomain'
  */
 function bbp_load_textdomain() {
@@ -191 +162 @@
  *
  * @since 2.0.0 bbPress (r2464)
- *
- * @uses do_action() Calls 'bbp_register_post_type'
  */
 function bbp_register_post_types() {
@@ -202 +171 @@
  *
  * @since 2.0.0 bbPress (r2727)
- *
- * @uses do_action() Calls 'bbp_register_post_statuses'
  */
 function bbp_register_post_statuses() {
@@ -213 +180 @@
  *
  * @since 2.0.0 bbPress (r2464)
- *
- * @uses do_action() Calls 'bbp_register_taxonomies'
  */
 function bbp_register_taxonomies() {
@@ -224 +189 @@
  *
  * @since 2.0.0 bbPress (r2789)
- *
- * @uses do_action() Calls 'bbp_register_views'
  */
 function bbp_register_views() {
@@ -235 +198 @@
  *
  * @since 2.2.0 bbPress (r4211)
- *
- * @uses do_action() Calls 'bbp_register_shortcodes'
  */
 function bbp_register_shortcodes() {
@@ -246 +207 @@
  *
  * @since 2.6.0 bbPress (r46300)
- *
- * @uses do_action() Calls 'bbp_register_meta'
  */
 function bbp_register_meta() {
@@ -257 +216 @@
  *
  * @since 2.0.0 bbPress (r3373)
- *
- * @uses do_action() Calls 'bbp_enqueue_scripts'
  */
 function bbp_enqueue_scripts() {
@@ -268 +225 @@
  *
  * @since 2.0.0 bbPress (r2753)
- *
- * @uses do_action() Calls 'bbp_add_rewrite_tags'
  */
 function bbp_add_rewrite_tags() {
@@ -279 +234 @@
  *
  * @since 2.4.0 bbPress (r4918)
- *
- * @uses do_action() Calls 'bbp_add_rewrite_rules'
  */
 function bbp_add_rewrite_rules() {
@@ -290 +243 @@
  *
  * @since 2.4.0 bbPress (r4918)
- *
- * @uses do_action() Calls 'bbp_add_permastructs'
  */
 function bbp_add_permastructs() {
@@ -301 +252 @@
  *
  * @since 2.0.0 bbPress (r2753)
- *
- * @uses do_action() Calls 'bbp_login_form_login'
  */
 function bbp_login_form_login() {
@@ -317 +266 @@
  * @param int $user_id ID of user being edited
  * @param array $old_user_data The old, unmodified user data
- * @uses do_action() Calls 'bbp_profile_update'
  */
 function bbp_profile_update( $user_id = 0, $old_user_data = array() ) {
@@ -329 +277 @@
  *
  * @param int $user_id ID of user being edited
- * @uses do_action() Calls 'bbp_user_register'
  */
 function bbp_user_register( $user_id = 0 ) {
@@ -341 +288 @@
  *
  * @since 2.0.0 bbPress (r2618)
- *
- * @uses do_action() Calls 'bbp_ready'
  */
 function bbp_ready() {
@@ -355 +300 @@
  *
  * @since 2.1.0 bbPress (r3605)
- *
- * @uses do_action()
  */
 function bbp_template_redirect() {
@@ -368 +311 @@
  *
  * @since 2.1.0 bbPress (r3829)
- *
- * @uses do_action()
  */
 function bbp_register_theme_packages() {
@@ -379 +320 @@
  *
  * @since 2.1.0 bbPress (r3732)
- *
- * @uses do_action()
  */
 function bbp_setup_theme() {
@@ -390 +329 @@
  *
  * @since 2.1.0 bbPress (r3732)
- *
- * @uses do_action()
  */
 function bbp_after_setup_theme() {
@@ -401 +338 @@
  *
  * @since 2.3.0 bbPress (r4550)
- *
- * @uses do_action()
  */
 function bbp_post_request() {
@@ -431 +366 @@
  *
  * @since 2.3.0 bbPress (r4550)
- *
- * @uses do_action()
  */
 function bbp_get_request() {
@@ -493 +426 @@
  * @since 2.0.0 bbPress (r3311)
  *
- * @uses apply_filters()
  * @param string $template
  * @return string Template file to use
@@ -511 +443 @@
  *
  * @param WP_Rewrite $wp_rewrite
- * @uses do_action() Calls 'bbp_generate_rewrite_rules' with {@link WP_Rewrite}
  */
 function bbp_generate_rewrite_rules( $wp_rewrite ) {
@@ -523 +454 @@
  *
  * @param array $themes
- * @uses apply_filters() Calls 'bbp_allowed_themes' with the allowed themes list
  *
  * @return array Array of allowed themes