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

trunk/src/includes/core/template-functions.php

@@ -18 +18 @@
  * Adds bbPress theme support to any active WordPress theme
  *
- * @since bbPress (r3032)
+ * @since 2.0.0 bbPress (r3032)
  *
  * @param string $slug
@@ -52 +52 @@
  * not found in either of those, it looks in the theme-compat folder last.
  *
- * @since bbPress (r3618)
+ * @since 2.1.0 bbPress (r3618)
  *
  * @param string|array $template_names Template file(s) to search for, in order.
@@ -115 +115 @@
  * Registers the style if file provided (does NOT overwrite) and enqueues.
  *
- * @since bbPress (r5180)
+ * @since 2.5.0 bbPress (r5180)
  *
  * @param string      $handle Name of the stylesheet.
@@ -184 +184 @@
  * Registers the style if file provided (does NOT overwrite) and enqueues.
  *
- * @since bbPress (r5180)
+ * @since 2.5.0 bbPress (r5180)
  *
  * @param string      $handle    Name of the script.
@@ -255 +255 @@
  * with bbp_locate_template(), this allows for easy template overrides.
  *
- * @since bbPress (r4323)
+ * @since 2.2.0 bbPress (r4323)
  *
  * @param string $location_callback Callback function that returns the
@@ -274 +274 @@
  * Deregisters a previously registered template stack location.
  *
- * @since bbPress (r4652)
+ * @since 2.3.0 bbPress (r4652)
  *
  * @param string $location_callback Callback function that returns the
@@ -359 +359 @@
  * Get a template part in an output buffer, and return it
  *
- * @since bbPress (r5043)
+ * @since 2.4.0 bbPress (r5043)
  *
  * @param string $slug
@@ -389 +389 @@
  * locations without the use of the other get_*_template() functions.
  *
- * @since bbPress (r3629)
+ * @since 2.1.0 bbPress (r3629)
  *
  * @param string $type Filename without extension.
@@ -418 +418 @@
  * Get the possible subdirectories to check for templates in
  *
- * @since bbPress (r3738)
+ * @since 2.1.0 bbPress (r3738)
+ *
  * @param array $templates Templates we are looking for
  * @return array Possible subfolders to look in
@@ -434 +435 @@
  * Add template locations to template files being searched for
  *
- * @since bbPress (r3738)
+ * @since 2.1.0 bbPress (r3738)
  *
  * @param array $stacks
@@ -472 +473 @@
  * If it's a search page, WP_Query::bbp_is_search is set to true
  *
- * @since bbPress (r2688)
+ * @since 2.0.0 bbPress (r2688)
  *
  * @param WP_Query $posts_query