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

trunk/src/includes/admin/admin.php

@@ -17 +17 @@
  * @package bbPress
  * @subpackage Administration
- * @since bbPress (r2464)
+ * @since 2.0.0 bbPress (r2464)
  */
 class BBP_Admin {
@@ -81 +81 @@
          * The main bbPress admin loader
          *
-         * @since bbPress (r2515)
+         * @since 2.0.0 bbPress (r2515)
          *
          * @uses BBP_Admin::setup_globals() Setup the globals needed
@@ -96 +96 @@
          * Admin globals
          *
-         * @since bbPress (r2646)
+         * @since 2.0.0 bbPress (r2646)
+         *
          * @access private
          */
@@ -112 +113 @@
          * Include required files
          *
-         * @since bbPress (r2646)
+         * @since 2.0.0 bbPress (r2646)
+         *
          * @access private
          */
@@ -130 +132 @@
          * Setup the admin hooks, actions and filters
          *
-         * @since bbPress (r2646)
+         * @since 2.0.0 bbPress (r2646)
+         *
          * @access private
          *
@@ -189 +192 @@
          * Add the admin menus
          *
-         * @since bbPress (r2646)
+         * @since 2.0.0 bbPress (r2646)
          *
          * @uses add_management_page() To add the Recount page in Tools section
@@ -297 +300 @@
          * Add the network admin menus
          *
-         * @since bbPress (r3689)
+         * @since 2.1.0 bbPress (r3689)
+         *
          * @uses add_submenu_page() To add the Update Forums page in Updates
          */
@@ -320 +324 @@
          * If this is a new installation, create some initial forum content.
          *
-         * @since bbPress (r3767)
+         * @since 2.1.0 bbPress (r3767)
+         *
          * @return type
          */
@@ -334 +339 @@
          * Register the settings
          *
-         * @since bbPress (r2737)
+         * @since 2.0.0 bbPress (r2737)
          *
          * @uses add_settings_section() To add our own settings section
@@ -393 +398 @@
          * Maps settings capabilities
          *
-         * @since bbPress (r4242)
+         * @since 2.2.0 bbPress (r4242)
          *
          * @param array $caps Capabilities for meta capability
@@ -454 +459 @@
          * Register the importers
          *
-         * @since bbPress (r2737)
+         * @since 2.0.0 bbPress (r2737)
          *
          * @uses apply_filters() Calls 'bbp_importer_path' filter to allow plugins
@@ -493 +498 @@
          * Shows a nag message in admin area about the theme not supporting bbPress
          *
-         * @since bbPress (r2743)
+         * @since 2.0.0 bbPress (r2743)
          *
          * @uses current_user_can() To check notice should be displayed.
@@ -504 +509 @@
          * Add Settings link to plugins area
          *
-         * @since bbPress (r2737)
+         * @since 2.0.0 bbPress (r2737)
          *
          * @param array $links Links array in which we would prepend our link
@@ -537 +542 @@
          * Add a link to bbPress about page to the admin bar
          *
-         * @since bbPress (r5136)
+         * @since 2.5.0 bbPress (r5136)
          *
          * @param WP_Admin_Bar $wp_admin_bar
@@ -555 +560 @@
          * Enqueue any admin scripts we might need
          *
-         * @since bbPress (r4260)
+         * @since 2.2.0 bbPress (r4260)
          */
         public function enqueue_scripts() {
@@ -594 +599 @@
          * Enqueue any admin scripts we might need
          *
-         * @since bbPress (r5224)
+         * @since 2.6.0 bbPress (r5224)
          */
         public function enqueue_styles() {
@@ -610 +615 @@
          * They are grouped together by h2 tabs
          *
-         * @since bbPress (r2464)
+         * @since 2.0.0 bbPress (r2464)
          *
          * @uses remove_submenu_page() To remove menu items with alternat navigation
@@ -629 +634 @@
          * We are including the two most common configurations here, just in case.
          *
-         * @since bbPress (r2521)
+         * @since 2.0.0 bbPress (r2521)
          *
          * @uses wp_admin_css_color() To register the color scheme
@@ -666 +671 @@
          * Hide theme compat package selection if only 1 package is registered
          *
-         * @since bbPress (r4315)
+         * @since 2.2.0 bbPress (r4315)
          *
          * @param array $sections Forums settings sections
@@ -682 +687 @@
          * Allow keymaster role to save Forums settings
          *
-         * @since bbPress (r4678)
+         * @since 2.3.0 bbPress (r4678)
          *
          * @param string $capability
@@ -697 +702 @@
          * Ajax action for facilitating the forum auto-suggest
          *
-         * @since bbPress (r4261)
+         * @since 2.2.0 bbPress (r4261)
          *
          * @uses get_posts()
@@ -737 +742 @@
          * Ajax action for facilitating the topic and reply author auto-suggest
          *
-         * @since bbPress (r5014)
+         * @since 2.4.0 bbPress (r5014)
          */
         public function suggest_user() {
@@ -776 +781 @@
          * Output the about screen
          *
-         * @since bbPress (r4159)
+         * @since 2.2.0 bbPress (r4159)
          */
         public function about_screen() {
@@ -853 +858 @@
          * want to leverage api.wordpress.org eventually.
          *
-         * @since bbPress (r4159)
+         * @since 2.2.0 bbPress (r4159)
          */
         public function credits_screen() {
@@ -956 +961 @@
          * Update all bbPress forums across all sites
          *
-         * @since bbPress (r3689)
+         * @since 2.1.0 bbPress (r3689)
          *
          * @uses get_blog_option()
@@ -1001 +1006 @@
          * Update all bbPress forums across all sites
          *
-         * @since bbPress (r3689)
+         * @since 2.1.0 bbPress (r3689)
          *
          * @uses get_blog_option()
@@ -1115 +1120 @@
  * Setup bbPress Admin
  *
- * @since bbPress (r2596)
+ * @since 2.0.0 bbPress (r2596)
  *
  * @uses BBP_Admin