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

Timestamp:

10/28/2015 04:07:50 AM (11 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/converter.php (modified) (16 diffs)

trunk/src/includes/admin/converter.php

@@ -21 +21 @@
          * The main bbPress Converter loader
          *
-         * @since bbPress (r3813)
+         * @since 2.1.0 bbPress (r3813)
+         *
          * @uses BBP_Converter::includes() Include the required files
          * @uses BBP_Converter::setup_actions() Setup the actions
@@ -59 +60 @@
          * Setup the default actions
          *
-         * @since bbPress (r3813)
+         * @since 2.1.0 bbPress (r3813)
+         *
          * @uses add_action() To add various actions
          */
@@ -77 +79 @@
          * Register the settings
          *
-         * @since bbPress (r3813)
+         * @since 2.1.0 bbPress (r3813)
+         *
          * @uses add_settings_section() To add our own settings section
          * @uses add_settings_field() To add various settings fields
@@ -142 +145 @@
          * Admin scripts
          *
-         * @since bbPress (r3813)
+         * @since 2.1.0 bbPress (r3813)
          */
         public function admin_head() { ?>
@@ -279 +282 @@
          * Wrap the converter output in paragraph tags, so styling can be applied
          *
-         * @since bbPress (r4052)
+         * @since 2.1.0 bbPress (r4052)
          *
          * @param string $output
@@ -300 +303 @@
          * Callback processor
          *
-         * @since bbPress (r3813)
+         * @since 2.1.0 bbPress (r3813)
          */
         public function process_callback() {
@@ -627 +630 @@
          * Create Tables for fast syncing
          *
-         * @since bbPress (r3813)
+         * @since 2.1.0 bbPress (r3813)
          */
         public function sync_table( $drop = false ) {
@@ -666 +669 @@
  * Base class to be extended by specific individual importers
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 abstract class BBP_Converter_Base {
@@ -1274 +1277 @@
          * This method converts old topic stickies to new bbPress stickies.
          *
-         * @since bbPress (r5170)
+         * @since 2.5.0 bbPress (r5170)
          *
          * @uses WPDB $wpdb
@@ -1305 +1308 @@
          * This method converts old topic super stickies to new bbPress super stickies.
          *
-         * @since bbPress (r5170)
+         * @since 2.5.0 bbPress (r5170)
          *
          * @uses WPDB $wpdb
@@ -1337 +1340 @@
          * This method converts old closed topics to bbPress closed topics.
          *
-         * @since bbPress (r5425)
+         * @since 2.6.0 bbPress (r5425)
          *
          * @uses bbp_close_topic() to close topics properly
@@ -1367 +1370 @@
          * This method converts old reply_to post id to new bbPress reply_to post id.
          *
-         * @since  bbPress (r5093)
+         * @since 2.4.0 bbPress (r5093)
          */
         public function convert_reply_to_parents( $start ) {
@@ -1395 +1398 @@
          * This method converts anonymous topics.
          *
-         * @since  bbPress (r5538)
+         * @since 2.6.0 bbPress (r5538)
          *
          * @uses add_post_meta() To add _bbp_anonymous_name topic meta key
@@ -1441 +1444 @@
          * This method converts anonymous replies.
          *
-         * @since  bbPress (r5538)
+         * @since 2.6.0 bbPress (r5538)
          *
          * @uses add_post_meta() To add _bbp_anonymous_name reply meta key
@@ -1673 +1676 @@
          * A mini cache system to reduce database calls to reply_to post id.
          *
-         * @since  bbPress (r5093)
+         * @since 2.4.0 bbPress (r5093)
          *
          * @param string $field
@@ -1725 +1728 @@
          * Check if the topic or reply author is anonymous
          *
-         * @since  (r5544)
+         * @since 2.6.0 bbPress (r5544)
          *
          * @param  string $field