Changeset 5951 for trunk/src/includes/admin/forums.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/admin/forums.php (modified) (18 diffs)

trunk/src/includes/admin/forums.php

@@ -17 +17 @@
  * @package bbPress
  * @subpackage Administration
- * @since bbPress (r2464)
+ * @since 2.0.0 bbPress (r2464)
  */
 class BBP_Forums_Admin {
@@ -33 +33 @@
      * The main bbPress forums admin loader
      *
-     * @since bbPress (r2515)
+     * @since 2.0.0 bbPress (r2515)
      *
      * @uses BBP_Forums_Admin::setup_globals() Setup the globals needed
@@ -47 +47 @@
      * Setup the admin hooks, actions and filters
      *
-     * @since bbPress (r2646)
+     * @since 2.0.0 bbPress (r2646)
+     *
      * @access private
      *
@@ -91 +92 @@
      * Should we bail out of this method?
      *
-     * @since bbPress (r4067)
+     * @since 2.1.0 bbPress (r4067)
+     *
      * @return boolean
      */
@@ -105 +107 @@
      * Admin globals
      *
-     * @since bbPress (r2646)
+     * @since 2.0.0 bbPress (r2646)
+     *
      * @access private
      */
@@ -117 +120 @@
      * Contextual help for bbPress forum edit page
      *
-     * @since bbPress (r3119)
+     * @since 2.0.0 bbPress (r3119)
+     *
      * @uses get_current_screen()
      */
@@ -180 +184 @@
      * Contextual help for bbPress forum edit page
      *
-     * @since bbPress (r3119)
+     * @since 2.0.0 bbPress (r3119)
+     *
      * @uses get_current_screen()
      */
@@ -241 +246 @@
      * Add the forum attributes metabox
      *
-     * @since bbPress (r2746)
+     * @since 2.0.0 bbPress (r2746)
      *
      * @uses bbp_get_forum_post_type() To get the forum post type
@@ -268 +273 @@
      * Return user nicename suggestions instead of tag suggestions
      *
-     * @since bbPress (r5834)
+     * @since 2.6.0 bbPress (r5834)
      *
      * @uses bbp_get_forum_mod_tax_id() To get the forum moderator taxonomy id
@@ -341 +346 @@
      * Pass the forum attributes for processing
      *
-     * @since bbPress (r2746)
+     * @since 2.0.0 bbPress (r2746)
      *
      * @param int $forum_id Forum id
@@ -408 +413 @@
      * Add some general styling to the admin area
      *
-     * @since bbPress (r2464)
+     * @since 2.0.0 bbPress (r2464)
      *
      * @uses bbp_get_forum_post_type() To get the forum post type
@@ -491 +496 @@
      * Handles the admin-side opening/closing of forums
      *
-     * @since bbPress (r5254)
+     * @since 2.6.0 bbPress (r5254)
      *
      * @uses bbp_get_forum() To get the forum
@@ -567 +572 @@
      * {@link BBP_Admin::toggle_forum()}
      *
-     * @since bbPress (r5254)
+     * @since 2.6.0 bbPress (r5254)
      *
      * @uses bbp_get_forum() To get the forum
@@ -630 +635 @@
      * Manage the column headers for the forums page
      *
-     * @since bbPress (r2485)
+     * @since 2.0.0 bbPress (r2485)
      *
      * @param array $columns The columns
@@ -666 +671 @@
      * Print extra columns for the forums page
      *
-     * @since bbPress (r2485)
+     * @since 2.0.0 bbPress (r2485)
      *
      * @param string $column Column
@@ -733 +738 @@
      * the forum title and add the open/close links
      *
-     * @since bbPress (r2577)
+     * @since 2.0.0 bbPress (r2577)
      *
      * @param array $actions Actions
@@ -777 +782 @@
      * Custom user feedback messages for forum post type
      *
-     * @since bbPress (r3080)
+     * @since 2.0.0 bbPress (r3080)
      *
      * @global int $post_ID
@@ -855 +860 @@
  * It could use dependency injection in the future, but for now this is easier.
  *
- * @since bbPress (r2596)
+ * @since 2.0.0 bbPress (r2596)
  *
  * @uses BBP_Forums_Admin