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

trunk/src/includes/common/classes.php

@@ -23 +23 @@
  * @subpackage Classes
  *
- * @since bbPress (r2688)
+ * @since 2.0.0 bbPress (r2688)
  */
 class BBP_Component {
@@ -59 +59 @@
      * bbPress Component loader
      *
-     * @since bbPress (r2700)
+     * @since 2.0.0 bbPress (r2700)
      *
      * @param array $args Required. Supports these args:
@@ -84 +84 @@
      * Component global variables
      *
-     * @since bbPress (r2700)
+     * @since 2.0.0 bbPress (r2700)
+     *
      * @access private
      *
@@ -99 +100 @@
      * Include required files
      *
-     * @since bbPress (r2700)
+     * @since 2.0.0 bbPress (r2700)
+     *
      * @access private
      *
@@ -111 +113 @@
      * Setup the actions
      *
-     * @since bbPress (r2700)
+     * @since 2.0.0 bbPress (r2700)
+     *
      * @access private
      *
@@ -131 +134 @@
      * Setup the component post types
      *
-     * @since bbPress (r2700)
+     * @since 2.0.0 bbPress (r2700)
      *
      * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_register_post_types'
@@ -142 +145 @@
      * Register component specific taxonomies
      *
-     * @since bbPress (r2700)
+     * @since 2.0.0 bbPress (r2700)
      *
      * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_register_taxonomies'
@@ -153 +156 @@
      * Add any additional rewrite tags
      *
-     * @since bbPress (r2700)
+     * @since 2.0.0 bbPress (r2700)
      *
      * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_add_rewrite_tags'
@@ -164 +167 @@
      * Generate any additional rewrite rules
      *
-     * @since bbPress (r2700)
+     * @since 2.0.0 bbPress (r2700)
      *
      * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_generate_rewrite_rules'
@@ -181 +184 @@
  * @subpackage Classes
  *
- * @since bbPress (r2746)
+ * @since 2.0.0 bbPress (r2746)
+ *
  * @uses Walker
  */
@@ -189 +193 @@
      * @see Walker::$tree_type
      *
-     * @since bbPress (r2746)
+     * @since 2.0.0 bbPress (r2746)
      *
      * @var string
@@ -198 +202 @@
      * @see Walker::$db_fields
      *
-     * @since bbPress (r2746)
+     * @since 2.0.0 bbPress (r2746)
      *
      * @var array
@@ -212 +216 @@
      * Set the tree_type
      *
-     * @since bbPress (r2746)
+     * @since 2.0.0 bbPress (r2746)
      */
     public function __construct() {
@@ -221 +225 @@
      * @see Walker::start_el()
      *
-     * @since bbPress (r2746)
+     * @since 2.0.0 bbPress (r2746)
      *
      * @param string $output Passed by reference. Used to append additional
@@ -272 +276 @@
  * @subpackage Classes
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  */
 class BBP_Walker_Reply extends Walker {
@@ -279 +283 @@
      * @see Walker::$tree_type
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @var string
@@ -288 +292 @@
      * @see Walker::$db_fields
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @var array
@@ -300 +304 @@
      * Confirm the tree_type
      *
-     * @since bbPress (r5389)
+     * @since 2.6.0 bbPress (r5389)
      */
     public function __construct() {
@@ -309 +313 @@
      * @see Walker::start_lvl()
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @param string $output Passed by reference. Used to append additional content
@@ -334 +338 @@
      * @see Walker::end_lvl()
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @param string $output Passed by reference. Used to append additional content
@@ -357 +361 @@
 
     /**
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      */
     public function display_element( $element = false, &$children_elements = array(), $max_depth = 0, $depth = 0, $args = array(), &$output = '' ) {
@@ -385 +389 @@
      * @see Walker:start_el()
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      */
     public function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {
@@ -412 +416 @@
 
     /**
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      */
     public function end_el( &$output = '', $object = false, $depth = 0, $args = array() ) {
@@ -437 +441 @@
  * @subpackage Classes
  *
- * @since bbPress (r5389)
+ * @since 2.6.0 bbPress (r5389)
+ *
  * @uses Walker
  */
@@ -445 +450 @@
      * @see Walker::$tree_type
      *
-     * @since bbPress (r5389)
+     * @since 2.6.0 bbPress (r5389)
      *
      * @var string
@@ -454 +459 @@
      * @see Walker::$db_fields
      *
-     * @since bbPress (r5389)
+     * @since 2.6.0 bbPress (r5389)
      *
      * @var array
@@ -468 +473 @@
      * Confirm the tree_type
      *
-     * @since bbPress (r5389)
+     * @since 2.6.0 bbPress (r5389)
      */
     public function __construct() {
@@ -477 +482 @@
      * @see Walker::start_el()
      *
-     * @since bbPress (r5389)
+     * @since 2.6.0 bbPress (r5389)
      *
      * @param string $output Passed by reference. Used to append additional