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

trunk/src/includes/admin/functions.php

@@ -16 +16 @@
  * Add a separator to the WordPress admin menus
  *
- * @since bbPress (r2957)
+ * @since 2.0.0 bbPress (r2957)
  */
 function bbp_admin_separator() {
@@ -48 +48 @@
  * Tell WordPress we have a custom menu order
  *
- * @since bbPress (r2957)
+ * @since 2.0.0 bbPress (r2957)
  *
  * @param bool $menu_order Menu order
@@ -64 +64 @@
  * Move our custom separator above our custom post types
  *
- * @since bbPress (r2957)
+ * @since 2.0.0 bbPress (r2957)
  *
  * @param array $menu_order Menu Order
@@ -118 +118 @@
  * Filter sample permalinks so that certain languages display properly.
  *
- * @since bbPress (r3336)
+ * @since 2.0.0 bbPress (r3336)
  *
  * @param string $post_link Custom post type permalink
@@ -144 +144 @@
  * Sanitize permalink slugs when saving the settings page.
  *
- * @since bbPress (r5364)
+ * @since 2.6.0 bbPress (r5364)
  *
  * @param string $slug
@@ -174 +174 @@
  * Uninstall all bbPress options and capabilities from a specific site.
  *
- * @since bbPress (r3765)
+ * @since 2.1.0 bbPress (r3765)
+ *
  * @param type $site_id
  */
@@ -193 +194 @@
  * 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
@@ -237 +238 @@
  * any third-party plugins.
  *
- * @since bbPress (r3888)
+ * @since 2.1.0 bbPress (r3888)
+ *
  * @global string $plugin_page
  * @global array $submenu_file
@@ -253 +255 @@
  * Output the tabs in the admin area
  *
- * @since bbPress (r3872)
+ * @since 2.1.0 bbPress (r3872)
+ *
  * @param string $active_tab Name of the tab that is active
  */
@@ -263 +266 @@
      * Output the tabs in the admin area
      *
-     * @since bbPress (r3872)
+     * @since 2.1.0 bbPress (r3872)
+     *
      * @param string $active_tab Name of the tab that is active
      */