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

trunk/src/includes/common/shortcodes.php

@@ -15 +15 @@
  * bbPress Shortcode Class
  *
- * @since bbPress (r3031)
+ * @since 2.0.0 bbPress (r3031)
  */
 class BBP_Shortcodes {
@@ -31 +31 @@
          * Add the register_shortcodes action to bbp_init
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @uses setup_globals()
@@ -44 +44 @@
          * Shortcode globals
          *
-         * @since bbPress (r3143)
+         * @since 2.0.0 bbPress (r3143)
+         *
          * @access private
          *
@@ -100 +101 @@
          * Register the bbPress shortcodes
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @uses add_shortcode()
@@ -114 +115 @@
          * Unset some globals in the $bbp object that hold query related info
          *
-         * @since bbPress (r3034)
+         * @since 2.0.0 bbPress (r3034)
          */
         private function unset_globals() {
@@ -145 +146 @@
          * in the correct location in the_content() instead of when it's created.
          *
-         * @since bbPress (r3079)
+         * @since 2.0.0 bbPress (r3079)
          *
          * @param string $query_name
@@ -164 +165 @@
          * Return the contents of the output buffer and flush its contents.
          *
-         * @since bbPress( r3079)
+         * @since 2.0.0 bbPress (r3079)
          *
          * @uses BBP_Shortcodes::unset_globals() Cleans up global values
@@ -187 +188 @@
          * and return to ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @param array $attr
@@ -213 +214 @@
          * and return to ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @param array $attr
@@ -256 +257 @@
          * post/page contents are displayed first.
          *
-         * @since bbPress (r3566)
+         * @since 2.1.0 bbPress (r3566)
          *
          * @uses get_template_part()
@@ -278 +279 @@
          * and return to ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @param array $attr
@@ -310 +311 @@
          * and return to ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @param array $attr
@@ -376 +377 @@
          * <div id="bbpress-forums"></div> which will need to be sorted out later.
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @param array $attr
@@ -431 +432 @@
          * and return to ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @param array $attr
@@ -493 +494 @@
          * post/page contents are displayed first.
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @uses get_template_part()
@@ -515 +516 @@
          * ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3110)
+         * @since 2.0.0 bbPress (r3110)
          *
          * @return string
@@ -543 +544 @@
          * and return to ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3110)
+         * @since 2.0.0 bbPress (r3110)
          *
          * @param array $attr
@@ -582 +583 @@
          * and return to ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3346)
+         * @since 2.0.0 bbPress (r3346)
          *
          * @param array $attr
@@ -610 +611 @@
          * ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r3031)
+         * @since 2.0.0 bbPress (r3031)
          *
          * @param array $attr
@@ -653 +654 @@
          * post/page contents are displayed first.
          *
-         * @since bbPress (r4585)
+         * @since 2.3.0 bbPress (r4585)
          *
          * @uses get_template_part()
@@ -678 +679 @@
          * ensure that post/page contents are displayed first.
          *
-         * @since bbPress (r4579)
+         * @since 2.3.0 bbPress (r4579)
          *
          * @param array $attr
@@ -726 +727 @@
          * Display a login form
          *
-         * @since bbPress (r3302)
+         * @since 2.0.0 bbPress (r3302)
          *
          * @return string
@@ -752 +753 @@
          * Display a register form
          *
-         * @since bbPress (r3302)
+         * @since 2.0.0 bbPress (r3302)
          *
          * @return string
@@ -778 +779 @@
          * Display a lost password form
          *
-         * @since bbPress (r3302)
+         * @since 2.0.0 bbPress (r3302)
          *
          * @return string
@@ -806 +807 @@
          * Display forum statistics
          *
-         * @since bbPress (r4509)
+         * @since 2.3.0 bbPress (r4509)
          *
          * @return shring
@@ -828 +829 @@
          * Display a breadcrumb
          *
-         * @since bbPress (r3302)
+         * @since 2.0.0 bbPress (r3302)
          *
          * @return string
@@ -852 +853 @@
          * Filter the query for the topic index
          *
-         * @since bbPress (r3637)
+         * @since 2.1.0 bbPress (r3637)
          *
          * @param array $args
@@ -867 +868 @@
          * Filter the query for topic tags
          *
-         * @since bbPress (r3637)
+         * @since 2.1.0 bbPress (r3637)
          *
          * @param array $args