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

trunk/src/includes/replies/functions.php

@@ -17 +17 @@
  * for the reply to function properly.
  *
- * @since bbPress (r3349)
+ * @since 2.0.0 bbPress (r3349)
  *
  * @uses bbp_parse_args()
@@ -75 +75 @@
  * Handles the front end reply submission
  *
- * @since bbPress (r2574)
+ * @since 2.0.0 bbPress (r2574)
  *
  * @param string $action The requested action to compare this function to
@@ -885 +885 @@
  * Walk up the ancestor tree from the current reply, and update all the counts
  *
- * @since bbPress (r2884)
+ * @since 2.0.0 bbPress (r2884)
  *
  * @param int $reply_id Optional. Reply id
@@ -1015 +1015 @@
  * Update the reply with its forum id it is in
  *
- * @since bbPress (r2855)
+ * @since 2.0.0 bbPress (r2855)
  *
  * @param int $reply_id Optional. Reply id to update
@@ -1064 +1064 @@
  * Update the reply with its topic id it is in
  *
- * @since bbPress (r2855)
+ * @since 2.0.0 bbPress (r2855)
  *
  * @param int $reply_id Optional. Reply id to update
@@ -1113 +1113 @@
  * Update the reply's meta data with its reply to id
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  *
  * @param int $reply_id Reply id to update
@@ -1151 +1151 @@
  * replies are active or to what depth.
  *
- * @since bbPress (r5390)
+ * @since 2.6.0 bbPress (r5390)
  *
  * @param int $reply_id
@@ -1197 +1197 @@
  * Update the revision log of the reply
  *
- * @since bbPress (r2782)
+ * @since 2.0.0 bbPress (r2782)
  *
  * @param array $args Supports these args:
@@ -1241 +1241 @@
  * Handles the front end move reply submission
  *
- * @since bbPress (r4521)
+ * @since 2.3.0 bbPress (r4521)
  *
  * @param string $action The requested action to compare this function to
@@ -1497 +1497 @@
  * and their forums.
  *
- * @since bbPress (r4521)
+ * @since 2.3.0 bbPress (r4521)
  *
  * @param int $move_reply_id Move reply id
@@ -1540 +1540 @@
  * replies
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param string $action The requested action to compare this function to
@@ -1694 +1694 @@
  * Return an associative array of available reply statuses
  *
- * @since bbPress (r5399)
+ * @since 2.6.0 bbPress (r5399)
  *
  * @return array
@@ -1712 +1712 @@
  * Marks a reply as spam
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param int $reply_id Reply id
@@ -1760 +1760 @@
  * Unspams a reply
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param int $reply_id Reply id
@@ -1814 +1814 @@
  * Approves a reply
  *
- * @since bbPress (r5506)
+ * @since 2.6.0 bbPress (r5506)
  *
  * @param int $reply_id Reply id
@@ -1861 +1861 @@
  * Unapproves a reply
  *
- * @since bbPress (r5506)
+ * @since 2.6.0 bbPress (r5506)
  *
  * @param int $reply_id Reply id
@@ -2015 +2015 @@
  * Return the replies per page setting
  *
- * @since bbPress (r3540)
+ * @since 2.0.0 bbPress (r3540)
  *
  * @param int $default Default replies per page (15)
@@ -2039 +2039 @@
  * Return the replies per RSS page setting
  *
- * @since bbPress (r3540)
+ * @since 2.0.0 bbPress (r3540)
  *
  * @param int $default Default replies per page (25)
@@ -2065 +2065 @@
  * Check if autoembeds are enabled and hook them in if so
  *
- * @since bbPress (r3752)
+ * @since 2.1.0 bbPress (r3752)
+ *
  * @global WP_Embed $wp_embed
  */
@@ -2084 +2085 @@
  * to include both the topic AND its children in the same loop.
  *
- * @since bbPress (r4058)
+ * @since 2.1.0 bbPress (r4058)
  *
  * @param string $where
@@ -2149 +2150 @@
  * Output an RSS2 feed of replies, based on the query passed.
  *
- * @since bbPress (r3171)
+ * @since 2.0.0 bbPress (r3171)
  *
  * @uses bbp_version()
@@ -2288 +2289 @@
  * Redirect if unathorized user is attempting to edit a reply
  *
- * @since bbPress (r3605)
+ * @since 2.1.0 bbPress (r3605)
  *
  * @uses bbp_is_reply_edit()
@@ -2319 +2320 @@
  * leverage core WordPress query ordering much more effectively.
  *
- * @since bbPress (r3933)
+ * @since 2.1.0 bbPress (r3933)
  *
  * @param int $reply_id
@@ -2364 +2365 @@
  * of a given topic.
  *
- * @since bbPress (r3933)
+ * @since 2.1.0 bbPress (r3933)
  *
  * @param int $reply_id
@@ -2405 +2406 @@
  * List replies
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  */
 function bbp_list_replies( $args = array() ) {
@@ -2443 +2444 @@
  * @see https://bbpress.trac.wordpress.org/ticket/2586
  *
- * @since bbPress (r5377)
+ * @since 2.5.4 bbPress (r5377)
  *
  * @param int $reply_to