Changeset 5951 for trunk/src/includes/core/update.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/update.php (modified) (10 diffs)

trunk/src/includes/core/update.php

@@ -14 +14 @@
  * If there is no raw DB version, this is the first installation
  *
- * @since bbPress (r3764)
+ * @since 2.1.0 bbPress (r3764)
  *
  * @uses get_option()
@@ -27 +27 @@
  * Compare the bbPress version to the DB version to determine if updating
  *
- * @since bbPress (r3421)
+ * @since 2.0.0 bbPress (r3421)
  *
  * @uses get_option()
@@ -46 +46 @@
  * for third party plugins to use to check for bbPress activation.
  *
- * @since bbPress (r3421)
+ * @since 2.0.0 bbPress (r3421)
  *
  * @return bool True if activating bbPress, false if not
@@ -96 +96 @@
  * Determine if bbPress is being deactivated
  *
- * @since bbPress (r3421)
+ * @since 2.0.0 bbPress (r3421)
+ *
  * @return bool True if deactivating bbPress, false if not
  */
@@ -145 +146 @@
  * Update the DB to the latest version
  *
- * @since bbPress (r3421)
+ * @since 2.0.0 bbPress (r3421)
+ *
  * @uses update_option()
  * @uses bbp_get_db_version() To get bbPress's database version
@@ -156 +158 @@
  * Setup the bbPress updater
  *
- * @since bbPress (r3419)
+ * @since 2.0.0 bbPress (r3419)
  *
  * @uses bbp_version_updater()
@@ -176 +178 @@
  * Create a default forum, topic, and reply
  *
- * @since bbPress (r3767)
+ * @since 2.1.0 bbPress (r3767)
+ *
  * @param array $args Array of arguments to override default values
  */
@@ -247 +250 @@
  * to correct issues with bbPress meta-data silently on software update.
  *
- * @since bbPress (r4104)
+ * @since 2.2.0 bbPress (r4104)
  */
 function bbp_version_updater() {
@@ -309 +312 @@
  * Redirect user to bbPress's What's New page on activation
  *
- * @since bbPress (r4389)
+ * @since 2.2.0 bbPress (r4389)
  *
  * @internal Used internally to redirect bbPress to the about page on activation
@@ -334 +337 @@
  * regardless of the bbp_allow_global_access() setting.
  *
- * @since bbPress (r4910)
+ * @since 2.4.0 bbPress (r4910)
  *
  * @internal Used to internally make the current user a keymaster on activation