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

trunk/src/includes/search/template.php

@@ -16 +16 @@
  * The main search loop. WordPress does the heavy lifting.
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @param array $args All the arguments supported by {@link WP_Query}
@@ -167 +167 @@
  * Whether there are more search results available in the loop
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @uses WP_Query bbPress::search_query::have_posts() To check if there are more
@@ -189 +189 @@
  * Loads up the current search result in the loop
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @uses WP_Query bbPress::search_query::the_post() To get the current search result
@@ -208 +208 @@
  * Output the search page title
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @uses bbp_get_search_title()
@@ -219 +219 @@
      * Get the search page title
      *
-     * @since bbPress (r4579)
+     * @since 2.3.0 bbPress (r4579)
      *
      * @uses bbp_get_search_terms()
@@ -243 +243 @@
  * Output the search url
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @uses bbp_get_search_url() To get the search url
@@ -253 +253 @@
      * Return the search url
      *
-     * @since bbPress (r4579)
+     * @since 2.3.0 bbPress (r4579)
      *
      * @uses user_trailingslashit() To fix slashes
@@ -283 +283 @@
  * Output the search results url
  *
- * @since bbPress (r4928)
+ * @since 2.4.0 bbPress (r4928)
  *
  * @uses bbp_get_search_url() To get the search url
@@ -293 +293 @@
      * Return the search url
      *
-     * @since bbPress (r4928)
+     * @since 2.4.0 bbPress (r4928)
      *
      * @uses user_trailingslashit() To fix slashes
@@ -335 +335 @@
  * Output the search terms
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @param string $search_terms Optional. Search terms
@@ -347 +347 @@
      * Get the search terms
      *
-     * @since bbPress (r4579)
+     * @since 2.3.0 bbPress (r4579)
      *
      * If search terms are supplied, those are used. Otherwise check the
@@ -377 +377 @@
  * Output the search result pagination count
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @uses bbp_get_search_pagination_count() To get the search result pagination count
@@ -388 +388 @@
      * Return the search results pagination count
      *
-     * @since bbPress (r4579)
+     * @since 2.3.0 bbPress (r4579)
      *
      * @uses bbp_number_format() To format the number value
@@ -425 +425 @@
  * Output search pagination links
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @uses bbp_get_search_pagination_links() To get the search pagination links
@@ -436 +436 @@
      * Return search pagination links
      *
-     * @since bbPress (r4579)
+     * @since 2.3.0 bbPress (r4579)
      *
      * @uses apply_filters() Calls 'bbp_get_search_pagination_links' with the