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

trunk/src/includes/common/functions.php

@@ -19 +19 @@
  * A bbPress specific method of formatting numeric values
  *
- * @since bbPress (r2486)
+ * @since 2.0.0 bbPress (r2486)
  *
  * @param string $number Number to format
@@ -40 +40 @@
  * A bbPress specific method of formatting numeric values
  *
- * @since bbPress (r3857)
+ * @since 2.1.0 bbPress (r3857)
  *
  * @param string $number Number to format
@@ -61 +61 @@
  * Convert time supplied from database query into specified date format.
  *
- * @since bbPress (r2455)
+ * @since 2.0.0 bbPress (r2544)
  *
  * @param string $time Time to convert
@@ -82 +82 @@
  * Output formatted time to display human readable time difference.
  *
- * @since bbPress (r2544)
+ * @since 2.0.0 bbPress (r2544)
  *
  * @param string $older_date Unix timestamp from which the difference begins.
@@ -96 +96 @@
      * Return formatted time to display human readable time difference.
      *
-     * @since bbPress (r2544)
+     * @since 2.0.0 bbPress (r2544)
      *
      * @param string $older_date Unix timestamp from which the difference begins.
@@ -205 +205 @@
  *  - Trimming again
  *
- * @since bbPress (r2782)
+ * @since 2.0.0 bbPress (r2782)
  *
  * @param string $reason Optional. User submitted reason for editing.
@@ -250 +250 @@
  * Append 'view=all' to query string if it's already there from referer
  *
- * @since bbPress (r3325)
+ * @since 2.0.0 bbPress (r3325)
  *
  * @param string $original_link Original Link to be modified
@@ -274 +274 @@
  * Remove 'view=all' from query string
  *
- * @since bbPress (r3325)
+ * @since 2.0.0 bbPress (r3325)
  *
  * @param string $original_link Original Link to be modified
@@ -289 +289 @@
  * If current user can and is vewing all topics/replies
  *
- * @since bbPress (r3325)
+ * @since 2.0.0 bbPress (r3325)
  *
  * @uses current_user_can() To check if the current user can moderate
@@ -303 +303 @@
  * Assist pagination by returning correct page number
  *
- * @since bbPress (r2628)
+ * @since 2.0.0 bbPress (r2628)
  *
  * @uses get_query_var() To get the 'paged' value
@@ -336 +336 @@
  * function fixes that.
  *
- * @since bbPress (r2734)
+ * @since 2.0.0 bbPress (r2734)
  *
  * @param array $data Post data
@@ -374 +374 @@
  * Check the date against the _bbp_edit_lock setting.
  *
- * @since bbPress (r3133)
+ * @since 2.0.0 bbPress (r3133)
  *
  * @param string $post_date_gmt
@@ -416 +416 @@
  * Get the forum statistics
  *
- * @since bbPress (r2769)
+ * @since 2.0.0 bbPress (r2769)
  *
  * @param array $args Optional. The function supports these arguments (all
@@ -605 +605 @@
  * If there are any errors, those are directly added to {@link bbPress:errors}
  *
- * @since bbPress (r2734)
+ * @since 2.0.0 bbPress (r2734)
  *
  * @param array $args Optional. If no args are there, then $_POST values are
@@ -652 +652 @@
  * Check to make sure that a user is not making a duplicate post
  *
- * @since bbPress (r2763)
+ * @since 2.0.0 bbPress (r2763)
  *
  * @param array $post_data Contains information about the comment
@@ -724 +724 @@
  * of time.
  *
- * @since bbPress (r2734)
+ * @since 2.0.0 bbPress (r2734)
  *
  * @param false|array $anonymous_data Optional - if it's an anonymous post. Do
@@ -774 +774 @@
  * Checks topics and replies against the discussion moderation of blocked keys
  *
- * @since bbPress (r3581)
+ * @since 2.1.0 bbPress (r3581)
  *
  * @param array $anonymous_data Anonymous user data
@@ -898 +898 @@
  * Checks topics and replies against the discussion blacklist of blocked keys
  *
- * @since bbPress (r3446)
+ * @since 2.0.0 bbPress (r3446)
  *
  * @param array $anonymous_data Anonymous user data
@@ -1012 +1012 @@
  * user input, but it was causing issues in some installations.
  *
- * @since bbPress (r5409)
+ * @since 2.6.0 bbPress (r5409)
  *
  * @see  wp_mail
@@ -1040 +1040 @@
  * custom emailer script.
  *
- * @since bbPress (r5413)
+ * @since 2.6.0 bbPress (r5413)
  *
  * @param int $reply_id ID of the newly made reply
@@ -1204 +1204 @@
  * custom emailer script.
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $topic_id ID of the newly made reply
@@ -1354 +1354 @@
  * This function is deprecated. Please use: bbp_notify_topic_subscribers()
  *
- * @since bbPress (r2668)
- * @deprecated bbPress (r5412)
+ * @since 2.0.0 bbPress (r2668)
+ *
+ * @deprecated 2.6.0 bbPress (r5412)
  *
  * @param int $reply_id ID of the newly made reply
@@ -1411 +1412 @@
  * optional $filter_key parameter.
  *
- * @since bbPress (r3839)
+ * @since 2.1.0 bbPress (r3839)
  *
  * @param string|array $args Value to merge with $defaults
@@ -1451 +1452 @@
  * Adds ability to include or exclude specific post_parent ID's
  *
- * @since bbPress (r2996)
- * @deprecated bbPress (r5814)
+ * @since 2.0.0 bbPress (r2996)
+ *
+ * @deprecated 2.5.8 bbPress (r5814)
  *
  * @global WP $wp
@@ -1547 +1549 @@
  * Query the DB and get a count of public children
  *
- * @since bbPress (r2868)
+ * @since 2.0.0 bbPress (r2868)
  *
  * @param int $parent_id Parent id
@@ -1598 +1600 @@
  * Query the DB and get a the child id's of public children
  *
- * @since bbPress (r2868)
+ * @since 2.0.0 bbPress (r2868)
  *
  * @param int $parent_id Parent id
@@ -1651 +1653 @@
  * Query the DB and get a the child id's of all children
  *
- * @since bbPress (r3325)
+ * @since 2.0.0 bbPress (r3325)
  *
  * @param int $  parent_id  Parent id
@@ -1735 +1737 @@
  * Used most frequently when editing a forum/topic/reply
  *
- * @since bbPress (r3694)
+ * @since 2.1.0 bbPress (r3694)
  *
  * @global WP_Query $post
@@ -1758 +1760 @@
  * To avoid security exploits within the theme.
  *
- * @since bbPress (r4022)
+ * @since 2.1.0 bbPress (r4022)
  *
  * @uses do_action() Calls 'bbp_check_referer' on $action.
@@ -1802 +1804 @@
      * Useful for configurations like reverse proxying.
      *
-     * @since bbPress (2.5.0)
+     * @since 2.2.0 bbPress (r4361)
      *
      * @param string $requested_url The requested URL.
@@ -1819 +1821 @@
      * Fires at the end of the nonce verification check.
      *
-     * @since bbPress (2.2.0)
+     * @since 2.1.0 bbPress (r4023)
      *
      * @param string $action Action nonce.
@@ -1836 +1838 @@
  * the stars align and the user has requested a feed of any bbPress type.
  *
- * @since bbPress (r3171)
+ * @since 2.0.0 bbPress (r3171)
  *
  * @param array $query_vars
@@ -2059 +2061 @@
  * Used to guess if page exists at requested path
  *
- * @since bbPress (r3304)
+ * @since 2.0.0 bbPress (r3304)
  *
  * @uses get_option() To see if pretty permalinks are enabled
@@ -2089 +2091 @@
  * Used primarily with topics/replies inside hidden forums.
  *
- * @since bbPress (r3051)
+ * @since 2.0.0 bbPress (r3051)
  *
  * @global WP_Query $wp_query