Changeset 5951 for trunk/src/includes/admin/tools.php

Timestamp:

10/28/2015 04:07:50 AM (9 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/admin/tools.php (modified) (37 diffs)

trunk/src/includes/admin/tools.php

@@ -16 +16 @@
  * Admin repair page
  *
- * @since bbPress (r2613) Converted from bbPress 1.2
- * @since bbPress (r5885) Upgraded to list-table UI
+ * @since 2.0.0 bbPress (r2613) Converted from bbPress 1.2
+ * @since 2.6.0 bbPress (r5885) Upgraded to list-table UI
  *
  * @todo Use a real list table
@@ -163 +163 @@
  * Handle the processing and feedback of the admin tools page
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses bbp_admin_repair_list() To get the recount list
@@ -223 +223 @@
  * Output the URL to run a specific repair tool
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  *
  * @param string $component
@@ -234 +234 @@
  * Return the URL to run a specific repair tool
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  *
  * @param string $component
@@ -250 +250 @@
  * Contextual help for Repair Forums tools page
  *
- * @since bbPress (r5314)
+ * @since 2.6.0 bbPress (r5314)
+ *
  * @uses get_current_screen()
  */
@@ -288 +289 @@
  * Contextual help for Reset Forums tools page
  *
- * @since bbPress (r5314)
+ * @since 2.6.0 bbPress (r5314)
+ *
  * @uses get_current_screen()
  */
@@ -319 +321 @@
  * Contextual help for Import Forums tools page
  *
- * @since bbPress (r5314)
+ * @since 2.6.0 bbPress (r5314)
+ *
  * @uses get_current_screen()
  */
@@ -378 +381 @@
  * Assemble the admin notices
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @param string|WP_Error $message A message to be displayed or {@link WP_Error}
@@ -432 +435 @@
  * Register an admin area repair tool
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  *
  * @param array $args
@@ -475 +478 @@
  * Register the default repair tools
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  */
 function bbp_register_default_repair_tools() {
@@ -673 +676 @@
  * Get the array of available repair tools
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  *
  * @return array
@@ -707 +710 @@
  * Output the repair list search form
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  */
 function bbp_admin_repair_list_search_form() {
@@ -748 +751 @@
  * Maybe translate a repair tool component name
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  *
  * @param string $component
@@ -780 +783 @@
  * Get the array of the repair list
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses apply_filters() Calls 'bbp_repair_list' with the list array
@@ -837 +840 @@
  * Get filter links for components for a specific admir repair tool
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  *
  * @param array $item
@@ -869 +872 @@
  * Get filter links for components for a specific admir repair tool
  *
- * @since bbPress (r5885)
+ * @since 2.6.0 bbPress (r5885)
  *
  * @param array $args
@@ -952 +955 @@
  * Recount topic replies
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1007 +1010 @@
  * Recount topic voices
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1056 +1059 @@
  * Recount topic hidden replies (spammed/trashed)
  *
- * @since bbPress (r2747)
+ * @since 2.0.0 bbPress (r2747)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1095 +1098 @@
  * Repair group forum ID mappings after a bbPress 1.1 to bbPress 2.2 conversion
  *
- * @since bbPress (r4395)
+ * @since 2.2.0 bbPress (r4395)
  *
  * @uses bbp_get_forum_post_type() To get the forum post type
@@ -1232 +1235 @@
  * Recount forum topics
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1269 +1272 @@
  * Recount forum replies
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1315 +1318 @@
  * Recount topics by the users
  *
- * @since bbPress (r3889)
+ * @since 2.1.0 bbPress (r3889)
  *
  * @uses bbp_get_topic_post_type() To get the topic post type
@@ -1367 +1370 @@
  * Recount topic replied by the users
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses bbp_get_reply_post_type() To get the reply post type
@@ -1419 +1422 @@
  * Clean the users' favorites
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1489 +1492 @@
  * Clean the users' topic subscriptions
  *
- * @since bbPress (r2668)
+ * @since 2.0.0 bbPress (r2668)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1558 +1561 @@
  * Clean the users' forum subscriptions
  *
- * @since bbPress (r5155)
+ * @since 2.5.0 bbPress (r5155)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1629 +1632 @@
  * will be the default role defined in Settings > Forums (Participant).
  *
- * @since bbPress (r4340)
+ * @since 2.2.0 bbPress (r4340)
  *
  * @uses bbp_get_user_role_map() To get the map of user roles
@@ -1686 +1689 @@
  * Recaches the last post in every topic and forum
  *
- * @since bbPress (r3040)
+ * @since 2.0.0 bbPress (r3040)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -1815 +1818 @@
  * Repairs the relationship of sticky topics to the actual parent forum
  *
- * @since bbPress (r4695)
+ * @since 2.3.0 bbPress (r4695)
  *
  * @uses wpdb::get_col() To run our recount sql queries
@@ -1885 +1888 @@
  * https://bbpress.trac.wordpress.org/ticket/2577
  *
- * @since bbPress (r5668)
+ * @since 2.6.0 bbPress (r5668)
  *
  * @uses wpdb::get_col() To run our recount sql queries
@@ -1934 +1937 @@
  * Recaches the private and hidden forums
  *
- * @since bbPress (r4104)
+ * @since 2.2.0 bbPress (r4104)
  *
  * @uses bbp_repair_forum_visibility() To update private and hidden forum ids
@@ -1955 +1958 @@
  * Recaches the parent forum meta for each topic and reply
  *
- * @since bbPress (r3876)
+ * @since 2.1.0 bbPress (r3876)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -2010 +2013 @@
  * Recaches the topic for each post
  *
- * @since bbPress (r3876)
+ * @since 2.1.0 bbPress (r3876)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -2065 +2068 @@
  * Recalculate reply menu order
  *
- * @since bbPress (r5367)
+ * @since 2.5.4 bbPress (r5367)
  *
  * @uses wpdb::query() To run our recount sql queries
@@ -2124 +2127 @@
  * Admin reset page
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses check_admin_referer() To verify the nonce and the referer
@@ -2191 +2194 @@
  * Handle the processing and feedback of the admin tools page
  *
- * @since bbPress (r2613)
+ * @since 2.0.0 bbPress (r2613)
  *
  * @uses check_admin_referer() To verify the nonce and the referer