Changeset 5951 for trunk/src/includes/core/theme-compat.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/core/theme-compat.php (modified) (23 diffs)

trunk/src/includes/core/theme-compat.php

@@ -32 +32 @@
  * extending this class, as is @link bbp_setup_theme_compat()
  *
- * @since bbPress (r3506)
+ * @since 2.0.0 bbPress (r3506)
  */
 class BBP_Theme_Compat {
@@ -53 +53 @@
      * Pass the $properties to the object on creation.
      *
-     * @since bbPress (r3926)
+     * @since 2.1.0 bbPress (r3926)
+     *
      * @param array $properties
      */
@@ -63 +64 @@
      * Set a theme's property.
      *
-     * @since bbPress (r3926)
+     * @since 2.1.0 bbPress (r3926)
+     *
      * @param string $property
      * @param mixed $value
@@ -75 +77 @@
      * Get a theme's property.
      *
-     * @since bbPress (r3926)
+     * @since 2.1.0 bbPress (r3926)
+     *
      * @param string $property
      * @param mixed $value
@@ -92 +95 @@
  * Setup the default theme compat theme
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
+ *
  * @param BBP_Theme_Compat $theme
  */
@@ -116 +120 @@
  * default and include their own bbPress compatibility layers for their themes.
  *
- * @since bbPress (r3506)
+ * @since 2.0.0 bbPress (r3506)
+ *
  * @uses apply_filters()
  * @return string
@@ -130 +135 @@
  * default and include their own bbPress compatibility layers for their themes.
  *
- * @since bbPress (r3506)
+ * @since 2.0.0 bbPress (r3506)
+ *
  * @uses apply_filters()
  * @return string
@@ -144 +150 @@
  * default and include their own bbPress compatibility layers for their themes.
  *
- * @since bbPress (r3506)
+ * @since 2.0.0 bbPress (r3506)
+ *
  * @uses apply_filters()
  * @return string
@@ -158 +165 @@
  * their own bbPress compatibility layers for their themes.
  *
- * @since bbPress (r3032)
+ * @since 2.0.0 bbPress (r3032)
+ *
  * @uses apply_filters()
  * @return string
@@ -172 +180 @@
  * their own bbPress compatibility layers for their themes.
  *
- * @since bbPress (r3032)
+ * @since 2.0.0 bbPress (r3032)
+ *
  * @uses apply_filters()
  * @return string
@@ -183 +192 @@
  * Gets true/false if page is currently inside theme compatibility
  *
- * @since bbPress (r3265)
+ * @since 2.0.0 bbPress (r3265)
+ *
  * @return bool
  */
@@ -199 +209 @@
  * Sets true/false if page is currently inside theme compatibility
  *
- * @since bbPress (r3265)
+ * @since 2.0.0 bbPress (r3265)
+ *
  * @param bool $set
  * @return bool
@@ -215 +226 @@
  * to override them, or see what files are being scanned for inclusion.
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  */
 function bbp_set_theme_compat_templates( $templates = array() ) {
@@ -229 +240 @@
  * to override it, or see what file is being included.
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  */
 function bbp_set_theme_compat_template( $template = '' ) {
@@ -243 +254 @@
  * if bbPress was able to find a more appropriate template.
  *
- * @since bbPress (r3926)
+ * @since 2.1.0 bbPress (r3926)
  */
 function bbp_set_theme_compat_original_template( $template = '' ) {
@@ -257 +268 @@
  * if bbPress was able to find a more appropriate template.
  *
- * @since bbPress (r3926)
+ * @since 2.1.0 bbPress (r3926)
  */
 function bbp_is_theme_compat_original_template( $template = '' ) {
@@ -272 +283 @@
  * Register a new bbPress theme package to the active theme packages array
  *
- * @since bbPress (r3829)
+ * @since 2.1.0 bbPress (r3829)
+ *
  * @param array $theme
  */
@@ -299 +311 @@
  * stop your average page template from complaining about it missing.
  *
- * @since bbPress (r3108)
+ * @since 2.0.0 bbPress (r3108)
+ *
  * @global WP_Query $wp_query
  * @global object $post
@@ -420 +433 @@
  * template part as needed.
  *
- * @since bbPress (r3032)
+ * @since 2.0.0 bbPress (r3032)
+ *
  * @param string $template
  * @uses bbp_is_single_user() To check if page is single user
@@ -805 +819 @@
  * Remove the canonical redirect to allow pretty pagination
  *
- * @since bbPress (r2628)
+ * @since 2.0.0 bbPress (r2628)
  *
  * @param string $redirect_url Redirect url
@@ -863 +877 @@
  * global in the event they need to be restored later.
  *
- * @since bbPress (r3251)
+ * @since 2.0.0 bbPress (r3251)
+ *
  * @global WP_filter $wp_filter
  * @global array $merged_filters
@@ -915 +930 @@
  * bbp_remove_all_filters()
  *
- * @since bbPress (r3251)
+ * @since 2.0.0 bbPress (r3251)
+ *
  * @global WP_filter $wp_filter
  * @global array $merged_filters
@@ -966 +982 @@
  * Force comments_status to 'closed' for bbPress post types
  *
- * @since bbPress (r3589)
+ * @since 2.1.0 bbPress (r3589)
+ *
  * @param bool $open True if open, false if closed
  * @param int $post_id ID of the post to check