Changeset 5951 for trunk/src/includes/core/template-loader.php

Timestamp:

10/28/2015 04:07:50 AM (9 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-loader.php (modified) (23 diffs)

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

@@ -21 +21 @@
  * from being stomped on accident.
  *
- * @since bbPress (r3032)
+ * @since 2.0.0 bbPress (r3032)
  *
  * @param string $template
@@ -121 +121 @@
  * Set the included template
  *
- * @since bbPress (r4975)
+ * @since 2.4.0 bbPress (r4975)
+ *
  * @param mixed $template Default false
  * @return mixed False if empty. Template name if template included
@@ -134 +135 @@
  * Is a bbPress template being included?
  *
- * @since bbPress (r4975)
+ * @since 2.4.0 bbPress (r4975)
+ *
  * @return bool True if yes, false if no
  */
@@ -147 +149 @@
  * functions.php file.
  *
- * @since bbPress (r3732)
+ * @since 2.1.0 bbPress (r3732)
  *
  * @global string $pagenow
@@ -170 +172 @@
  * Get the user profile template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_displayed_user_id()
@@ -191 +193 @@
  * Get the user profile edit template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_displayed_user_id()
@@ -213 +215 @@
  * Get the user favorites template
  *
- * @since bbPress (r4225)
+ * @since 2.2.0 bbPress (r4225)
  *
  * @uses bbp_get_displayed_user_id()
@@ -236 +238 @@
  * Get the user subscriptions template
  *
- * @since bbPress (r4225)
+ * @since 2.2.0 bbPress (r4225)
  *
  * @uses bbp_get_displayed_user_id()
@@ -259 +261 @@
  * Get the view template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_view_id()
@@ -279 +281 @@
  * Get the search template
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @uses bbp_get_query_template()
@@ -295 +297 @@
  * Get the single forum template
  *
- * @since bbPress (r3922)
+ * @since 2.1.0 bbPress (r3922)
  *
  * @uses bbp_get_forum_post_type()
@@ -311 +313 @@
  * Get the forum archive template
  *
- * @since bbPress (r3922)
+ * @since 2.1.0 bbPress (r3922)
  *
  * @uses bbp_get_forum_post_type()
@@ -327 +329 @@
  * Get the forum edit template
  *
- * @since bbPress (r3566)
+ * @since 2.1.0 bbPress (r3566)
  *
  * @uses bbp_get_topic_post_type()
@@ -343 +345 @@
  * Get the single topic template
  *
- * @since bbPress (r3922)
+ * @since 2.1.0 bbPress (r3922)
  *
  * @uses bbp_get_topic_post_type()
@@ -359 +361 @@
  * Get the topic archive template
  *
- * @since bbPress (r3922)
+ * @since 2.1.0 bbPress (r3922)
  *
  * @uses bbp_get_topic_post_type()
@@ -375 +377 @@
  * Get the topic edit template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_topic_post_type()
@@ -391 +393 @@
  * Get the topic split template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_topic_post_type()
@@ -407 +409 @@
  * Get the topic merge template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_topic_post_type()
@@ -423 +425 @@
  * Get the single reply template
  *
- * @since bbPress (r3922)
+ * @since 2.1.0 bbPress (r3922)
  *
  * @uses bbp_get_reply_post_type()
@@ -439 +441 @@
  * Get the reply edit template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_reply_post_type()
@@ -455 +457 @@
  * Get the reply move template
  *
- * @since bbPress (r4521)
+ * @since 2.3.0 bbPress (r4521)
  *
  * @uses bbp_get_reply_post_type()
@@ -471 +473 @@
  * Get the topic template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_topic_tag_tax_id()
@@ -490 +492 @@
  * Get the topic edit template
  *
- * @since bbPress (r3311)
+ * @since 2.0.0 bbPress (r3311)
  *
  * @uses bbp_get_topic_tag_tax_id()