Changeset 5951 for trunk/src/includes/core/sub-actions.php

Timestamp:

10/28/2015 04:07:50 AM (10 years ago)

Author:

netweb

Message:

Standardize @since PHPDoc tags style and format

• e.g. @since 2.6.0 bbPress (r5951) YOLO
• See ​http://phpdoc.org/docs/latest/references/phpdoc/tags/since.html

This changeset updates the style and formatting of all of our @since instances for compatibility with phpDocumentor 2 and WP-Parser as we move toward implementing the bbPress developer code reference.

Props thebrandonallen
Fixes #2879

File:

• trunk/src/includes/core/sub-actions.php (modified) (38 diffs)

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

@@ -26 +26 @@
  * Runs on bbPress activation
  *
- * @since bbPress (r2509)
+ * @since 2.0.0 bbPress (r2509)
+ *
  * @uses register_uninstall_hook() To register our own uninstall hook
  * @uses do_action() Calls 'bbp_activation' hook
@@ -37 +38 @@
  * Runs on bbPress deactivation
  *
- * @since bbPress (r2509)
+ * @since 2.0.0 bbPress (r2509)
+ *
  * @uses do_action() Calls 'bbp_deactivation' hook
  */
@@ -47 +49 @@
  * Runs when uninstalling bbPress
  *
- * @since bbPress (r2509)
+ * @since 2.0.0 bbPress (r2509)
+ *
  * @uses do_action() Calls 'bbp_uninstall' hook
  */
@@ -59 +62 @@
  * Main action responsible for constants, globals, and includes
  *
- * @since bbPress (r2599)
+ * @since 2.0.0 bbPress (r2599)
+ *
  * @uses do_action() Calls 'bbp_loaded'
  */
@@ -69 +73 @@
  * Setup constants
  *
- * @since bbPress (r2599)
+ * @since 2.0.0 bbPress (r2599)
+ *
  * @uses do_action() Calls 'bbp_constants'
  */
@@ -79 +84 @@
  * Setup globals BEFORE includes
  *
- * @since bbPress (r2599)
+ * @since 2.0.0 bbPress (r2599)
+ *
  * @uses do_action() Calls 'bbp_boot_strap_globals'
  */
@@ -89 +95 @@
  * Include files
  *
- * @since bbPress (r2599)
+ * @since 2.0.0 bbPress (r2599)
+ *
  * @uses do_action() Calls 'bbp_includes'
  */
@@ -99 +106 @@
  * Setup globals AFTER includes
  *
- * @since bbPress (r2599)
+ * @since 2.0.0 bbPress (r2599)
+ *
  * @uses do_action() Calls 'bbp_setup_globals'
  */
@@ -109 +117 @@
  * Register any objects before anything is initialized
  *
- * @since bbPress (r4180)
+ * @since 2.2.0 bbPress (r4180)
+ *
  * @uses do_action() Calls 'bbp_register'
  */
@@ -119 +128 @@
  * Initialize any code after everything has been loaded
  *
- * @since bbPress (r2599)
+ * @since 2.0.0 bbPress (r2599)
+ *
  * @uses do_action() Calls 'bbp_init'
  */
@@ -129 +139 @@
  * Initialize widgets
  *
- * @since bbPress (r3389)
+ * @since 2.0.0 bbPress (r3389)
+ *
  * @uses do_action() Calls 'bbp_widgets_init'
  */
@@ -144 +155 @@
  * @link https://core.trac.wordpress.org/ticket/24169
  *
- * @since bbPress (r2695)
+ * @since 2.0.0 bbPress (r2695)
+ *
  * @uses did_action() To make sure the user isn't loaded out of order
  * @uses do_action() Calls 'bbp_setup_current_user'
@@ -164 +176 @@
  * Load translations for current language
  *
- * @since bbPress (r2599)
+ * @since 2.0.0 bbPress (r2599)
+ *
  * @uses do_action() Calls 'bbp_load_textdomain'
  */
@@ -174 +187 @@
  * Setup the post types
  *
- * @since bbPress (r2464)
+ * @since 2.0.0 bbPress (r2464)
+ *
  * @uses do_action() Calls 'bbp_register_post_type'
  */
@@ -184 +198 @@
  * Setup the post statuses
  *
- * @since bbPress (r2727)
+ * @since 2.0.0 bbPress (r2727)
+ *
  * @uses do_action() Calls 'bbp_register_post_statuses'
  */
@@ -194 +209 @@
  * Register the built in bbPress taxonomies
  *
- * @since bbPress (r2464)
+ * @since 2.0.0 bbPress (r2464)
+ *
  * @uses do_action() Calls 'bbp_register_taxonomies'
  */
@@ -204 +220 @@
  * Register the default bbPress views
  *
- * @since bbPress (r2789)
+ * @since 2.0.0 bbPress (r2789)
+ *
  * @uses do_action() Calls 'bbp_register_views'
  */
@@ -214 +231 @@
  * Register the default bbPress shortcodes
  *
- * @since bbPress (r4211)
+ * @since 2.2.0 bbPress (r4211)
+ *
  * @uses do_action() Calls 'bbp_register_shortcodes'
  */
@@ -224 +242 @@
  * Enqueue bbPress specific CSS and JS
  *
- * @since bbPress (r3373)
+ * @since 2.0.0 bbPress (r3373)
+ *
  * @uses do_action() Calls 'bbp_enqueue_scripts'
  */
@@ -234 +253 @@
  * Add the bbPress-specific rewrite tags
  *
- * @since bbPress (r2753)
+ * @since 2.0.0 bbPress (r2753)
+ *
  * @uses do_action() Calls 'bbp_add_rewrite_tags'
  */
@@ -244 +264 @@
  * Add the bbPress-specific rewrite rules
  *
- * @since bbPress (r4918)
+ * @since 2.4.0 bbPress (r4918)
+ *
  * @uses do_action() Calls 'bbp_add_rewrite_rules'
  */
@@ -254 +275 @@
  * Add the bbPress-specific permalink structures
  *
- * @since bbPress (r4918)
+ * @since 2.4.0 bbPress (r4918)
+ *
  * @uses do_action() Calls 'bbp_add_permastructs'
  */
@@ -264 +286 @@
  * Add the bbPress-specific login forum action
  *
- * @since bbPress (r2753)
+ * @since 2.0.0 bbPress (r2753)
+ *
  * @uses do_action() Calls 'bbp_login_form_login'
  */
@@ -276 +299 @@
  * The main action for hooking into when a user account is updated
  *
- * @since bbPress (r4304)
+ * @since 2.2.0 bbPress (r4304)
  *
  * @param int $user_id ID of user being edited
@@ -289 +312 @@
  * The main action for hooking into a user being registered
  *
- * @since bbPress (r4304)
+ * @since 2.2.0 bbPress (r4304)
+ *
  * @param int $user_id ID of user being edited
  * @uses do_action() Calls 'bbp_user_register'
@@ -302 +326 @@
  * bbPress has loaded and initialized everything, and is okay to go
  *
- * @since bbPress (r2618)
+ * @since 2.0.0 bbPress (r2618)
+ *
  * @uses do_action() Calls 'bbp_ready'
  */
@@ -315 +340 @@
  * permitted by the current_user
  *
- * @since bbPress (r3605)
+ * @since 2.1.0 bbPress (r3605)
+ *
  * @uses do_action()
  */
@@ -327 +353 @@
  * The main action used for executing code before the theme has been setup
  *
- * @since bbPress (r3829)
+ * @since 2.1.0 bbPress (r3829)
+ *
  * @uses do_action()
  */
@@ -337 +364 @@
  * The main action used for executing code before the theme has been setup
  *
- * @since bbPress (r3732)
+ * @since 2.1.0 bbPress (r3732)
+ *
  * @uses do_action()
  */
@@ -347 +375 @@
  * The main action used for executing code after the theme has been setup
  *
- * @since bbPress (r3732)
+ * @since 2.1.0 bbPress (r3732)
+ *
  * @uses do_action()
  */
@@ -357 +386 @@
  * The main action used for handling theme-side POST requests
  *
- * @since bbPress (r4550)
+ * @since 2.3.0 bbPress (r4550)
+ *
  * @uses do_action()
  */
@@ -386 +416 @@
  * The main action used for handling theme-side GET requests
  *
- * @since bbPress (r4550)
+ * @since 2.3.0 bbPress (r4550)
+ *
  * @uses do_action()
  */
@@ -417 +448 @@
  * Filter the plugin locale and domain.
  *
- * @since bbPress (r4213)
+ * @since 2.2.0 bbPress (r4213)
  *
  * @param string $locale
@@ -429 +460 @@
  * Piggy back filter for WordPress's 'request' filter
  *
- * @since bbPress (r3758)
+ * @since 2.1.0 bbPress (r3758)
+ *
  * @param array $query_vars
  * @return array
@@ -441 +473 @@
  * theme files.
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
+ *
  * @uses apply_filters()
  * @param string $template
@@ -453 +486 @@
  * Generate bbPress-specific rewrite rules
  *
- * @since bbPress (r2688)
- * @deprecated since bbPress (r4918)
+ * @since 2.0.0 bbPress (r2688)
+ *
+ * @deprecated 2.4.0 bbPress (r4918)
+ *
  * @param WP_Rewrite $wp_rewrite
  * @uses do_action() Calls 'bbp_generate_rewrite_rules' with {@link WP_Rewrite}
@@ -465 +500 @@
  * Filter the allowed themes list for bbPress specific themes
  *
- * @since bbPress (r2944)
+ * @since 2.0.0 bbPress (r2944)
+ *
  * @uses apply_filters() Calls 'bbp_allowed_themes' with the allowed themes list
  */
@@ -475 +511 @@
  * Maps forum/topic/reply caps to built in WordPress caps
  *
- * @since bbPress (r2593)
+ * @since 2.0.0 bbPress (r2593)
  *
  * @param array $caps Capabilities for meta capability